odk/examples/DevelopersGuide/Forms/ComponentTreeTraversal.java

   1 /*************************************************************************
   2  *
   3  *  $RCSfile: ComponentTreeTraversal.java,v $
   4  *
   5  *  $Revision: 1.3 $
   6  *
   7  *  last change: $Author: hr $ $Date: 2003-06-30 15:26:50 $
   8  *
   9  *  The Contents of this file are made available subject to the terms of
  10  *  the BSD license.
  11  *
  12  *  Copyright (c) 2003 by Sun Microsystems, Inc.
  13  *  All rights reserved.
  14  *
  15  *  Redistribution and use in source and binary forms, with or without
  16  *  modification, are permitted provided that the following conditions
  17  *  are met:
  18  *  1. Redistributions of source code must retain the above copyright
  19  *     notice, this list of conditions and the following disclaimer.
  20  *  2. Redistributions in binary form must reproduce the above copyright
  21  *     notice, this list of conditions and the following disclaimer in the
  22  *     documentation and/or other materials provided with the distribution.
  23  *  3. Neither the name of Sun Microsystems, Inc. nor the names of its
  24  *     contributors may be used to endorse or promote products derived
  25  *     from this software without specific prior written permission.
  26  *
  27  *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  28  *  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  29  *  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  30  *  FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
  31  *  COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
  32  *  INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
  33  *  BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
  34  *  OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  35  *  ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
  36  *  TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
  37  *  USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  38  *
  39  *************************************************************************/
  40
  41 import com.sun.star.uno.*;
  42 import com.sun.star.container.*;
  43 import com.sun.star.lang.*;
  44
  45 /**************************************************************************/
  46 /** an abstract interface for components doing an action on a form component
  47 */
  48 interface IFormComponentAction
  49 {
  50     public abstract void handle( Object aFormComponent ) throws java.lang.Exception;
  51 };
  52
  53 /**************************************************************************/
  54 /** a helper class for travelling a form component tree
  55 */
  56 class ComponentTreeTraversal implements IFormComponentAction
  57 {
  58     /* ------------------------------------------------------------------ */
  59     /** Indicator method to decide wether to step down the tree.
  60
  61         <p>The default implementation checks if the container given is a grid
  62         control model or a <service scope="com.sun.star.form">FormComponents</service>
  63         instance.</p>
  64     */
  65     protected boolean shouldStepInto( XIndexContainer xContainer ) throws com.sun.star.uno.Exception
  66     {
  67         // step down the tree, if possible
  68         XServiceInfo xSI = UNO.queryServiceInfo( xContainer );
  69         if      (       null != xSI
  70             &&  (       xSI.supportsService( "com.sun.star.form.FormComponents" )
  71                 ||      xSI.supportsService( "com.sun.star.form.component.GridControl" )
  72                 )
  73             )
  74         {
  75             return true;
  76         }
  77         else
  78         {
  79             return false;
  80         }
  81     }
  82     /* ------------------------------------------------------------------ */
  83     public void handle( Object aFormComponent ) throws com.sun.star.uno.Exception
  84     {
  85         XIndexContainer xCont = UNO.queryIndexContainer( aFormComponent );
  86         if      (       ( null != xCont )
  87             &&  shouldStepInto( xCont )
  88             )
  89         {
  90             for ( int i=0; i<xCont.getCount(); ++i )
  91             {
  92                 handle( xCont.getByIndex( i ) );
  93             }
  94         }
  95     }
  96 }
  97