1 /************************************************************************* 2 * 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4 * 5 * Copyright 2000, 2010 Oracle and/or its affiliates. 6 * 7 * OpenOffice.org - a multi-platform office productivity suite 8 * 9 * This file is part of OpenOffice.org. 10 * 11 * OpenOffice.org is free software: you can redistribute it and/or modify 12 * it under the terms of the GNU Lesser General Public License version 3 13 * only, as published by the Free Software Foundation. 14 * 15 * OpenOffice.org is distributed in the hope that it will be useful, 16 * but WITHOUT ANY WARRANTY; without even the implied warranty of 17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 18 * GNU Lesser General Public License version 3 for more details 19 * (a copy is included in the LICENSE file that accompanied this code). 20 * 21 * You should have received a copy of the GNU Lesser General Public License 22 * version 3 along with OpenOffice.org. If not, see 23 * <http://www.openoffice.org/license.html> 24 * for a copy of the LGPLv3 License. 25 * 26 ************************************************************************/ 27 package mod._forms; 28 29 import java.io.PrintWriter; 30 31 import lib.StatusException; 32 import lib.TestCase; 33 import lib.TestEnvironment; 34 import lib.TestParameters; 35 import util.FormTools; 36 import util.SOfficeFactory; 37 import util.WriterTools; 38 39 import com.sun.star.awt.XControlModel; 40 import com.sun.star.awt.XDevice; 41 import com.sun.star.awt.XGraphics; 42 import com.sun.star.awt.XTextComponent; 43 import com.sun.star.awt.XToolkit; 44 import com.sun.star.awt.XWindow; 45 import com.sun.star.awt.XWindowPeer; 46 import com.sun.star.drawing.XControlShape; 47 import com.sun.star.drawing.XShape; 48 import com.sun.star.lang.XMultiServiceFactory; 49 import com.sun.star.text.XTextDocument; 50 import com.sun.star.uno.UnoRuntime; 51 import com.sun.star.uno.XInterface; 52 import com.sun.star.util.XCloseable; 53 import com.sun.star.view.XControlAccess; 54 55 56 /** 57 * Test for object which is represented by default controller 58 * of the <code>com.sun.star.form.component.FormattedField</code> 59 * component. <p> 60 * 61 * Object implements the following interfaces : 62 * <ul> 63 * <li> <code>com::sun::star::awt::XView</code></li> 64 * <li> <code>com::sun::star::form::XBoundControl</code></li> 65 * <li> <code>com::sun::star::awt::XControl</code></li> 66 * <li> <code>com::sun::star::awt::XTextComponent</code></li> 67 * <li> <code>com::sun::star::awt::XLayoutConstrains</code></li> 68 * <li> <code>com::sun::star::awt::XTextListener</code></li> 69 * <li> <code>com::sun::star::awt::XWindow</code></li> 70 * <li> <code>com::sun::star::lang::XComponent</code></li> 71 * <li> <code>com::sun::star::awt::XTextLayoutConstrains</code></li> 72 * <li> <code>com::sun::star::lang::XEventListener</code></li> 73 * </ul> <p> 74 * This object test <b> is NOT </b> designed to be run in several 75 * threads concurently. 76 * 77 * @see com.sun.star.awt.XView 78 * @see com.sun.star.form.XBoundControl 79 * @see com.sun.star.awt.XControl 80 * @see com.sun.star.awt.XTextComponent 81 * @see com.sun.star.awt.XLayoutConstrains 82 * @see com.sun.star.awt.XTextListener 83 * @see com.sun.star.awt.XWindow 84 * @see com.sun.star.lang.XComponent 85 * @see com.sun.star.awt.XTextLayoutConstrains 86 * @see com.sun.star.lang.XEventListener 87 * @see ifc.awt._XView 88 * @see ifc.form._XBoundControl 89 * @see ifc.awt._XControl 90 * @see ifc.awt._XTextComponent 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 OFormattedControl extends TestCase { 99 XTextDocument xTextDoc; 100 101 /** 102 * Creates a new text document. 103 */ 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 occures.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 */ 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.FormattedField</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 */ 163 protected TestEnvironment createTestEnvironment(TestParameters Param, 164 PrintWriter log) { 165 XInterface oObj = null; 166 Object anotherCtrl = null; 167 XWindowPeer the_win = null; 168 XToolkit the_kit = null; 169 XDevice aDevice = null; 170 XGraphics aGraphic = null; 171 172 //Insert a ControlShape and get the ControlModel 173 XControlShape aShape = FormTools.createControlShape(xTextDoc, 3000, 174 4500, 15000, 10000, 175 "FormattedField"); 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 OFormattedControl 195 try { 196 oObj = the_access.getControl(the_Model); 197 anotherCtrl = 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 OFormattedControl"); 204 e.printStackTrace(log); 205 throw new StatusException("Couldn't get OFormattedControl", e); 206 } 207 208 log.println("creating a new environment for OFormattedControl 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 anotherCtrl); 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 OFormattedControl 241