qadevOOo/tests/java/mod/_forms/OButtonControl.java

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