odk/examples/DevelopersGuide/Forms/FormLayer.java

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: FormLayer.java,v $
  10  * $Revision: 1.7 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 import com.sun.star.uno.UnoRuntime;
  31
  32 import com.sun.star.beans.XPropertySet;
  33 import com.sun.star.beans.XPropertySetInfo;
  34 import com.sun.star.container.XIndexContainer;
  35 import com.sun.star.container.XIndexAccess;
  36 import com.sun.star.lang.XMultiServiceFactory;
  37 import com.sun.star.drawing.XControlShape;
  38 import com.sun.star.drawing.XShapes;
  39 import com.sun.star.awt.Size;
  40 import com.sun.star.awt.Point;
  41 import com.sun.star.awt.XControlModel;
  42 import com.sun.star.text.TextContentAnchorType;
  43 import com.sun.star.drawing.XDrawPage;
  44
  45 /**
  46  *
  47  * @author  fs@openoffice.org
  48  */
  49 public class FormLayer
  50 {
  51     private DocumentHelper  m_document;
  52     private int             m_insertPage;
  53
  54     /* ------------------------------------------------------------------ */
  55     /** Creates a new instance of FormLayer */
  56     public FormLayer( DocumentHelper _document )
  57     {
  58         m_document = _document;
  59         m_insertPage = -1;
  60     }
  61
  62     /* ------------------------------------------------------------------ */
  63     /** sets the page which is to be used for subsequent insertions of controls/shapes
  64      */
  65     void setInsertPage( int page )
  66     {
  67         m_insertPage = page;
  68     }
  69
  70     /* ------------------------------------------------------------------ */
  71     /** retrieves the page which is to be used for subsequent insertions of controls/shapes
  72      */
  73     final int getInsertPage( )
  74     {
  75         return m_insertPage;
  76     }
  77
  78     /* ------------------------------------------------------------------ */
  79     /** creates a control in the document
  80
  81         <p>Note that <em>control<em> here is an incorrect terminology. What the method really does is
  82         it creates a control shape, together with a control model, and inserts them into the document model.
  83         This will result in every view to this document creating a control described by the model-shape pair.
  84         </p>
  85
  86         @param sFormComponentService
  87             the service name of the form component to create, e.g. "TextField"
  88         @param nXPos
  89             the abscissa of the position of the newly inserted shape
  90         @param nXPos
  91             the ordinate of the position of the newly inserted shape
  92         @param nWidth
  93             the width of the newly inserted shape
  94         @param nHeight
  95             the height of the newly inserted shape
  96         @param xParentForm
  97             the form to use as parent for the newly create form component. May be null, in this case
  98             a default parent is chosen by the implementation
  99         @return
 100             the property access to the control's model
 101     */
 102     protected XPropertySet createControlAndShape( String sFormComponentService, int nXPos,
 103         int nYPos, int nWidth, int nHeight, XIndexContainer xParentForm ) throws java.lang.Exception
 104     {
 105         // let the document create a shape
 106         XMultiServiceFactory xDocAsFactory = (XMultiServiceFactory)UnoRuntime.queryInterface(
 107             XMultiServiceFactory.class, m_document.getDocument() );
 108         XControlShape xShape = (XControlShape)UnoRuntime.queryInterface( XControlShape.class,
 109             xDocAsFactory.createInstance( "com.sun.star.drawing.ControlShape" ) );
 110
 111         // position and size of the shape
 112         xShape.setSize( new Size( nWidth * 100, nHeight * 100 ) );
 113         xShape.setPosition( new Point( nXPos * 100, nYPos * 100 ) );
 114
 115         // adjust the anchor so that the control is tied to the page
 116         XPropertySet xShapeProps = UNO.queryPropertySet( xShape );
 117         TextContentAnchorType eAnchorType = TextContentAnchorType.AT_PARAGRAPH;
 118         xShapeProps.setPropertyValue( "AnchorType", eAnchorType );
 119
 120         // create the form component (the model of a form control)
 121         String sQualifiedComponentName = "com.sun.star.form.component." + sFormComponentService;
 122         XControlModel xModel = (XControlModel)UnoRuntime.queryInterface( XControlModel.class,
 123             m_document.getOrb().createInstance( sQualifiedComponentName ) );
 124
 125         // insert the model into the form component hierarchy, if the caller gave us a location
 126         if ( null != xParentForm )
 127         {
 128             xParentForm.insertByIndex( xParentForm.getCount(), xModel );
 129         }
 130
 131         // knitt them
 132         xShape.setControl( xModel );
 133
 134         // add the shape to the shapes collection of the document
 135         XDrawPage pageWhereToInsert = ( m_insertPage != -1 ) ? m_document.getDrawPage( m_insertPage ) : m_document.getMainDrawPage();
 136
 137         XShapes xDocShapes = (XShapes)UnoRuntime.queryInterface( XShapes.class, pageWhereToInsert );
 138         xDocShapes.add( xShape );
 139
 140         // some initializations which are the same for all controls
 141         XPropertySet xModelProps = UNO.queryPropertySet( xModel );
 142         try
 143         {
 144             XPropertySetInfo xPSI = xModelProps.getPropertySetInfo();
 145             if ( xPSI.hasPropertyByName( "Border" ) )
 146             {
 147                 if ( ((Short)xModelProps.getPropertyValue( "Border" )).shortValue() == com.sun.star.awt.VisualEffect.LOOK3D )
 148                     xModelProps.setPropertyValue( "Border", new Short( com.sun.star.awt.VisualEffect.FLAT ) );
 149             }
 150             if ( xPSI.hasPropertyByName( "VisualEffect" ) )
 151                 xModelProps.setPropertyValue( "VisualEffect", new Short( com.sun.star.awt.VisualEffect.FLAT ) );
 152             if ( m_document.classify() != DocumentType.CALC )
 153                 if ( xPSI.hasPropertyByName( "BorderColor" ) )
 154                     xModelProps.setPropertyValue( "BorderColor", new Integer( 0x00C0C0C0 ) );
 155         }
 156         catch( com.sun.star.uno.Exception e )
 157         {
 158             System.err.println(e);
 159             e.printStackTrace( System.err );
 160         }
 161         return xModelProps;
 162     }
 163
 164     /* ------------------------------------------------------------------ */
 165     /** creates a control in the document
 166
 167         <p>Note that <em>control<em> here is an incorrect terminology. What the method really does is
 168         it creates a control shape, together with a control model, and inserts them into the document model.
 169         This will result in every view to this document creating a control described by the model-shape pair.
 170         </p>
 171
 172         @param sFormComponentService
 173             the service name of the form component to create, e.g. "TextField"
 174         @param nXPos
 175             the abscissa of the position of the newly inserted shape
 176         @param nXPos
 177             the ordinate of the position of the newly inserted shape
 178         @param nWidth
 179             the width of the newly inserted shape
 180         @param nHeight
 181             the height of the newly inserted shape
 182         @return
 183             the property access to the control's model
 184     */
 185     protected XPropertySet createControlAndShape( String sFormComponentService, int nXPos,
 186         int nYPos, int nWidth, int nHeight ) throws java.lang.Exception
 187     {
 188         return createControlAndShape( sFormComponentService, nXPos, nYPos, nWidth, nHeight, null );
 189     }
 190
 191     /* ------------------------------------------------------------------ */
 192     /** creates a line of controls, consisting of a label and a field for data input.
 193
 194         <p>In opposite to the second form of this method, here the height of the field,
 195         as well as the abscissa of the label, are under the control of the caller.</p>
 196
 197         @param sControlType
 198             specifies the type of the data input control
 199         @param sFieldName
 200             specifies the field name the text field should be bound to
 201         @param sControlNamePostfix
 202             specifies a postfix to append to the logical control names
 203         @param nYPos
 204             specifies the Y position of the line to start at
 205         @param nHeight
 206             the height of the field
 207         @return
 208             the control model of the created data input field
 209     */
 210     protected XPropertySet insertControlLine( String sControlType, String sFieldName, String sControlNamePostfix, int nXPos, int nYPos, int nHeight )
 211         throws java.lang.Exception
 212     {
 213         // insert the label control
 214         XPropertySet xLabelModel = createControlAndShape( "FixedText", nXPos, nYPos, 25, 6 );
 215         xLabelModel.setPropertyValue( "Label", sFieldName );
 216
 217         // insert the text field control
 218         XPropertySet xFieldModel = createControlAndShape( sControlType, nXPos + 26, nYPos, 40, nHeight );
 219         xFieldModel.setPropertyValue( "DataField", sFieldName );
 220         // knit it to it's label component
 221         xFieldModel.setPropertyValue( "LabelControl", xLabelModel );
 222
 223         // some names, so later on we can find them
 224         xLabelModel.setPropertyValue( "Name", sFieldName + sControlNamePostfix + "_Label" );
 225         xFieldModel.setPropertyValue( "Name", sFieldName + sControlNamePostfix );
 226
 227         return xFieldModel;
 228     }
 229
 230     /* ------------------------------------------------------------------ */
 231     /** creates a line of controls, consisting of a label and a field for data input.
 232
 233         @param sControlType
 234             specifies the type of the data input control
 235         @param sFieldName
 236             specifies the field name the text field should be bound to
 237         @param nYPos
 238             specifies the Y position of the line to start at
 239         @return
 240             the control model of the created data input field
 241     */
 242     protected XPropertySet insertControlLine( String sControlType, String sFieldName, String sControlNamePostfix, int nYPos )
 243         throws java.lang.Exception
 244     {
 245         return insertControlLine( sControlType, sFieldName, sControlNamePostfix, 2, nYPos, 6 );
 246     }
 247
 248     /* ------------------------------------------------------------------ */
 249     /** retrieves the radio button model with the given name and the given ref value
 250      *  @param form
 251      *      the parent form of the radio button model to find
 252      *  @param name
 253      *      the name of the radio button
 254      *  @param refValue
 255      *      the reference value of the radio button
 256     */
 257     public XPropertySet getRadioModelByRefValue( XPropertySet form, String name, String refValue ) throws com.sun.star.uno.Exception, java.lang.Exception
 258     {
 259         XIndexAccess indexAccess = (XIndexAccess)UnoRuntime.queryInterface( XIndexAccess.class,
 260             form );
 261
 262         for ( int i=0; i<indexAccess.getCount(); ++i )
 263         {
 264             XPropertySet control = UNO.queryPropertySet( indexAccess.getByIndex( i ) );
 265
 266             if ( ((String)control.getPropertyValue( "Name" )).equals( name ) )
 267                 if ( ((String)control.getPropertyValue( "RefValue" )).equals( refValue ) )
 268                     return control;
 269         }
 270         return null;
 271     }
 272
 273     /* ------------------------------------------------------------------ */
 274     /** retrieves the radio button model with the given name and the given tag
 275      *  @param form
 276      *      the parent form of the radio button model to find
 277      *  @param name
 278      *      the name of the radio button
 279      *  @param refValue
 280      *      the tag of the radio button
 281     */
 282     public XPropertySet getRadioModelByTag( XPropertySet form, String name, String tag ) throws com.sun.star.uno.Exception, java.lang.Exception
 283     {
 284         XIndexAccess indexAccess = (XIndexAccess)UnoRuntime.queryInterface( XIndexAccess.class,
 285             form );
 286
 287         for ( int i=0; i<indexAccess.getCount(); ++i )
 288         {
 289             XPropertySet control = UNO.queryPropertySet( indexAccess.getByIndex( i ) );
 290
 291             if ( ((String)control.getPropertyValue( "Name" )).equals( name ) )
 292                 if ( ((String)control.getPropertyValue( "Tag" )).equals( tag ) )
 293                     return control;
 294         }
 295         return null;
 296     }
 297 }