/************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite * * This file is part of OpenOffice.org. * * OpenOffice.org is free software: you can redistribute it and/or modify * it under the terms of the GNU Lesser General Public License version 3 * only, as published by the Free Software Foundation. * * OpenOffice.org is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU Lesser General Public License version 3 for more details * (a copy is included in the LICENSE file that accompanied this code). * * You should have received a copy of the GNU Lesser General Public License * version 3 along with OpenOffice.org. If not, see * * for a copy of the LGPLv3 License. * ************************************************************************/ package complex.XUserInputInterception; import com.sun.star.accessibility.AccessibleRole; import com.sun.star.accessibility.XAccessible; import com.sun.star.accessibility.XAccessibleComponent; import com.sun.star.accessibility.XAccessibleContext; import com.sun.star.awt.KeyEvent; import com.sun.star.awt.MouseEvent; import com.sun.star.awt.Point; import com.sun.star.awt.Rectangle; import com.sun.star.awt.XKeyHandler; import com.sun.star.awt.XMouseClickHandler; import com.sun.star.awt.XUserInputInterception; import com.sun.star.awt.XWindow; import com.sun.star.chart.XChartDocument; import com.sun.star.frame.*; import com.sun.star.lang.*; import com.sun.star.lang.EventObject; import com.sun.star.sheet.XSpreadsheetDocument; import com.sun.star.text.XTextDocument; import com.sun.star.uno.UnoRuntime; import com.sun.star.uno.XInterface; import com.sun.star.util.*; import java.awt.Robot; import java.awt.event.InputEvent; import util.AccessibilityTools; import util.SOfficeFactory; // ---------- junit imports ----------------- import org.junit.After; import org.junit.AfterClass; import org.junit.Before; import org.junit.BeforeClass; import org.junit.Test; import org.openoffice.test.OfficeConnection; import static org.junit.Assert.*; // ------------------------------------------ //----------------------------------------------- /** * This ComplexTest checks the interface * XUserInputInterception. Therefore it creates a document, * adds a mouse and a key listener onto the interface and fire the * correspond events. If all listener works as expected the test resluts in * OK status. * @short Check the interface XUserInputIntercaption * @descr checks is a simple way the interface XUserInputInteraction */ public class EventTest { //------------------------------------------- // some const //------------------------------------------- // member /** points to the global uno service manager. */ private XMultiServiceFactory m_xMSF = null; /** indicates if the mousePressed event was called*/ private boolean m_mousePressed = false; /** indicates if the mouseReleased event was called*/ private boolean m_mouseReleased = false; /** indicates if the mousePressed event was called*/ private boolean m_keyPressed = false; /** indicates if the mouseReleased event was called*/ private boolean m_keyReleased = false; /** points to a global StarOffice factory */ private SOfficeFactory m_SOF = null; /** * define the miliseconds to wait until a EventTrigger thread should * be finished with its work */ final int m_threadWait = 3000; //------------------------------------------- // test environment //------------------------------------------- /** * The test methods are: * * @short A function to tell the framework, * which test functions are available. * @return All test methods. * @todo Think about selection of tests from outside ... */ // public String[] getTestMethodNames() { // return new String[] // { "checkTextDocument", // "checkCalcDocument", // "checkDrawDocument", // "checkImpressDocument", // "checkChartDocument", // "checkMathDocument", // }; // } //------------------------------------------- /** * creates the mebmer m_xMSF and m_SOF * @short Create the environment for following tests. * @descr create an empty test frame, where we can load * different components inside. */ @Before public void before() { // get uno service manager from global test environment m_xMSF = getMSF(); // create frame instance try { // get a soffice factory object m_SOF = SOfficeFactory.getFactory(getMSF()); } catch(java.lang.Throwable ex) { fail("Could not create the XUserInputInterception instance."); } } //------------------------------------------- /** * closes the document * @short close the document. * @param xDoc the document to close */ public void closeDoc(XInterface xDoc) { XCloseable xClose = UnoRuntime.queryInterface(XCloseable.class, xDoc); try { xClose.close(false); } catch(com.sun.star.util.CloseVetoException exVeto) { System.out.println("document couldn't be closed successfully."); } } /** * creates a text document and check the XMouseClickHandler and * XKeyHandler * @see com.sun.star.awt.XKeyHandler * @see com.sun.star.awt.XMouseClickHandler */ @Test public void checkTextDocument(){ XTextDocument xDoc = null; try{ xDoc = m_SOF.createTextDoc("WriterTest"); } catch (com.sun.star.uno.Exception e){ fail("Could not create a text document: " +e.toString()); } checkListener(xDoc); closeDoc(xDoc); } /** * creates an impress document and check the XMouseClickHandler and * XKeyHandler * @see com.sun.star.awt.XKeyHandler * @see com.sun.star.awt.XMouseClickHandler */ @Test public void checkImpressDocument(){ XComponent xDoc = null; try{ xDoc = m_SOF.createImpressDoc("ImpressTest"); } catch (com.sun.star.uno.Exception e){ fail("Could not create an impress document: " +e.toString()); } checkListener(xDoc); closeDoc(xDoc); } /** * creates a chart document and check the XMouseClickHandler and * XKeyHandler * @see com.sun.star.awt.XKeyHandler * @see com.sun.star.awt.XMouseClickHandler */ // TODO! // @Test public void checkChartDocument(){ // // XChartDocument xDoc = null; // // try{ // xDoc = m_SOF.createChartDoc("ChartTest"); // } catch (com.sun.star.uno.Exception e){ // fail("Could not create a chart document: " +e.toString()); // } // // checkListener(xDoc); // // closeDoc(xDoc); // } /** * creates a math document and check the XMouseClickHandler and * XKeyHandler * @see com.sun.star.awt.XKeyHandler * @see com.sun.star.awt.XMouseClickHandler */ @Test public void checkMathDocument(){ XComponent xDoc = null; try{ xDoc = m_SOF.createMathDoc("MathTest"); } catch (com.sun.star.uno.Exception e){ fail("Could not create a math document: " +e.toString()); } checkListener(xDoc); closeDoc(xDoc); } /** * creates a draw document and check the XMouseClickHandler and * XKeyHandler * @see com.sun.star.awt.XKeyHandler * @see com.sun.star.awt.XMouseClickHandler */ @Test public void checkDrawDocument(){ XComponent xDoc = null; try{ xDoc = m_SOF.createDrawDoc("DrawTest"); } catch (com.sun.star.uno.Exception e){ fail("Could not create a draw document: " +e.toString()); } checkListener(xDoc); closeDoc(xDoc); } /** * creates a calc document and check the XMouseClickHandler and * XKeyHandler * @see com.sun.star.awt.XKeyHandler * @see com.sun.star.awt.XMouseClickHandler */ @Test public void checkCalcDocument(){ XSpreadsheetDocument xDoc = null; try{ xDoc = m_SOF.createCalcDoc("CalcTest"); } catch (com.sun.star.uno.Exception e){ fail("Could not create a calc document: " +e.toString()); } checkListener(xDoc); closeDoc(xDoc); } /** * This is the central test method. It is called by ceck[DOCTYPE]Document. It * creates the XUserInputInterception from the document and call the * checkMouseListener test and the checkKeyListener test * @param xDoc the document to test */ private void checkListener(XInterface xDoc){ XModel xModel = UnoRuntime.queryInterface(XModel.class, xDoc); XUserInputInterception xUII = getUII(xModel); checkMouseListener(xUII, xModel); checkKeyListener(xUII, xModel); } /** * Creates a MyKeyHandler and adds it to the * XUserInputInterception. Then an EventTrigger thread * was created and started. * Has OK if the members m_keyPressed and * m_keyReleased are TRUE * @param xUII the XUserInputInterception * @param xModel the XModel of a document * @see EventTest.MyKeyHander * @see EventTest.EventTrigger */ private void checkKeyListener(XUserInputInterception xUII, XModel xModel) { m_keyPressed = false; m_keyReleased = false; MyKeyHandler keyListener = new MyKeyHandler(); xUII.addKeyHandler(keyListener); System.out.println("starting thread to check the key listener..."); EventTrigger et = new EventTrigger(xModel, EventTriggerType.KEY_TEXT_INTO_DOC); et.run(); util.utils.shortWait(m_threadWait); System.out.println("key listener thread should be finished."); assertTrue("key event does not work!", m_keyPressed && m_keyReleased); xUII.removeKeyHandler(keyListener); } /** * Creates a MyMouseClickHandler and adds it to the * XUserInputInterception. Then an EventTrigger thread * was created and started. * Has OK if the members m_mousePressed and * m_mouseReleased are TRUE * @param xUII the XUserInputInterception * @param xModel the XModel of a document * @see EventTest.MyMouseClickHander * @see EventTest.EventTrigger */ private void checkMouseListener(XUserInputInterception xUII, XModel xModel) { m_mousePressed = false; m_mouseReleased = false; MyMouseClickHandler mouseListener = new MyMouseClickHandler(); xUII.addMouseClickHandler(mouseListener); System.out.println("starting thread to check the mouse listener..."); EventTrigger et = new EventTrigger(xModel, EventTriggerType.MOUSE_KLICK_INTO_DOC); et.run(); util.utils.shortWait(m_threadWait); System.out.println("mouse listener thread should be finished."); assertTrue("mouse event does not work!", m_mousePressed && m_mouseReleased); xUII.removeMouseClickHandler(mouseListener); } /** * returns the XUserInputInterception from the XMdoel * @param xModel the XModel of a document * @return the XUserInputInterception of the document */ private XUserInputInterception getUII(XModel xModel){ XController xController = xModel.getCurrentController(); XUserInputInterception xUII = UnoRuntime.queryInterface(XUserInputInterception.class, xController); if (xUII == null) { fail("could not get XUserInputInterception from XContoller"); } return xUII; } /** * Listener which added and its method must be called * on keyPressed and keyReleased call. */ public class MyKeyHandler implements XKeyHandler { /** * This event sets the member m_keyPressed to * true * @param oEvent The key event informs about the pressed key. * @return returns TRUE in erery case */ public boolean keyPressed( KeyEvent oEvent ){ System.out.println("XKeyHandler: keyPressed-Event"); m_keyPressed = true; return true; } /** * This event sets the member m_keyReleased to * true * @param oEvent The key event informs about the pressed key. * @return returns TRUE in erery case */ public boolean keyReleased( KeyEvent oEvent ){ System.out.println("XKeyHandler: keyReleased-Event"); m_keyReleased = true; return true; } /** * This event does nothing usefull * @param oEvent refers to the object that fired the event. */ public void disposing( EventObject oEvent ){ System.out.println("XKeyHandler: disposing-Event"); } } /** * Listener which added and its method must be called * on mousePressed and mouseReleased call. */ public class MyMouseClickHandler implements XMouseClickHandler { /** * This event sets the member m_mousePressed to * true * @param oEvent The mouse event informs about the kind of mouse event. * @return returns TRUE in erery case */ public boolean mousePressed( MouseEvent oEvent ){ System.out.println("XMouseClickHandler: mousePressed-Event"); m_mousePressed = true; return true; } /** * This event sets the member m_mouseReleased to * true * @param oEvent The mouse event informs about the kind of mouse event. * @return returns TRUE in erery case */ public boolean mouseReleased( MouseEvent oEvent ){ System.out.println("XMouseClickHandler: mouseReleased-Event"); m_mouseReleased = true; return true; } /** * This event does nothing usefull * @param oEvent refers to the object that fired the event. */ public void disposing( EventObject oEvent ){ System.out.println("XMouseClickHandler: disposing-Event"); } }; /** * To check the events this class is a thread which click a mouse button and * press a key with the Robot class * @see java.awt.Robot */ private class EventTrigger extends Thread{ /** * represents a AccessibilityTools */ private final AccessibilityTools at = new AccessibilityTools(); /** * represents an EventType * @see EventTest.EventTriggerType */ private int eventType = 0; /** * represents a XModel of a document */ private XModel xModel = null; /** * Creates an instacne of this class. The parameter eType represents * the kind of event wich will be triggert at run() * @param model the model of a document * @param eType the kind of event which should be trigger */ public EventTrigger(XModel model, int eType) { this.xModel = model; this.eventType = eType; } /** * Triggers the event wich is represented by eventType * The scenarios are: *
    *
  • EventTest.EventTriggerType.MOUSE_KLICK_INTO_DOC * which calls *
  • clickIntoDoc
    • * *
  • EventTest.EventTriggerType.KEY_TEXT_INTO_DOC * which calls *
  • clickIntodoc
    • *
  • keyIntoDoc
    • * *
