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