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.accessibility.XAccessibleSelection;
35 import com.sun.star.accessibility.XAccessibleValue;
36 import com.sun.star.awt.XExtendedToolkit;
37 import com.sun.star.awt.XWindow;
38 import com.sun.star.beans.PropertyValue;
39 import com.sun.star.frame.XController;
40 import com.sun.star.frame.XDesktop;
41 import com.sun.star.frame.XDispatch;
42 import com.sun.star.frame.XDispatchProvider;
43 import com.sun.star.frame.XModel;
44 import com.sun.star.lang.XMultiServiceFactory;
45 import com.sun.star.text.XTextDocument;
46 import com.sun.star.uno.UnoRuntime;
47 import com.sun.star.uno.XInterface;
48 import com.sun.star.util.URL;
49 import com.sun.star.util.XURLTransformer;
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  *  <li><code>
77  *  ::com::sun::star::accessibility::XAccessibleValue</code></li>
78  *  <li><code>
79  *  ::com::sun::star::accessibility::XAccessibleText</code></li>
80  * </ul> <p>
81  *
82  * @see com.sun.star.accessibility.XAccessibleEventBroadcaster
83  * @see com.sun.star.accessibility.XAccessibleContext
84  * @see com.sun.star.accessibility.XAccessibleComponent
85  * @see com.sun.star.accessibility.XAccessibleExtendedComponent
86  * @see com.sun.star.accessibility.XAccessibleValue
87  * @see com.sun.star.accessibility.XAccessibleText
88  * @see ifc.accessibility._XAccessibleEventBroadcaster
89  * @see ifc.accessibility._XAccessibleContext
90  * @see ifc.accessibility._XAccessibleComponent
91  * @see ifc.accessibility.XAccessibleExtendedComponent
92  * @see ifc.accessibility.XAccessibleValue
93  * @see ifc.accessibility.XAccessibleText
94  */
95 public class AccessibleRadioButton extends TestCase {
96     private static XDesktop the_Desk;
97     private static XTextDocument xTextDoc;
98     private static XAccessibleAction accCloseButton;
99 
100 
101     /**
102      * Creates the Desktop service (<code>com.sun.star.frame.Desktop</code>).
103      */
104     protected void initialize(TestParameters Param, PrintWriter log) {
105         the_Desk = (XDesktop) UnoRuntime.queryInterface(XDesktop.class,
106                                                         DesktopTools.createDesktop(
107                                                                 (XMultiServiceFactory) Param.getMSF()));
108     }
109 
110     /**
111      * Closes a Hyperlink dialog, disposes the document, if exists, created in
112      * <code>createTestEnvironment</code> method.
113      */
114     protected void cleanup(TestParameters Param, PrintWriter log) {
115         try {
116             if (accCloseButton != null) {
117                 log.println("closing HyperlinkDialog");
118                 accCloseButton.doAccessibleAction(0);
119             }
120         } catch (com.sun.star.lang.IndexOutOfBoundsException e) {
121             e.printStackTrace(log);
122         } catch (com.sun.star.lang.DisposedException de) {
123             log.println("Already disposed");
124         }
125 
126         log.println("disposing xTextDoc");
127 
128         if (xTextDoc != null) {
129             closeDoc();
130         }
131     }
132 
133     /**
134      * Creates a text document, opens a hypelink dialog, selects a first item
135      * in IconChoiceCtrl.
136      * Then obtains an accessible object with
137      * the role <code>AccessibleRole.RADIOBUTTON</code> with the name <code>
138      * "Internet"</code>.
139      * Object relations created :
140      * <ul>
141      *  <li> <code>'EventProducer'</code> for
142      *      {@link ifc.accessibility._XAccessibleEventBroadcaster}:
143      *      grabs focus </li>
144      *  <li> <code>'XAccessibleText.Text'</code> for
145      *      {@link ifc.accessibility._XAccessibleText}:
146      *      the text of the component </li>
147      *  <li> <code>'XAccessibleValue.anotherFromGroup'</code> for
148      *      {@link ifc.accessibility._XAccessibleValue}:
149      *       <code>'FTP'</code> button </li>
150      * </ul>
151      *
152      * @param tParam test parameters
153      * @param log writer to log information while testing
154      *
155      * @see com.sun.star.awt.Toolkit
156      * @see com.sun.star.accessibility.AccessibleRole
157      * @see ifc.accessibility._XAccessibleEventBroadcaster
158      * @see ifc.accessibility._XAccessibleText
159      * @see com.sun.star.accessibility.XAccessibleEventBroadcaster
160      * @see com.sun.star.accessibility.XAccessibleText
161      */
162     protected TestEnvironment createTestEnvironment(TestParameters tParam,
163                                                     PrintWriter log) {
164         log.println("creating a test environment");
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         util.utils.shortWait(2000);
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 HyperlinkDialog");
204 
205         URL[] url = new URL[1];
206         url[0] = new URL();
207         url[0].Complete = ".uno:HyperlinkDialog";
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         util.utils.shortWait(2000);
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         util.utils.shortWait(2000);
233 
234         XWindow xWindow = (XWindow) UnoRuntime.queryInterface(XWindow.class,
235                                                               tk.getActiveTopWindow());
236 
237         XAccessible xRoot = at.getAccessibleObject(xWindow);
238 
239         XAccessibleContext iconChoiceCtrl = at.getAccessibleObjectForRole(
240                                                     xRoot, AccessibleRole.TREE,
241                                                     "IconChoiceControl");
242 
243         XAccessibleSelection sel = (XAccessibleSelection) UnoRuntime.queryInterface(
244                                            XAccessibleSelection.class,
245                                            iconChoiceCtrl);
246 
247         try {
248             sel.selectAccessibleChild(0);
249         } catch (com.sun.star.lang.IndexOutOfBoundsException e) {
250             log.println("Unexpected exception");
251             e.printStackTrace(log);
252         }
253 
254         at.printAccessibleTree(log,xRoot, tParam.getBool(util.PropertyName.DEBUG_IS_ACTIVE));
255 
256         oObj = at.getAccessibleObjectForRole(xRoot,
257                                              AccessibleRole.RADIO_BUTTON,
258                                              "Web");
259 
260         XAccessibleContext anotherButton = at.getAccessibleObjectForRole(xRoot,
261                                                                          AccessibleRole.RADIO_BUTTON,
262                                                                          "FTP");
263 
264         XAccessibleContext closeButton = at.getAccessibleObjectForRole(xRoot,
265                                                                        AccessibleRole.PUSH_BUTTON,
266                                                                        "Close");
267 
268 
269         accCloseButton = (XAccessibleAction) UnoRuntime.queryInterface(
270                                  XAccessibleAction.class, closeButton);
271 
272         log.println("ImplementationName: " + util.utils.getImplName(oObj));
273 
274         TestEnvironment tEnv = new TestEnvironment(oObj);
275 
276         tEnv.addObjRelation("EditOnly",
277                             "This method isn't supported in this component");
278 
279         tEnv.addObjRelation("LimitedBounds", "yes");
280 
281         final XAccessibleComponent acomp = (XAccessibleComponent) UnoRuntime.queryInterface(
282                                                    XAccessibleComponent.class,
283                                                    oObj);
284 
285         tEnv.addObjRelation("EventProducer",
286                             new ifc.accessibility._XAccessibleEventBroadcaster.EventProducer() {
287             public void fireEvent() {
288                 acomp.grabFocus();
289             }
290         });
291 
292         tEnv.addObjRelation("XAccessibleText.Text", "Web");
293 
294         tEnv.addObjRelation("EditOnly",
295                             "Can't change or select Text in AccessibleRadioButton");
296 
297         XAccessibleValue anotherButtonValue = (XAccessibleValue) UnoRuntime.queryInterface(
298                                                       XAccessibleValue.class,
299                                                       anotherButton);
300 
301         tEnv.addObjRelation("XAccessibleValue.anotherFromGroup",
302                             anotherButtonValue);
303 
304         return tEnv;
305     }
306 
307     protected void closeDoc() {
308         util.DesktopTools.closeDoc(xTextDoc);
309     }
310 }
311