INTEGRATION: CWS formcelllinkage (1.1.2); FILE ADDED

2003/10/02 13:41:04 fs 1.1.2.1: #18683# helper functionality for the form layer in a document

1 files changed, 289 insertions, 0 deletions

diff --git a/forms/qa/integration/forms/FormLayer.java b/forms/qa/integration/forms/FormLayer.java
new file mode 100644
index 000000000000..73d598be6a6c
--- /dev/null
+++ b/forms/qa/integration/forms/FormLayer.java
@@ -0,0 +1,289 @@
+/*************************************************************************
+ *
+ *  $RCSfile: FormLayer.java,v $
+ *
+ *  $Revision: 1.2 $
+ *
+ *  last change: $Author: obo $ $Date: 2003-10-21 08:53:22 $
+ *
+ *  The Contents of this file are made available subject to the terms of
+ *  either of the following licenses
+ *
+ *         - GNU Lesser General Public License Version 2.1
+ *         - Sun Industry Standards Source License Version 1.1
+ *
+ *  Sun Microsystems Inc., October, 2000
+ *
+ *  GNU Lesser General Public License Version 2.1
+ *  =============================================
+ *  Copyright 2000 by Sun Microsystems, Inc.
+ *  901 San Antonio Road, Palo Alto, CA 94303, USA
+ *
+ *  This library is free software; you can redistribute it and/or
+ *  modify it under the terms of the GNU Lesser General Public
+ *  License version 2.1, as published by the Free Software Foundation.
+ *
+ *  This library is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ *  Lesser General Public License for more details.
+ *
+ *  You should have received a copy of the GNU Lesser General Public
+ *  License along with this library; if not, write to the Free Software
+ *  Foundation, Inc., 59 Temple Place, Suite 330, Boston,
+ *  MA  02111-1307  USA
+ *
+ *
+ *  Sun Industry Standards Source License Version 1.1
+ *  =================================================
+ *  The contents of this file are subject to the Sun Industry Standards
+ *  Source License Version 1.1 (the "License"); You may not use this file
+ *  except in compliance with the License. You may obtain a copy of the
+ *  License at http://www.openoffice.org/license.html.
+ *
+ *  Software provided under this License is provided on an "AS IS" basis,
+ *  WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
+ *  WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
+ *  MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
+ *  See the License for the specific provisions governing your rights and
+ *  obligations concerning the Software.
+ *
+ *  The Initial Developer of the Original Code is: Sun Microsystems, Inc.
+ *
+ *  Copyright: 2000 by Sun Microsystems, Inc.
+ *
+ *  All Rights Reserved.
+ *
+ *  Contributor(s): _______________________________________
+ *
+ *
+ ************************************************************************/
+package integration.forms;
+
+import com.sun.star.uno.UnoRuntime;
+
+import com.sun.star.beans.XPropertySet;
+import com.sun.star.container.XIndexContainer;
+import com.sun.star.container.XIndexAccess;
+import com.sun.star.lang.XMultiServiceFactory;
+import com.sun.star.drawing.XControlShape;
+import com.sun.star.drawing.XShapes;
+import com.sun.star.awt.Size;
+import com.sun.star.awt.Point;
+import com.sun.star.awt.XControlModel;
+import com.sun.star.awt.XControl;
+import com.sun.star.awt.XWindow;
+import com.sun.star.text.TextContentAnchorType;
+import com.sun.star.drawing.XDrawPage;
+
+import integration.forms.DocumentHelper;
+
+/**
+ *
+ * @author  fs@openoffice.org
+ */
+public class FormLayer
+{
+    private DocumentHelper  m_document;
+    private int             m_insertPage;
+
+    /* ------------------------------------------------------------------ */
+    /** Creates a new instance of FormLayer */
+    public FormLayer( DocumentHelper _document )
+    {
+        m_document = _document;
+        m_insertPage = -1;
+    }
+
+    /* ------------------------------------------------------------------ */
+    /** sets the page which is to be used for subsequent insertions of controls/shapes
+     */
+    void setInsertPage( int page )
+    {
+        m_insertPage = page;
+    }
+
+    /* ------------------------------------------------------------------ */
+    /** retrieves the page which is to be used for subsequent insertions of controls/shapes
+     */
+    final int getInsertPage( )
+    {
+        return m_insertPage;
+    }
+
+    /* ------------------------------------------------------------------ */
+    /** creates a control in the document
+
+        <p>Note that <em>control<em> here is an incorrect terminology. What the method really does is
+        it creates a control shape, together with a control model, and inserts them into the document model.
+        This will result in every view to this document creating a control described by the model-shape pair.
+        </p>
+
+        @param sFormComponentService
+            the service name of the form component to create, e.g. "TextField"
+        @param nXPos
+            the abscissa of the position of the newly inserted shape
+        @param nXPos
+            the ordinate of the position of the newly inserted shape
+        @param nWidth
+            the width of the newly inserted shape
+        @param nHeight
+            the height of the newly inserted shape
+        @param xParentForm
+            the form to use as parent for the newly create form component. May be null, in this case
+            a default parent is chosen by the implementation
+        @return
+            the property access to the control's model
+    */
+    protected XPropertySet createControlAndShape( String sFormComponentService, int nXPos,
+        int nYPos, int nWidth, int nHeight, XIndexContainer xParentForm ) throws java.lang.Exception
+    {
+        // let the document create a shape
+        XMultiServiceFactory xDocAsFactory = (XMultiServiceFactory)UnoRuntime.queryInterface(
+            XMultiServiceFactory.class, m_document.getDocument() );
+        XControlShape xShape = (XControlShape)UnoRuntime.queryInterface( XControlShape.class,
+            xDocAsFactory.createInstance( "com.sun.star.drawing.ControlShape" ) );
+
+        // position and size of the shape
+        xShape.setSize( new Size( nWidth * 100, nHeight * 100 ) );
+        xShape.setPosition( new Point( nXPos * 100, nYPos * 100 ) );
+
+        // adjust the anchor so that the control is tied to the page
+        XPropertySet xShapeProps = dbfTools.queryXPropertySet( xShape );
+        TextContentAnchorType eAnchorType = TextContentAnchorType.AT_PARAGRAPH;
+        xShapeProps.setPropertyValue( "AnchorType", eAnchorType );
+
+        // create the form component (the model of a form control)
+        String sQualifiedComponentName = "com.sun.star.form.component." + sFormComponentService;
+        XControlModel xModel = (XControlModel)UnoRuntime.queryInterface( XControlModel.class,
+            m_document.getOrb().createInstance( sQualifiedComponentName ) );
+
+        // insert the model into the form component hierarchy, if the caller gave us a location
+        if ( null != xParentForm )
+        {
+            xParentForm.insertByIndex( xParentForm.getCount(), xModel );
+        }
+
+        // knitt them
+        xShape.setControl( xModel );
+
+        // add the shape to the shapes collection of the document
+        XDrawPage pageWhereToInsert = ( m_insertPage != -1 ) ? m_document.getDrawPage( m_insertPage ) : m_document.getMainDrawPage();
+
+        XShapes xDocShapes = (XShapes)UnoRuntime.queryInterface( XShapes.class, pageWhereToInsert );
+        xDocShapes.add( xShape );
+
+        // and outta here with the XPropertySet interface of the model
+        XPropertySet xModelProps = dbfTools.queryXPropertySet( xModel );
+        return xModelProps;
+    }
+
+    /* ------------------------------------------------------------------ */
+    /** creates a control in the document
+
+        <p>Note that <em>control<em> here is an incorrect terminology. What the method really does is
+        it creates a control shape, together with a control model, and inserts them into the document model.
+        This will result in every view to this document creating a control described by the model-shape pair.
+        </p>
+
+        @param sFormComponentService
+            the service name of the form component to create, e.g. "TextField"
+        @param nXPos
+            the abscissa of the position of the newly inserted shape
+        @param nXPos
+            the ordinate of the position of the newly inserted shape
+        @param nWidth
+            the width of the newly inserted shape
+        @param nHeight
+            the height of the newly inserted shape
+        @return
+            the property access to the control's model
+    */
+    protected XPropertySet createControlAndShape( String sFormComponentService, int nXPos,
+        int nYPos, int nWidth, int nHeight ) throws java.lang.Exception
+    {
+        return createControlAndShape( sFormComponentService, nXPos, nYPos, nWidth, nHeight, null );
+    }
+
+    /* ------------------------------------------------------------------ */
+    /** creates a line of controls, consisting of a label and a field for data input.
+
+        <p>In opposite to the second form of this method, here the height of the field,
+        as well as the abscissa of the label, are under the control of the caller.</p>
+
+        @param sControlType
+            specifies the type of the data input control
+        @param sFieldName
+            specifies the field name the text field should be bound to
+        @param sControlNamePostfix
+            specifies a postfix to append to the logical control names
+        @param nYPos
+            specifies the Y position of the line to start at
+        @param nHeight
+            the height of the field
+        @return
+            the control model of the created data input field
+    */
+    protected XPropertySet insertControlLine( String sControlType, String sFieldName, String sControlNamePostfix, int nXPos, int nYPos, int nHeight )
+        throws java.lang.Exception
+    {
+        // insert the label control
+        XPropertySet xLabelModel = createControlAndShape( "FixedText", nXPos, nYPos, 25, 6 );
+        xLabelModel.setPropertyValue( "Label", sFieldName );
+
+        // insert the text field control
+        XPropertySet xFieldModel = createControlAndShape( sControlType, nXPos + 26, nYPos, 40, nHeight );
+        xFieldModel.setPropertyValue( "DataField", sFieldName );
+        // knit it to it's label component
+        xFieldModel.setPropertyValue( "LabelControl", xLabelModel );
+
+        // some names, so later on we can find them
+        xLabelModel.setPropertyValue( "Name", sFieldName + sControlNamePostfix + "_Label" );
+        xFieldModel.setPropertyValue( "Name", sFieldName + sControlNamePostfix );
+
+        return xFieldModel;
+    }
+
+    /* ------------------------------------------------------------------ */
+    /** creates a line of controls, consisting of a label and a field for data input.
+
+        @param sControlType
+            specifies the type of the data input control
+        @param sFieldName
+            specifies the field name the text field should be bound to
+        @param nYPos
+            specifies the Y position of the line to start at
+        @return
+            the control model of the created data input field
+    */
+    protected XPropertySet insertControlLine( String sControlType, String sFieldName, String sControlNamePostfix, int nYPos )
+        throws java.lang.Exception
+    {
+        return insertControlLine( sControlType, sFieldName, sControlNamePostfix, 2, nYPos, 6 );
+    }
+
+    /* ------------------------------------------------------------------ */
+    /** retrieves the radio button model with the given name and the given ref value
+     *  @param form
+     *      the parent form of the radio button model to find
+     *  @param name
+     *      the name of the radio button
+     *  @param refValue
+     *      the reference value of the radio button
+    */
+    public XPropertySet getRadioModel( XPropertySet form, String name, String refValue ) throws com.sun.star.uno.Exception, java.lang.Exception
+    {
+        XIndexAccess indexAccess = (XIndexAccess)UnoRuntime.queryInterface( XIndexAccess.class,
+            form );
+
+        for ( int i=0; i<indexAccess.getCount(); ++i )
+        {
+            XPropertySet control = dbfTools.queryXPropertySet( indexAccess.getByIndex( i ) );
+
+            if ( ((String)control.getPropertyValue( "Name" )).equals( name ) )
+                if ( ((String)control.getPropertyValue( "RefValue" )).equals( refValue ) )
+                    return control;
+        }
+        return null;
+    }
+}