*/ public void run(){ switch (this.eventType){ case EventTriggerType.MOUSE_KLICK_INTO_DOC: clickIntoDoc(); break; case EventTriggerType.KEY_TEXT_INTO_DOC: clickIntoDoc(); keyIntoDoc(); break; } } /** * This method cklicks into the middel of a document. It uses Accessibility * to get the document and query for its position and its range to calculate * the middle. This values was used for Robot Class. This * Robot class is able to move the mouse and to cklick a mouse button * @see java.awt.Robot */ private void clickIntoDoc(){ try{ // get the position and the range of a scroll bar XWindow xWindow = at.getCurrentWindow( getMSF(), xModel); XAccessible xRoot = at.getAccessibleObject(xWindow); XAccessibleContext xPanel = at.getAccessibleObjectForRole(xRoot, AccessibleRole.PANEL); XAccessibleComponent xPanelCont = UnoRuntime.queryInterface(XAccessibleComponent.class, xPanel); // the position of the panel Point point = xPanelCont.getLocationOnScreen(); // the range of the panel Rectangle rect = xPanelCont.getBounds(); try { Robot rob = new Robot(); int x = point.X + (rect.Width / 2); int y = point.Y + (rect.Height / 2); System.out.println("try to klick into the middle of the document"); rob.mouseMove(x, y); rob.mousePress(InputEvent.BUTTON1_MASK); rob.mouseRelease(InputEvent.BUTTON1_MASK); } catch (java.awt.AWTException e) { System.out.println("couldn't press mouse button"); } } catch (java.lang.Exception e){ System.out.println("could not click into the scroll bar: " + e.toString()); } } /** * This method press the "A" key. Therefore it uses the Robot * class. * @see java.awt.Robot */ private void keyIntoDoc(){ try { Robot rob = new Robot(); System.out.println("try to press 'A'"); rob.keyPress(java.awt.event.KeyEvent.VK_A); rob.keyRelease(java.awt.event.KeyEvent.VK_A); } catch (java.awt.AWTException e) { System.out.println("couldn't press key"); } } } /** This interface represents all possible actions which could be used * in the EventTrigger class. * @see EventTest.EventTrigger */ private interface EventTriggerType{ /** klick the mouse into the scroll bar*/ final public static int MOUSE_KLICK_INTO_DOC = 1; /** write some text into a spread sheet*/ final public static int KEY_TEXT_INTO_DOC = 2; } private XMultiServiceFactory getMSF() { final XMultiServiceFactory xMSF1 = UnoRuntime.queryInterface(XMultiServiceFactory.class, connection.getComponentContext().getServiceManager()); return xMSF1; } // setup and close connections @BeforeClass public static void setUpConnection() throws Exception { System.out.println("setUpConnection()"); connection.setUp(); } @AfterClass public static void tearDownConnection() throws InterruptedException, com.sun.star.uno.Exception { System.out.println("tearDownConnection()"); connection.tearDown(); } private static final OfficeConnection connection = new OfficeConnection(); }