/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed
* with this work for additional information regarding copyright
* ownership. The ASF licenses this file to you under the Apache
* License, Version 2.0 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
*/
package mod._forms;
import java.io.PrintWriter;
import lib.TestCase;
import lib.TestEnvironment;
import lib.TestParameters;
import util.FormTools;
import util.SOfficeFactory;
import util.WriterTools;
import com.sun.star.awt.XControl;
import com.sun.star.awt.XControlModel;
import com.sun.star.awt.XDevice;
import com.sun.star.awt.XGraphics;
import com.sun.star.awt.XTextComponent;
import com.sun.star.awt.XToolkit;
import com.sun.star.awt.XWindow;
import com.sun.star.awt.XWindowPeer;
import com.sun.star.drawing.XControlShape;
import com.sun.star.text.XTextDocument;
import com.sun.star.uno.UnoRuntime;
import com.sun.star.uno.XInterface;
import com.sun.star.util.XCloseable;
import com.sun.star.view.XControlAccess;
/**
* Test for object which is represented by default controller
* of the <code>com.sun.star.form.component.TextField</code>
* component. <p>
*
* Object implements the following interfaces :
* <ul>
* <li> <code>com::sun::star::awt::XView</code></li>
* <li> <code>com::sun::star::form::XBoundControl</code></li>
* <li> <code>com::sun::star::awt::XControl</code></li>
* <li> <code>com::sun::star::awt::XTextComponent</code></li>
* <li> <code>com::sun::star::awt::XLayoutConstrains</code></li>
* <li> <code>com::sun::star::awt::XTextListener</code></li>
* <li> <code>com::sun::star::form::XChangeBroadcaster</code></li>
* <li> <code>com::sun::star::awt::XWindow</code></li>
* <li> <code>com::sun::star::lang::XComponent</code></li>
* <li> <code>com::sun::star::awt::XTextLayoutConstrains</code></li>
* <li> <code>com::sun::star::lang::XEventListener</code></li>
* </ul> <p>
* This object test <b> is NOT </b> designed to be run in several
* threads concurrently.
*
* @see com.sun.star.awt.XView
* @see com.sun.star.form.XBoundControl
* @see com.sun.star.awt.XControl
* @see com.sun.star.awt.XTextComponent
* @see com.sun.star.awt.XLayoutConstrains
* @see com.sun.star.awt.XTextListener
* @see com.sun.star.form.XChangeBroadcaster
* @see com.sun.star.awt.XWindow
* @see com.sun.star.lang.XComponent
* @see com.sun.star.awt.XTextLayoutConstrains
* @see com.sun.star.lang.XEventListener
* @see ifc.awt._XView
* @see ifc.form._XBoundControl
* @see ifc.awt._XControl
* @see ifc.awt._XTextComponent
* @see ifc.awt._XLayoutConstrains
* @see ifc.awt._XTextListener
* @see ifc.form._XChangeBroadcaster
* @see ifc.awt._XWindow
* @see ifc.lang._XComponent
* @see ifc.awt._XTextLayoutConstrains
* @see ifc.lang._XEventListener
*/
public class OEditControl
extends TestCase {
XTextDocument xTextDoc;
/**
* Creates a new text document.
*/
@Override
protected void initialize(TestParameters Param, PrintWriter log)
throws Exception {
SOfficeFactory SOF = SOfficeFactory.getFactory(Param.getMSF());
log.println(
"creating a textdocument");
xTextDoc = SOF.createTextDoc(
null);
}
/**
* Disposes the text document created before
*/
@Override
protected void cleanup(TestParameters tParam, PrintWriter log) {
log.println(
" disposing xTextDoc ");
try {
XCloseable closer = UnoRuntime.queryInterface(
XCloseable.
class, xTextDoc);
closer.close(
true);
}
catch (com.sun.star.util.CloseVetoException e) {
log.println(
"couldn't close document");
}
catch (com.sun.star.lang.DisposedException e) {
log.println(
"couldn't close document");
}
}
/**
* Creates two components and inserts them to the form of
* text document. One component
* (<code>com.sun.star.form.component.TextField</code>) is created
* for testing, another to be passed as relation. Using a controller
* of the text document the controller of the first component is
* obtained and returned in environment as a test object. <p>
*
* Object relations created :
* <ul>
* <li> <code>'GRAPHICS'</code> for
* {@link ifc.awt._XView} : a graphics component
* created using screen device of the window peer of
* the controller tested. </li>
* <li> <code>'CONTEXT'</code> for
* {@link ifc.awt._XControl} : the text document
* where the component is inserted. </li>
* <li> <code>'WINPEER'</code> for
* {@link ifc.awt._XControl} : Window peer of the
* controller tested. </li>
* <li> <code>'TOOLKIT'</code> for
* {@link ifc.awt._XControl} : toolkit of the component.</li>
* <li> <code>'MODEL'</code> for
* {@link ifc.awt._XControl} : the model of the controller.</li>
* <li> <code>'XWindow.AnotherWindow'</code> for
* {@link ifc.awt._XWindow} : the controller of another
* component. </li>
* <li> <code>'Win1'</code> for
* {@link ifc.form._XChangeBroadcaster} : the window (controller)
* of the tested component. </li>
* <li> <code>'Win2'</code> for
* {@link ifc.form._XChangeBroadcaster} : the window (controller)
* of another component. </li>
* <li> <code>'CONTROL'</code> for
* {@link ifc.form._XChangeBroadcaster} : the controller
* of another component. </li>
* </ul>
*/
@Override
protected TestEnvironment createTestEnvironment(TestParameters Param,
PrintWriter log)
throws Exception {
XInterface oObj =
null;
XControl aControl =
null;
XWindowPeer the_win =
null;
XToolkit the_kit =
null;
XDevice aDevice =
null;
XGraphics aGraphic =
null;
//Insert a ControlShape and get the ControlModel
XControlShape aShape = FormTools.createControlShape(xTextDoc, 3000,
4500, 15000, 10000,
"TextField");
WriterTools.getDrawPage(xTextDoc).add(aShape);
XControlModel the_Model = aShape.getControl();
XControlShape aShape2 = FormTools.createControlShape(xTextDoc, 3000,
4500, 5000, 10000,
"TextField");
WriterTools.getDrawPage(xTextDoc).add(aShape2);
XControlModel the_Model2 = aShape2.getControl();
//Try to query XControlAccess
XControlAccess the_access = UnoRuntime.queryInterface(
XControlAccess.
class,
xTextDoc.getCurrentController());
//now get the OEditControl
oObj = the_access.getControl(the_Model);
aControl = the_access.getControl(the_Model2);
the_win = the_access.getControl(the_Model).getPeer();
the_kit = the_win.getToolkit();
aDevice = the_kit.createScreenCompatibleDevice(200, 200);
aGraphic = aDevice.createGraphics();
log.println(
"creating a new environment for OEditControl object");
TestEnvironment tEnv =
new TestEnvironment(oObj);
//Adding ObjRelation for XView
tEnv.addObjRelation(
"GRAPHICS", aGraphic);
//Adding ObjRelation for XControl
tEnv.addObjRelation(
"CONTEXT", xTextDoc);
tEnv.addObjRelation(
"WINPEER", the_win);
tEnv.addObjRelation(
"TOOLKIT", the_kit);
tEnv.addObjRelation(
"MODEL", the_Model);
// relations for XChangeBroadcaster
XWindow forObjRel = UnoRuntime.queryInterface(XWindow.
class,
aControl);
tEnv.addObjRelation(
"Win1",
UnoRuntime.queryInterface(XWindow.
class,
oObj));
tEnv.addObjRelation(
"Win2", forObjRel);
tEnv.addObjRelation(
"CONTROL", aControl);
// relation for XWindow
tEnv.addObjRelation(
"XWindow.AnotherWindow", forObjRel);
tEnv.addObjRelation(
"XWindow.ControlShape", aShape);
// Adding relation for XTextListener
ifc.awt._XTextListener.TestTextListener listener =
new ifc.awt._XTextListener.TestTextListener();
XTextComponent textComp = UnoRuntime.queryInterface(
XTextComponent.
class, oObj);
textComp.addTextListener(listener);
tEnv.addObjRelation(
"TestTextListener", listener);
return tEnv;
}
// finish method getTestEnvironment
}
// finish class OEditControl
