odk/examples/DevelopersGuide/Forms/ComponentTreeTraversal.java

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