xref: /AOO41X/main/qadevOOo/tests/java/mod/_toolkit/AccessibleTabPage.java (revision 1ecadb572e7010ff3b3382ad9bf179dbc6efadbb)
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._toolkit;
28 
29 import com.sun.star.accessibility.AccessibleRole;
30 import com.sun.star.accessibility.XAccessible;
31 import com.sun.star.accessibility.XAccessibleAction;
32 import com.sun.star.accessibility.XAccessibleComponent;
33 import com.sun.star.accessibility.XAccessibleContext;
34 import com.sun.star.awt.Point;
35 import com.sun.star.awt.XExtendedToolkit;
36 import com.sun.star.awt.XWindow;
37 import com.sun.star.beans.PropertyValue;
38 import com.sun.star.frame.XController;
39 import com.sun.star.frame.XDesktop;
40 import com.sun.star.frame.XDispatch;
41 import com.sun.star.frame.XDispatchProvider;
42 import com.sun.star.frame.XModel;
43 import com.sun.star.lang.XMultiServiceFactory;
44 import com.sun.star.text.XTextDocument;
45 import com.sun.star.uno.UnoRuntime;
46 import com.sun.star.uno.XInterface;
47 import com.sun.star.util.URL;
48 import com.sun.star.util.XURLTransformer;
49 
50 
51 import java.io.PrintWriter;
52 
53 import lib.StatusException;
54 import lib.TestCase;
55 import lib.TestEnvironment;
56 import lib.TestParameters;
57 
58 import util.AccessibilityTools;
59 import util.DesktopTools;
60 import util.SOfficeFactory;
61 
62 
63 /**
64  * Test for object that implements the following interfaces :
65  * <ul>
66  *  <li><code>
67  *  ::com::sun::star::accessibility::XAccessibleContext</code></li>
68  *  <li><code>
69  *  ::com::sun::star::accessibility::XAccessibleEventBroadcaster
70  *  </code></li>
71  *  <li><code>
72  *  ::com::sun::star::accessibility::XAccessibleComponent</code></li>
73  *  <li><code>
74  *  ::com::sun::star::accessibility::XAccessibleExtendedComponent
75  *  </code></li>
76  * </ul> <p>
77  *
78  * @see com.sun.star.accessibility.XAccessibleEventBroadcaster
79  * @see com.sun.star.accessibility.XAccessibleContext
80  * @see com.sun.star.accessibility.XAccessibleComponent
81  * @see com.sun.star.accessibility.XAccessibleExtendedComponent
82  * @see ifc.accessibility._XAccessibleEventBroadcaster
83  * @see ifc.accessibility._XAccessibleContext
84  * @see ifc.accessibility._XAccessibleComponent
85  * @see ifc.accessibility.XAccessibleExtendedComponent
86  */
87 public class AccessibleTabPage extends TestCase {
88     private static XDesktop the_Desk;
89     private static XTextDocument xTextDoc;
90     private static XAccessibleAction accCloseButton = null;
91 
92     /**
93      * Creates the Desktop service (<code>com.sun.star.frame.Desktop</code>).
94      */
95     protected void initialize(TestParameters Param, PrintWriter log) {
96         the_Desk = (XDesktop) UnoRuntime.queryInterface(XDesktop.class,
97                                                         DesktopTools.createDesktop(
98                                                                 (XMultiServiceFactory) Param.getMSF()));
99     }
100 
101     /**
102      * Closes an InsertFields dialog, disposes the document, if exists, created in
103      * <code>createTestEnvironment</code> method.
104      */
105     protected void cleanup(TestParameters Param, PrintWriter log) {
106         try {
107             if (accCloseButton != null) {
108                 log.println("closing InsertFields Dialog");
109                 accCloseButton.doAccessibleAction(0);
110                 shortWait();
111             }
112         } catch (com.sun.star.lang.IndexOutOfBoundsException e) {
113             e.printStackTrace(log);
114         } catch (com.sun.star.lang.DisposedException e) {
115             log.println("Couldn't close dialog " + e.getMessage());
116         }
117 
118         log.println("disposing xTextDoc");
119 
120         if (xTextDoc != null) {
121             closeDoc();
122         }
123     }
124 
125     /**
126      * Creates a text document, opens an InsertField dialog.
127      * Then obtains an accessible object with
128      * the role <code>AccessibleRole.PAGETAB</code>.
129      * Object relations created :
130      * <ul>
131      *  <li> <code>'EventProducer'</code> for
132      *      {@link ifc.accessibility._XAccessibleEventBroadcaster}:
133      *      grabs focus </li>
134      * </ul>
135      *
136      * @param tParam test parameters
137      * @param log writer to log information while testing
138      *
139      * @see com.sun.star.awt.Toolkit
140      * @see com.sun.star.accessibility.AccessibleRole
141      * @see ifc.accessibility._XAccessibleEventBroadcaster
142      * @see com.sun.star.accessibility.XAccessibleEventBroadcaster
143      */
144     protected TestEnvironment createTestEnvironment(TestParameters tParam,
145                                                     PrintWriter log) {
146         log.println("creating a test environment");
147 
148         try {
149             if (accCloseButton != null) {
150                 log.println("closing InsertFields Dialog");
151                 accCloseButton.doAccessibleAction(0);
152                 shortWait();
153             }
154         } catch (com.sun.star.lang.IndexOutOfBoundsException e) {
155             e.printStackTrace(log);
156         } catch (com.sun.star.lang.DisposedException e) {
157             log.println("Couldn't close dialog " + e.getMessage());
158         }
159 
160         log.println("disposing xTextDoc");
161 
162         if (xTextDoc != null) {
163             closeDoc();
164         }
165 
166         // get a soffice factory object
167         SOfficeFactory SOF = SOfficeFactory.getFactory(
168                                      (XMultiServiceFactory) tParam.getMSF());
169 
170         try {
171             log.println("creating a text document");
172             xTextDoc = SOF.createTextDoc(null);
173         } catch (com.sun.star.uno.Exception e) {
174             // Some exception occures.FAILED
175             e.printStackTrace(log);
176             throw new StatusException("Couldn't create document", e);
177         }
178 
179         shortWait();
180 
181         XModel aModel1 = (XModel) UnoRuntime.queryInterface(XModel.class,
182                                                             xTextDoc);
183 
184         XController secondController = aModel1.getCurrentController();
185 
186         XDispatchProvider aProv = (XDispatchProvider) UnoRuntime.queryInterface(
187                                           XDispatchProvider.class,
188                                           secondController);
189 
190         XURLTransformer urlTransf = null;
191 
192         try {
193             XInterface transf = (XInterface) ((XMultiServiceFactory) tParam.getMSF()).createInstance(
194                                         "com.sun.star.util.URLTransformer");
195             urlTransf = (XURLTransformer) UnoRuntime.queryInterface(
196                                 XURLTransformer.class, transf);
197         } catch (com.sun.star.uno.Exception e) {
198             e.printStackTrace(log);
199             throw new StatusException("Couldn't create URLTransformer", e);
200         }
201 
202         XDispatch getting = null;
203         log.println("opening InsertField dialog");
204 
205         URL[] url = new URL[1];
206         url[0] = new URL();
207         url[0].Complete = ".uno:InsertField";
208         urlTransf.parseStrict(url);
209         getting = aProv.queryDispatch(url[0], "", 0);
210 
211         PropertyValue[] noArgs = new PropertyValue[0];
212         getting.dispatch(url[0], noArgs);
213 
214         shortWait();
215 
216         XInterface oObj = null;
217 
218         try {
219             oObj = (XInterface) ((XMultiServiceFactory) tParam.getMSF()).createInstance(
220                            "com.sun.star.awt.Toolkit");
221         } catch (com.sun.star.uno.Exception e) {
222             log.println("Couldn't get toolkit");
223             e.printStackTrace(log);
224             throw new StatusException("Couldn't get toolkit", e);
225         }
226 
227         XExtendedToolkit tk = (XExtendedToolkit) UnoRuntime.queryInterface(
228                                       XExtendedToolkit.class, oObj);
229 
230         AccessibilityTools at = new AccessibilityTools();
231 
232         shortWait();
233 
234         XWindow xWindow = (XWindow) UnoRuntime.queryInterface(XWindow.class,
235                                                               tk.getActiveTopWindow());
236 
237         XAccessible xRoot = at.getAccessibleObject(xWindow);
238 
239         XAccessibleContext closeButton = at.getAccessibleObjectForRole(xRoot,
240                                                                        AccessibleRole.PUSH_BUTTON,
241                                                                        "Close");
242 
243         accCloseButton = (XAccessibleAction) UnoRuntime.queryInterface(
244                                  XAccessibleAction.class, closeButton);
245 
246         oObj = at.getAccessibleObjectForRole(xRoot, AccessibleRole.PAGE_TAB);
247 
248         log.println("ImplementationName: " + util.utils.getImplName(oObj));
249 
250         TestEnvironment tEnv = new TestEnvironment(oObj);
251 
252         tEnv.addObjRelation("EditOnly", "toolkit.AccessibleTabPage");
253         tEnv.addObjRelation("LimitedBounds", "toolkit.AccessibleTabPage");
254 
255         XAccessibleComponent accComp = (XAccessibleComponent) UnoRuntime.queryInterface(
256                                                XAccessibleComponent.class,
257                                                oObj);
258         final Point point = accComp.getLocationOnScreen();
259 
260         shortWait();
261 
262         XInterface xEventInt = at.getAccessibleObjectForRole(xRoot, AccessibleRole.PAGE_TAB, "Variables");
263         final XAccessibleComponent eventAccComp = (XAccessibleComponent) UnoRuntime.queryInterface(
264                                                XAccessibleComponent.class,
265                                                xEventInt);
266 
267         tEnv.addObjRelation("EventProducer",
268                             new ifc.accessibility._XAccessibleEventBroadcaster.EventProducer() {
269             public void fireEvent() {
270                eventAccComp.grabFocus();
271             }
272         });
273 
274         return tEnv;
275     }
276 
277     /**
278     * Sleeps for 0.5 sec. to allow StarOffice to react on <code>
279     * reset</code> call.
280     */
281     private void shortWait() {
282         try {
283             Thread.currentThread().sleep(1000);
284         } catch (InterruptedException e) {
285             System.out.println("While waiting :" + e);
286         }
287     }
288 
289     protected void closeDoc() {
290         util.DesktopTools.closeDoc(xTextDoc);
291     }
292 }
293