1 /**************************************************************
2  *
3  * Licensed to the Apache Software Foundation (ASF) under one
4  * or more contributor license agreements.  See the NOTICE file
5  * distributed with this work for additional information
6  * regarding copyright ownership.  The ASF licenses this file
7  * to you under the Apache License, Version 2.0 (the
8  * "License"); you may not use this file except in compliance
9  * with the License.  You may obtain a copy of the License at
10  *
11  *   http://www.apache.org/licenses/LICENSE-2.0
12  *
13  * Unless required by applicable law or agreed to in writing,
14  * software distributed under the License is distributed on an
15  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16  * KIND, either express or implied.  See the License for the
17  * specific language governing permissions and limitations
18  * under the License.
19  *
20  *************************************************************/
21 
22 
23 package mod._forms;
24 
25 import java.io.PrintWriter;
26 
27 import lib.StatusException;
28 import lib.TestCase;
29 import lib.TestEnvironment;
30 import lib.TestParameters;
31 import util.FormTools;
32 import util.SOfficeFactory;
33 import util.WriterTools;
34 
35 import com.sun.star.awt.XControlModel;
36 import com.sun.star.awt.XDevice;
37 import com.sun.star.awt.XGraphics;
38 import com.sun.star.awt.XTextComponent;
39 import com.sun.star.awt.XToolkit;
40 import com.sun.star.awt.XWindow;
41 import com.sun.star.awt.XWindowPeer;
42 import com.sun.star.drawing.XControlShape;
43 import com.sun.star.drawing.XShape;
44 import com.sun.star.lang.XMultiServiceFactory;
45 import com.sun.star.text.XTextDocument;
46 import com.sun.star.uno.UnoRuntime;
47 import com.sun.star.uno.XInterface;
48 import com.sun.star.util.XCloseable;
49 import com.sun.star.view.XControlAccess;
50 
51 
52 /**
53  * Test for object which is represented by default controller
54  * of the <code>com.sun.star.form.component.FormattedField</code>
55  * component. <p>
56  *
57  * Object implements the following interfaces :
58  * <ul>
59  *  <li> <code>com::sun::star::awt::XView</code></li>
60  *  <li> <code>com::sun::star::form::XBoundControl</code></li>
61  *  <li> <code>com::sun::star::awt::XControl</code></li>
62  *  <li> <code>com::sun::star::awt::XTextComponent</code></li>
63  *  <li> <code>com::sun::star::awt::XLayoutConstrains</code></li>
64  *  <li> <code>com::sun::star::awt::XTextListener</code></li>
65  *  <li> <code>com::sun::star::awt::XWindow</code></li>
66  *  <li> <code>com::sun::star::lang::XComponent</code></li>
67  *  <li> <code>com::sun::star::awt::XTextLayoutConstrains</code></li>
68  *  <li> <code>com::sun::star::lang::XEventListener</code></li>
69  * </ul> <p>
70  * This object test <b> is NOT </b> designed to be run in several
71  * threads concurently.
72  *
73  * @see com.sun.star.awt.XView
74  * @see com.sun.star.form.XBoundControl
75  * @see com.sun.star.awt.XControl
76  * @see com.sun.star.awt.XTextComponent
77  * @see com.sun.star.awt.XLayoutConstrains
78  * @see com.sun.star.awt.XTextListener
79  * @see com.sun.star.awt.XWindow
80  * @see com.sun.star.lang.XComponent
81  * @see com.sun.star.awt.XTextLayoutConstrains
82  * @see com.sun.star.lang.XEventListener
83  * @see ifc.awt._XView
84  * @see ifc.form._XBoundControl
85  * @see ifc.awt._XControl
86  * @see ifc.awt._XTextComponent
87  * @see ifc.awt._XLayoutConstrains
88  * @see ifc.awt._XTextListener
89  * @see ifc.awt._XWindow
90  * @see ifc.lang._XComponent
91  * @see ifc.awt._XTextLayoutConstrains
92  * @see ifc.lang._XEventListener
93  */
94 public class OFormattedControl extends TestCase {
95     XTextDocument xTextDoc;
96 
97     /**
98      * Creates a new text document.
99      */
initialize(TestParameters Param, PrintWriter log)100     protected void initialize(TestParameters Param, PrintWriter log) {
101         SOfficeFactory SOF = SOfficeFactory.getFactory(((XMultiServiceFactory) Param.getMSF()));
102 
103         try {
104             log.println("creating a textdocument");
105             xTextDoc = SOF.createTextDoc(null);
106         } catch (com.sun.star.uno.Exception e) {
107             // Some exception occures.FAILED
108             e.printStackTrace(log);
109             throw new StatusException("Couldn't create document", e);
110         }
111     }
112 
113     /**
114      * Disposes the text document created before
115      */
cleanup(TestParameters tParam, PrintWriter log)116     protected void cleanup(TestParameters tParam, PrintWriter log) {
117         log.println("    disposing xTextDoc ");
118 
119         try {
120             XCloseable closer = (XCloseable) UnoRuntime.queryInterface(
121                                         XCloseable.class, xTextDoc);
122             closer.close(true);
123         } catch (com.sun.star.util.CloseVetoException e) {
124             log.println("couldn't close document");
125         } catch (com.sun.star.lang.DisposedException e) {
126             log.println("couldn't close document");
127         }
128     }
129 
130     /**
131      * Creates two components and inserts them to the form of
132      * text document. One component
133      * (<code>com.sun.star.form.component.FormattedField</code>) is created
134      * for testing, another to be passed as relation. Using a controller
135      * of the text document the controller of the first component is
136      * obtained and returned in environment as a test object. <p>
137      *
138      *     Object relations created :
139      * <ul>
140      *  <li> <code>'GRAPHICS'</code> for
141      *      {@link ifc.awt._XView} : a graphics component
142      *      created using screen device of the window peer of
143      *      the controller tested. </li>
144      *  <li> <code>'CONTEXT'</code> for
145      *      {@link ifc.awt._XControl} : the text document
146      *      where the component is inserted. </li>
147      *  <li> <code>'WINPEER'</code> for
148      *      {@link ifc.awt._XControl} : Window peer of the
149      *      controller tested. </li>
150      *  <li> <code>'TOOLKIT'</code> for
151      *      {@link ifc.awt._XControl} : toolkit of the component.</li>
152      *  <li> <code>'MODEL'</code> for
153      *      {@link ifc.awt._XControl} : the model of the controller.</li>
154      *  <li> <code>'XWindow.AnotherWindow'</code> for
155      *      {@link ifc.awt._XWindow} : the controller of another
156      *      component. </li>
157      * </ul>
158      */
createTestEnvironment(TestParameters Param, PrintWriter log)159     protected TestEnvironment createTestEnvironment(TestParameters Param,
160                                                     PrintWriter log) {
161         XInterface oObj = null;
162         Object anotherCtrl = null;
163         XWindowPeer the_win = null;
164         XToolkit the_kit = null;
165         XDevice aDevice = null;
166         XGraphics aGraphic = null;
167 
168         //Insert a ControlShape and get the ControlModel
169         XControlShape aShape = FormTools.createControlShape(xTextDoc, 3000,
170                                                             4500, 15000, 10000,
171                                                             "FormattedField");
172 
173         WriterTools.getDrawPage(xTextDoc).add((XShape) aShape);
174 
175         XControlModel the_Model = aShape.getControl();
176 
177         XControlShape aShape2 = FormTools.createControlShape(xTextDoc, 3000,
178                                                              4500, 5000, 10000,
179                                                              "TextField");
180 
181         WriterTools.getDrawPage(xTextDoc).add((XShape) aShape2);
182 
183         XControlModel the_Model2 = aShape2.getControl();
184 
185         //Try to query XControlAccess
186         XControlAccess the_access = (XControlAccess) UnoRuntime.queryInterface(
187                                             XControlAccess.class,
188                                             xTextDoc.getCurrentController());
189 
190         //now get the OFormattedControl
191         try {
192             oObj = the_access.getControl(the_Model);
193             anotherCtrl = the_access.getControl(the_Model2);
194             the_win = the_access.getControl(the_Model).getPeer();
195             the_kit = the_win.getToolkit();
196             aDevice = the_kit.createScreenCompatibleDevice(200, 200);
197             aGraphic = aDevice.createGraphics();
198         } catch (com.sun.star.container.NoSuchElementException e) {
199             log.println("Couldn't get OFormattedControl");
200             e.printStackTrace(log);
201             throw new StatusException("Couldn't get OFormattedControl", e);
202         }
203 
204         log.println("creating a new environment for OFormattedControl object");
205 
206         TestEnvironment tEnv = new TestEnvironment(oObj);
207 
208 
209         //Adding ObjRelation for XView
210         tEnv.addObjRelation("GRAPHICS", aGraphic);
211 
212 
213         //Adding ObjRelation for XControl
214         tEnv.addObjRelation("CONTEXT", xTextDoc);
215         tEnv.addObjRelation("WINPEER", the_win);
216         tEnv.addObjRelation("TOOLKIT", the_kit);
217         tEnv.addObjRelation("MODEL", the_Model);
218 
219         // Adding relation for XWindow
220         XWindow forObjRel = (XWindow) UnoRuntime.queryInterface(XWindow.class,
221                                                                 anotherCtrl);
222 
223         tEnv.addObjRelation("XWindow.AnotherWindow", forObjRel);
224         tEnv.addObjRelation("XWindow.ControlShape", aShape);
225 
226         // Adding relation for XTextListener
227         ifc.awt._XTextListener.TestTextListener listener =
228                 new ifc.awt._XTextListener.TestTextListener();
229         XTextComponent textComp = (XTextComponent) UnoRuntime.queryInterface(
230                                           XTextComponent.class, oObj);
231         textComp.addTextListener(listener);
232         tEnv.addObjRelation("TestTextListener", listener);
233 
234         return tEnv;
235     } // finish method getTestEnvironment
236 } // finish class OFormattedControl
237