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.XControl;
36 import com.sun.star.awt.XControlModel;
37 import com.sun.star.awt.XDevice;
38 import com.sun.star.awt.XGraphics;
39 import com.sun.star.awt.XTextComponent;
40 import com.sun.star.awt.XToolkit;
41 import com.sun.star.awt.XWindow;
42 import com.sun.star.awt.XWindowPeer;
43 import com.sun.star.drawing.XControlShape;
44 import com.sun.star.drawing.XShape;
45 import com.sun.star.lang.XMultiServiceFactory;
46 import com.sun.star.text.XTextDocument;
47 import com.sun.star.uno.UnoRuntime;
48 import com.sun.star.uno.XInterface;
49 import com.sun.star.util.XCloseable;
50 import com.sun.star.view.XControlAccess;
51 
52 
53 /**
54  * Test for object which is represented by default controller
55  * of the <code>com.sun.star.form.component.ComboBox</code>
56  * component. <p>
57  *
58  * Object implements the following interfaces :
59  * <ul>
60  *  <li> <code>com::sun::star::awt::XView</code></li>
61  *  <li> <code>com::sun::star::form::XBoundControl</code></li>
62  *  <li> <code>com::sun::star::awt::XControl</code></li>
63  *  <li> <code>com::sun::star::awt::XTextComponent</code></li>
64  *  <li> <code>com::sun::star::awt::XComboBox</code></li>
65  *  <li> <code>com::sun::star::awt::XLayoutConstrains</code></li>
66  *  <li> <code>com::sun::star::awt::XTextListener</code></li>
67  *  <li> <code>com::sun::star::awt::XWindow</code></li>
68  *  <li> <code>com::sun::star::lang::XComponent</code></li>
69  *  <li> <code>com::sun::star::awt::XTextLayoutConstrains</code></li>
70  *  <li> <code>com::sun::star::lang::XEventListener</code></li>
71  * </ul> <p>
72  * This object test <b> is NOT </b> designed to be run in several
73  * threads concurently.
74  *
75  * @see com.sun.star.awt.XView
76  * @see com.sun.star.form.XBoundControl
77  * @see com.sun.star.awt.XControl
78  * @see com.sun.star.awt.XTextComponent
79  * @see com.sun.star.awt.XComboBox
80  * @see com.sun.star.awt.XLayoutConstrains
81  * @see com.sun.star.awt.XTextListener
82  * @see com.sun.star.awt.XWindow
83  * @see com.sun.star.lang.XComponent
84  * @see com.sun.star.awt.XTextLayoutConstrains
85  * @see com.sun.star.lang.XEventListener
86  * @see ifc.awt._XView
87  * @see ifc.form._XBoundControl
88  * @see ifc.awt._XControl
89  * @see ifc.awt._XTextComponent
90  * @see ifc.awt._XComboBox
91  * @see ifc.awt._XLayoutConstrains
92  * @see ifc.awt._XTextListener
93  * @see ifc.awt._XWindow
94  * @see ifc.lang._XComponent
95  * @see ifc.awt._XTextLayoutConstrains
96  * @see ifc.lang._XEventListener
97  */
98 public class OComboBoxControl extends TestCase {
99     XTextDocument xTextDoc;
100 
101     /**
102      * Creates a new text document.
103      */
initialize(TestParameters Param, PrintWriter log)104     protected void initialize(TestParameters Param, PrintWriter log) {
105         SOfficeFactory SOF = SOfficeFactory.getFactory(((XMultiServiceFactory) Param.getMSF()));
106 
107         try {
108             log.println("creating a textdocument");
109             xTextDoc = SOF.createTextDoc(null);
110         } catch (com.sun.star.uno.Exception e) {
111             // Some exception occured.FAILED
112             e.printStackTrace(log);
113             throw new StatusException("Couldn't create document", e);
114         }
115     }
116 
117     /**
118      * Disposes the text document created before
119      */
cleanup(TestParameters tParam, PrintWriter log)120     protected void cleanup(TestParameters tParam, PrintWriter log) {
121         log.println("    disposing xTextDoc ");
122 
123         try {
124             XCloseable closer = (XCloseable) UnoRuntime.queryInterface(
125                                         XCloseable.class, xTextDoc);
126             closer.close(true);
127         } catch (com.sun.star.util.CloseVetoException e) {
128             log.println("couldn't close document");
129         } catch (com.sun.star.lang.DisposedException e) {
130             log.println("couldn't close document");
131         }
132     }
133 
134     /**
135      * Creates two components and inserts them to the form of
136      * text document. One component
137      * (<code>com.sun.star.form.component.ComboBox</code>) is created
138      * for testing, another to be passed as relation. Using a controller
139      * of the text document the controller of the first component is
140      * obtained and returned in environment as a test object. <p>
141      *
142      *     Object relations created :
143      * <ul>
144      *  <li> <code>'GRAPHICS'</code> for
145      *      {@link ifc.awt._XView} : a graphics component
146      *      created using screen device of the window peer of
147      *      the controller tested. </li>
148      *  <li> <code>'CONTEXT'</code> for
149      *      {@link ifc.awt._XControl} : the text document
150      *      where the component is inserted. </li>
151      *  <li> <code>'WINPEER'</code> for
152      *      {@link ifc.awt._XControl} : Window peer of the
153      *      controller tested. </li>
154      *  <li> <code>'TOOLKIT'</code> for
155      *      {@link ifc.awt._XControl} : toolkit of the component.</li>
156      *  <li> <code>'MODEL'</code> for
157      *      {@link ifc.awt._XControl} : the model of the controller.</li>
158      *  <li> <code>'XWindow.AnotherWindow'</code> for
159      *      {@link ifc.awt._XWindow} : the controller of another
160      *      component. </li>
161      * </ul>
162      */
createTestEnvironment(TestParameters Param, PrintWriter log)163     protected TestEnvironment createTestEnvironment(TestParameters Param,
164                                                     PrintWriter log) {
165         XInterface oObj = null;
166         XWindowPeer the_win = null;
167         XToolkit the_kit = null;
168         XDevice aDevice = null;
169         XGraphics aGraphic = null;
170         XControl aControl = null;
171 
172         //Insert a ControlShape and get the ControlModel
173         XControlShape aShape = FormTools.createControlShape(xTextDoc, 3000,
174                                                             4500, 15000, 10000,
175                                                             "ComboBox");
176 
177         WriterTools.getDrawPage(xTextDoc).add((XShape) aShape);
178 
179         XControlModel the_Model = aShape.getControl();
180 
181         XControlShape aShape2 = FormTools.createControlShape(xTextDoc, 3000,
182                                                              4500, 5000, 10000,
183                                                              "TextField");
184 
185         WriterTools.getDrawPage(xTextDoc).add((XShape) aShape2);
186 
187         XControlModel the_Model2 = aShape2.getControl();
188 
189         //Try to query XControlAccess
190         XControlAccess the_access = (XControlAccess) UnoRuntime.queryInterface(
191                                             XControlAccess.class,
192                                             xTextDoc.getCurrentController());
193 
194         //now get the OButtonControl
195         try {
196             oObj = the_access.getControl(the_Model);
197             aControl = the_access.getControl(the_Model2);
198             the_win = the_access.getControl(the_Model).getPeer();
199             the_kit = the_win.getToolkit();
200             aDevice = the_kit.createScreenCompatibleDevice(200, 200);
201             aGraphic = aDevice.createGraphics();
202         } catch (com.sun.star.container.NoSuchElementException e) {
203             log.println("Couldn't get OCheckBoxControl");
204             e.printStackTrace(log);
205             throw new StatusException("Couldn't get OComboBoxControl", e);
206         }
207 
208         log.println("creating a new environment for OComboBoxControl object");
209 
210         TestEnvironment tEnv = new TestEnvironment(oObj);
211 
212 
213         //Adding ObjRelation for XView
214         tEnv.addObjRelation("GRAPHICS", aGraphic);
215 
216 
217         //Adding ObjRelation for XControl
218         tEnv.addObjRelation("CONTEXT", xTextDoc);
219         tEnv.addObjRelation("WINPEER", the_win);
220         tEnv.addObjRelation("TOOLKIT", the_kit);
221         tEnv.addObjRelation("MODEL", the_Model);
222 
223         // Adding relation for XWindow
224         XWindow forObjRel = (XWindow) UnoRuntime.queryInterface(XWindow.class,
225                                                                 aControl);
226 
227         tEnv.addObjRelation("XWindow.AnotherWindow", forObjRel);
228         tEnv.addObjRelation("XWindow.ControlShape", aShape);
229 
230         // Adding relation for XTextListener
231         ifc.awt._XTextListener.TestTextListener listener =
232                 new ifc.awt._XTextListener.TestTextListener();
233         XTextComponent textComp = (XTextComponent) UnoRuntime.queryInterface(
234                                           XTextComponent.class, oObj);
235         textComp.addTextListener(listener);
236         tEnv.addObjRelation("TestTextListener", listener);
237 
238         return tEnv;
239     } // finish method getTestEnvironment
240 } // finish class OButtonControl
241