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