qadevOOo/tests/java/mod/_pcr/ObjectInspector.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
  19 package mod._pcr;
  20
  21 import com.sun.star.awt.XWindow;
  22 import com.sun.star.awt.XWindowPeer;
  23 import com.sun.star.frame.XDesktop;
  24 import com.sun.star.frame.XFrame;
  25 import com.sun.star.frame.XFrames;
  26 import com.sun.star.frame.XFramesSupplier;
  27 import com.sun.star.inspection.XObjectInspector;
  28 import com.sun.star.inspection.XObjectInspectorModel;
  29 import com.sun.star.lang.XInitialization;
  30 import com.sun.star.uno.UnoRuntime;
  31 import com.sun.star.util.CloseVetoException;
  32 import com.sun.star.util.XCloseable;
  33 import helper.PropertyHandlerImpl;
  34 import java.io.PrintWriter;
  35
  36 import lib.TestCase;
  37 import lib.TestEnvironment;
  38 import lib.TestParameters;
  39
  40 import com.sun.star.lang.XMultiServiceFactory;
  41 import com.sun.star.uno.XInterface;
  42 import util.DesktopTools;
  43 import util.utils;
  44
  45 /**
  46  * Test for object which is represented by service
  47  * <code>com.sun.star.reflection.ObjectInspector</code>. <p>
  48  * Object implements the following interfaces :
  49  * <ul>
  50  *  <li> <code>com::sun::star::lang::XComponent</code></li>
  51  *  <li> <code>com::sun::star::inspection::XObjectInspector</code></li>
  52  *  <li> <code>com::sun::star::frame::XController</code></li>
  53  * </ul>
  54  * This object test <b> is NOT </b> designed to be run in several
  55  * threads concurrently.
  56  * @see com.sun.star.lang.XComponent
  57  * @see com.sun.star.inspection.XObjectInspector
  58  * @see com.sun.star.frame.XController
  59  */
  60 public class ObjectInspector extends TestCase {
  61
  62     /**
  63      * module variable which holds the Desktop
  64      * @see com.sun.star.frame.Desktop
  65      */
  66     protected static XDesktop xDesktop = null;
  67
  68     /**
  69      * assign to the module variable <CODE>xDesktop</CODE> the desktop
  70      * @param Param the test parameters
  71      * @param log the log writer
  72      * @see lib.TestParameters
  73      * @see share.LogWriter
  74      * @see com.sun.star.frame.Desktop
  75      */
  76     @Override
  77     protected void initialize(TestParameters Param, PrintWriter log) throws Exception {
  78         log.println("create a desktop...");
  79         xDesktop = DesktopTools.createDesktop(Param.getMSF());
  80     }
  81
  82     /**
  83      * Creating a TestEnvironment for the interfaces to be tested.
  84      * Creates an instance of the service
  85      * <code>com.sun.star.inspection.ObjectInspector</code> and adds it to
  86      * a floating frame.<br>
  87      * To test <CODE>com.sun.star.inspection.XObjectInspector.inspect()</CODE>
  88      * an own implementation of
  89      * <CODE>com.sun.star.inspection.XPropertyHandler</CODE> was used.
  90      * @param tParam the tests parameter
  91      * @param log the logger
  92      * @return the test environment
  93      * @see util.DesktopTools
  94      * @see helper.PropertyHandlerImpl
  95      */
  96     @Override
  97     protected TestEnvironment createTestEnvironment(TestParameters tParam, PrintWriter log) throws Exception {
  98
  99         this.cleanup(tParam, log);
 100
 101         XMultiServiceFactory xMSF = tParam.getMSF();
 102
 103         XInterface oInspector = (XInterface) xMSF.createInstance("com.sun.star.inspection.ObjectInspector");
 104
 105         XObjectInspector xInspector = UnoRuntime.queryInterface(XObjectInspector.class, oInspector);
 106
 107         log.println("ImplementationName '" + utils.getImplName(xInspector) + "'");
 108
 109         XInterface oInspectorModel = (XInterface) xMSF.createInstance("com.sun.star.inspection.ObjectInspectorModel");
 110
 111         XObjectInspectorModel xInspectorModel = UnoRuntime.queryInterface(XObjectInspectorModel.class, oInspectorModel);
 112
 113         XInterface oInspectorModelToSet = (XInterface) xMSF.createInstance("com.sun.star.inspection.ObjectInspectorModel");
 114
 115         XObjectInspectorModel xInspectorModelToSet = UnoRuntime.queryInterface(XObjectInspectorModel.class, oInspectorModelToSet);
 116
 117
 118         log.println("create a floating frame...");
 119
 120         XWindowPeer xWindowPeer = DesktopTools.createFloatingWindow(xMSF);
 121
 122         XWindow xWindow = UnoRuntime.queryInterface(XWindow.class, xWindowPeer);
 123
 124         XInterface oFrame = (XInterface) xMSF.createInstance("com.sun.star.frame.Frame");
 125
 126         XFrame xFrame = UnoRuntime.queryInterface(XFrame.class, oFrame);
 127
 128         xFrame.setName("ObjectInspector");
 129         xFrame.initialize(xWindow);
 130
 131         XFramesSupplier xFramesSup = UnoRuntime.queryInterface(XFramesSupplier.class, xDesktop);
 132
 133         XFrames xFrames = xFramesSup.getFrames();
 134         xFrames.append(xFrame);
 135
 136
 137         log.println("attach ObjectInspector to floating frame...");
 138
 139         XInitialization xOII = UnoRuntime.queryInterface(XInitialization.class, xInspectorModel);
 140
 141         xOII.initialize(new Object[0]);
 142
 143         xInspector.setInspectorModel(xInspectorModel);
 144
 145         // for debug purposes the following lines could commented out. But in
 146         // this case the com.sun.star.frame.XController would be failed!
 147         //xInspector.attachFrame(xFrame);
 148         //xWindow.setVisible(true);
 149
 150         Object[] oInspect = new Object[1];
 151         oInspect[0] = new PropertyHandlerImpl();
 152
 153         TestEnvironment tEnv = new TestEnvironment(xInspector);
 154
 155         // com.sun.star.frame.XController
 156         tEnv.addObjRelation("Frame",xFrame);
 157
 158         tEnv.addObjRelation("XObjectInspector.toInspect", oInspect);
 159
 160         tEnv.addObjRelation("XObjectInspector.InspectorModelToSet", xInspectorModelToSet);
 161
 162         return tEnv;
 163     }
 164
 165     /**
 166      * Closes the ObjectOnspector using <CODE>XCloseable</CODE>
 167      * @see com.sun.star.util.XCloseable
 168      * @param Param the test parameter
 169      * @param log the logger
 170      */
 171     @Override
 172     protected void cleanup(TestParameters Param, PrintWriter log) {
 173         log.println("    Closing dialog if one exists ... ");
 174
 175         XFrame existentInspector = null;
 176
 177         XFrame xFrame = UnoRuntime.queryInterface(XFrame.class, xDesktop);
 178
 179         existentInspector = xFrame.findFrame( "ObjectInspector", 255 );
 180
 181         if ( existentInspector != null ){
 182             XCloseable closer = UnoRuntime.queryInterface(
 183                     XCloseable.class, existentInspector);
 184             try{
 185                 closer.close(true);
 186             } catch (CloseVetoException e){
 187                 log.println("Could not close inspector: " + e.toString());
 188             }
 189         }
 190     }
 191 }