1*b1cdbd2cSJim Jagielski /**************************************************************
2*b1cdbd2cSJim Jagielski  *
3*b1cdbd2cSJim Jagielski  * Licensed to the Apache Software Foundation (ASF) under one
4*b1cdbd2cSJim Jagielski  * or more contributor license agreements.  See the NOTICE file
5*b1cdbd2cSJim Jagielski  * distributed with this work for additional information
6*b1cdbd2cSJim Jagielski  * regarding copyright ownership.  The ASF licenses this file
7*b1cdbd2cSJim Jagielski  * to you under the Apache License, Version 2.0 (the
8*b1cdbd2cSJim Jagielski  * "License"); you may not use this file except in compliance
9*b1cdbd2cSJim Jagielski  * with the License.  You may obtain a copy of the License at
10*b1cdbd2cSJim Jagielski  *
11*b1cdbd2cSJim Jagielski  *   http://www.apache.org/licenses/LICENSE-2.0
12*b1cdbd2cSJim Jagielski  *
13*b1cdbd2cSJim Jagielski  * Unless required by applicable law or agreed to in writing,
14*b1cdbd2cSJim Jagielski  * software distributed under the License is distributed on an
15*b1cdbd2cSJim Jagielski  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16*b1cdbd2cSJim Jagielski  * KIND, either express or implied.  See the License for the
17*b1cdbd2cSJim Jagielski  * specific language governing permissions and limitations
18*b1cdbd2cSJim Jagielski  * under the License.
19*b1cdbd2cSJim Jagielski  *
20*b1cdbd2cSJim Jagielski  *************************************************************/
21*b1cdbd2cSJim Jagielski 
22*b1cdbd2cSJim Jagielski 
23*b1cdbd2cSJim Jagielski package mod._sw;
24*b1cdbd2cSJim Jagielski 
25*b1cdbd2cSJim Jagielski import java.io.PrintWriter;
26*b1cdbd2cSJim Jagielski 
27*b1cdbd2cSJim Jagielski import lib.StatusException;
28*b1cdbd2cSJim Jagielski import lib.TestCase;
29*b1cdbd2cSJim Jagielski import lib.TestEnvironment;
30*b1cdbd2cSJim Jagielski import lib.TestParameters;
31*b1cdbd2cSJim Jagielski import util.AccessibilityTools;
32*b1cdbd2cSJim Jagielski import util.WriterTools;
33*b1cdbd2cSJim Jagielski import util.utils;
34*b1cdbd2cSJim Jagielski 
35*b1cdbd2cSJim Jagielski import com.sun.star.accessibility.AccessibleRole;
36*b1cdbd2cSJim Jagielski import com.sun.star.accessibility.XAccessible;
37*b1cdbd2cSJim Jagielski import com.sun.star.awt.XWindow;
38*b1cdbd2cSJim Jagielski import com.sun.star.beans.XPropertySet;
39*b1cdbd2cSJim Jagielski import com.sun.star.frame.XController;
40*b1cdbd2cSJim Jagielski import com.sun.star.frame.XModel;
41*b1cdbd2cSJim Jagielski import com.sun.star.lang.XMultiServiceFactory;
42*b1cdbd2cSJim Jagielski import com.sun.star.text.XFootnote;
43*b1cdbd2cSJim Jagielski import com.sun.star.text.XText;
44*b1cdbd2cSJim Jagielski import com.sun.star.text.XTextCursor;
45*b1cdbd2cSJim Jagielski import com.sun.star.text.XTextDocument;
46*b1cdbd2cSJim Jagielski import com.sun.star.uno.UnoRuntime;
47*b1cdbd2cSJim Jagielski import com.sun.star.uno.XInterface;
48*b1cdbd2cSJim Jagielski import com.sun.star.view.XViewSettingsSupplier;
49*b1cdbd2cSJim Jagielski 
50*b1cdbd2cSJim Jagielski public class SwAccessibleFootnoteView extends TestCase {
51*b1cdbd2cSJim Jagielski 
52*b1cdbd2cSJim Jagielski     XTextDocument xTextDoc = null;
53*b1cdbd2cSJim Jagielski 
54*b1cdbd2cSJim Jagielski     /**
55*b1cdbd2cSJim Jagielski     * Called to create an instance of <code>TestEnvironment</code>
56*b1cdbd2cSJim Jagielski     * with an object to test and related objects.
57*b1cdbd2cSJim Jagielski     * Inserts the created footnote to the document.
58*b1cdbd2cSJim Jagielski     * Changes zoom value to 10%(endnote must be in visible area of the document).
59*b1cdbd2cSJim Jagielski     * Obtains accessible object for the inserted footnote.
60*b1cdbd2cSJim Jagielski     *
61*b1cdbd2cSJim Jagielski     * @param Param test parameters
62*b1cdbd2cSJim Jagielski     * @param log writer to log information while testing
63*b1cdbd2cSJim Jagielski     *
64*b1cdbd2cSJim Jagielski     * @see TestEnvironment
65*b1cdbd2cSJim Jagielski     * @see #getTestEnvironment
66*b1cdbd2cSJim Jagielski     */
createTestEnvironment( TestParameters Param, PrintWriter log)67*b1cdbd2cSJim Jagielski     protected TestEnvironment createTestEnvironment(
68*b1cdbd2cSJim Jagielski         TestParameters Param, PrintWriter log) {
69*b1cdbd2cSJim Jagielski 
70*b1cdbd2cSJim Jagielski         XInterface oObj = null;
71*b1cdbd2cSJim Jagielski         XFootnote oFootnote = null;
72*b1cdbd2cSJim Jagielski 
73*b1cdbd2cSJim Jagielski         log.println( "Creating a test environment" );
74*b1cdbd2cSJim Jagielski         // get a soffice factory object
75*b1cdbd2cSJim Jagielski         XMultiServiceFactory msf = (XMultiServiceFactory)
76*b1cdbd2cSJim Jagielski             UnoRuntime.queryInterface(XMultiServiceFactory.class, xTextDoc);
77*b1cdbd2cSJim Jagielski         log.println("creating a footnote");
78*b1cdbd2cSJim Jagielski 
79*b1cdbd2cSJim Jagielski         try {
80*b1cdbd2cSJim Jagielski             oFootnote = (XFootnote) UnoRuntime.queryInterface(XFootnote.class,
81*b1cdbd2cSJim Jagielski                     msf.createInstance("com.sun.star.text.Footnote"));
82*b1cdbd2cSJim Jagielski         } catch (com.sun.star.uno.Exception e) {
83*b1cdbd2cSJim Jagielski             e.printStackTrace(log);
84*b1cdbd2cSJim Jagielski             throw new StatusException("Couldn't create footnote", e);
85*b1cdbd2cSJim Jagielski         }
86*b1cdbd2cSJim Jagielski 
87*b1cdbd2cSJim Jagielski         XText oText = xTextDoc.getText();
88*b1cdbd2cSJim Jagielski         XTextCursor oCursor = oText.createTextCursor();
89*b1cdbd2cSJim Jagielski 
90*b1cdbd2cSJim Jagielski         log.println("inserting the footnote into text document");
91*b1cdbd2cSJim Jagielski         try {
92*b1cdbd2cSJim Jagielski             oText.insertTextContent(oCursor, oFootnote, false);
93*b1cdbd2cSJim Jagielski         } catch (com.sun.star.lang.IllegalArgumentException e) {
94*b1cdbd2cSJim Jagielski             e.printStackTrace(log);
95*b1cdbd2cSJim Jagielski             throw new StatusException("Couldn't insert the footnote", e);
96*b1cdbd2cSJim Jagielski         }
97*b1cdbd2cSJim Jagielski 
98*b1cdbd2cSJim Jagielski         XController xController = xTextDoc.getCurrentController();
99*b1cdbd2cSJim Jagielski         XViewSettingsSupplier xViewSetSup = (XViewSettingsSupplier)
100*b1cdbd2cSJim Jagielski                 UnoRuntime.queryInterface(XViewSettingsSupplier.class,
101*b1cdbd2cSJim Jagielski                 xController);
102*b1cdbd2cSJim Jagielski         XPropertySet xPropSet = xViewSetSup.getViewSettings();
103*b1cdbd2cSJim Jagielski 
104*b1cdbd2cSJim Jagielski         try {
105*b1cdbd2cSJim Jagielski             //change zoom value to 10%
106*b1cdbd2cSJim Jagielski             //footer should be in the vissible area of the document
107*b1cdbd2cSJim Jagielski             xPropSet.setPropertyValue("ZoomValue", new Short("10"));
108*b1cdbd2cSJim Jagielski         } catch ( com.sun.star.lang.WrappedTargetException e ) {
109*b1cdbd2cSJim Jagielski             e.printStackTrace(log);
110*b1cdbd2cSJim Jagielski             throw new StatusException("Couldn't set propertyValue...", e);
111*b1cdbd2cSJim Jagielski         }  catch ( com.sun.star.lang.IllegalArgumentException e ) {
112*b1cdbd2cSJim Jagielski             e.printStackTrace(log);
113*b1cdbd2cSJim Jagielski             throw new StatusException("Couldn't set propertyValue...", e);
114*b1cdbd2cSJim Jagielski         } catch ( com.sun.star.beans.PropertyVetoException e ) {
115*b1cdbd2cSJim Jagielski             e.printStackTrace(log);
116*b1cdbd2cSJim Jagielski             throw new StatusException("Couldn't set propertyValue...", e);
117*b1cdbd2cSJim Jagielski         } catch ( com.sun.star.beans.UnknownPropertyException e ) {
118*b1cdbd2cSJim Jagielski             e.printStackTrace(log);
119*b1cdbd2cSJim Jagielski             throw new StatusException("Couldn't set propertyValue...", e);
120*b1cdbd2cSJim Jagielski         }
121*b1cdbd2cSJim Jagielski 
122*b1cdbd2cSJim Jagielski         XModel aModel = (XModel)
123*b1cdbd2cSJim Jagielski             UnoRuntime.queryInterface(XModel.class, xTextDoc);
124*b1cdbd2cSJim Jagielski 
125*b1cdbd2cSJim Jagielski         AccessibilityTools at = new AccessibilityTools();
126*b1cdbd2cSJim Jagielski 
127*b1cdbd2cSJim Jagielski         XWindow xWindow = at.getCurrentWindow((XMultiServiceFactory)Param.getMSF(), aModel);
128*b1cdbd2cSJim Jagielski         XAccessible xRoot = at.getAccessibleObject(xWindow);
129*b1cdbd2cSJim Jagielski 
130*b1cdbd2cSJim Jagielski         at.getAccessibleObjectForRole(xRoot, AccessibleRole.FOOTNOTE);
131*b1cdbd2cSJim Jagielski 
132*b1cdbd2cSJim Jagielski         oObj = AccessibilityTools.SearchedContext;
133*b1cdbd2cSJim Jagielski 
134*b1cdbd2cSJim Jagielski         log.println("ImplementationName " + utils.getImplName(oObj));
135*b1cdbd2cSJim Jagielski         at.printAccessibleTree(log, xRoot, Param.getBool(util.PropertyName.DEBUG_IS_ACTIVE));
136*b1cdbd2cSJim Jagielski 
137*b1cdbd2cSJim Jagielski         TestEnvironment tEnv = new TestEnvironment(oObj);
138*b1cdbd2cSJim Jagielski 
139*b1cdbd2cSJim Jagielski         final XPropertySet PropSet = xViewSetSup.getViewSettings();
140*b1cdbd2cSJim Jagielski 
141*b1cdbd2cSJim Jagielski         tEnv.addObjRelation("EventProducer",
142*b1cdbd2cSJim Jagielski             new ifc.accessibility._XAccessibleEventBroadcaster.EventProducer() {
143*b1cdbd2cSJim Jagielski                 public void fireEvent() {
144*b1cdbd2cSJim Jagielski                     try {
145*b1cdbd2cSJim Jagielski                         //change zoom value to 130%
146*b1cdbd2cSJim Jagielski                         PropSet.setPropertyValue("ZoomValue", new Short("15"));
147*b1cdbd2cSJim Jagielski                         //and back to 10%
148*b1cdbd2cSJim Jagielski                         PropSet.setPropertyValue("ZoomValue", new Short("10"));
149*b1cdbd2cSJim Jagielski                     } catch ( com.sun.star.lang.WrappedTargetException e ) {
150*b1cdbd2cSJim Jagielski 
151*b1cdbd2cSJim Jagielski                     }  catch ( com.sun.star.lang.IllegalArgumentException e ) {
152*b1cdbd2cSJim Jagielski 
153*b1cdbd2cSJim Jagielski                     } catch ( com.sun.star.beans.PropertyVetoException e ) {
154*b1cdbd2cSJim Jagielski 
155*b1cdbd2cSJim Jagielski                     } catch ( com.sun.star.beans.UnknownPropertyException e ) {
156*b1cdbd2cSJim Jagielski 
157*b1cdbd2cSJim Jagielski                     }
158*b1cdbd2cSJim Jagielski                 }
159*b1cdbd2cSJim Jagielski             });
160*b1cdbd2cSJim Jagielski 
161*b1cdbd2cSJim Jagielski         return tEnv;
162*b1cdbd2cSJim Jagielski 
163*b1cdbd2cSJim Jagielski     }
164*b1cdbd2cSJim Jagielski 
165*b1cdbd2cSJim Jagielski     /**
166*b1cdbd2cSJim Jagielski     * Called while disposing a <code>TestEnvironment</code>.
167*b1cdbd2cSJim Jagielski     * Disposes text document.
168*b1cdbd2cSJim Jagielski     * @param Param test parameters
169*b1cdbd2cSJim Jagielski     * @param log writer to log information while testing
170*b1cdbd2cSJim Jagielski     */
cleanup( TestParameters Param, PrintWriter log)171*b1cdbd2cSJim Jagielski     protected void cleanup( TestParameters Param, PrintWriter log) {
172*b1cdbd2cSJim Jagielski         log.println("dispose text document");
173*b1cdbd2cSJim Jagielski         util.DesktopTools.closeDoc(xTextDoc);
174*b1cdbd2cSJim Jagielski     }
175*b1cdbd2cSJim Jagielski 
176*b1cdbd2cSJim Jagielski     /**
177*b1cdbd2cSJim Jagielski      * Called while the <code>TestCase</code> initialization. In the
178*b1cdbd2cSJim Jagielski      * implementation does nothing. Subclasses can override to initialize
179*b1cdbd2cSJim Jagielski      * objects shared among all <code>TestEnvironment</code>s.
180*b1cdbd2cSJim Jagielski      *
181*b1cdbd2cSJim Jagielski      * @param Param test parameters
182*b1cdbd2cSJim Jagielski      * @param log writer to log information while testing
183*b1cdbd2cSJim Jagielski      *
184*b1cdbd2cSJim Jagielski      * @see #initializeTestCase
185*b1cdbd2cSJim Jagielski      */
initialize(TestParameters Param, PrintWriter log)186*b1cdbd2cSJim Jagielski     protected void initialize(TestParameters Param, PrintWriter log) {
187*b1cdbd2cSJim Jagielski         log.println( "creating a text document" );
188*b1cdbd2cSJim Jagielski         xTextDoc = WriterTools.createTextDoc((XMultiServiceFactory)Param.getMSF());
189*b1cdbd2cSJim Jagielski     }
190*b1cdbd2cSJim Jagielski }
191