toolkit/test/accessibility/SimpleOffice.java

   1 /*
   2  * This file is part of the LibreOffice project.
   3  *
   4  * This Source Code Form is subject to the terms of the Mozilla Public
   5  * License, v. 2.0. If a copy of the MPL was not distributed with this
   6  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   7  *
   8  * This file incorporates work covered by the following license notice:
   9  *
  10  *   Licensed to the Apache Software Foundation (ASF) under one or more
  11  *   contributor license agreements. See the NOTICE file distributed
  12  *   with this work for additional information regarding copyright
  13  *   ownership. The ASF licenses this file to you under the Apache
  14  *   License, Version 2.0 (the "License"); you may not use this file
  15  *   except in compliance with the License. You may obtain a copy of
  16  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  17  */
  18
  19 import com.sun.star.awt.XWindow;
  20
  21 import com.sun.star.beans.PropertyValue;
  22 import com.sun.star.container.XIndexAccess;
  23 import com.sun.star.container.XEnumerationAccess;
  24 import com.sun.star.container.XEnumeration;
  25
  26 import com.sun.star.frame.XComponentLoader;
  27 import com.sun.star.frame.XController;
  28 import com.sun.star.frame.XDesktop;
  29 import com.sun.star.frame.XFrame;
  30 import com.sun.star.frame.XModel;
  31 import com.sun.star.frame.XTasksSupplier;
  32 import com.sun.star.frame.XTask;
  33
  34 import com.sun.star.lang.XComponent;
  35 import com.sun.star.lang.XMultiServiceFactory;
  36 import com.sun.star.uno.UnoRuntime;
  37 import com.sun.star.uno.XInterface;
  38 import com.sun.star.drawing.XDrawView;
  39 import com.sun.star.drawing.XDrawPage;
  40 import com.sun.star.drawing.XShape;
  41 import com.sun.star.accessibility.XAccessible;
  42 import com.sun.star.accessibility.XAccessibleContext;
  43 import com.sun.star.awt.XExtendedToolkit;
  44
  45
  46 /** This class tries to simplify some tasks like loading a document or
  47     getting various objects.
  48 */
  49 public class SimpleOffice
  50 {
  51     XDesktop mxDesktop = null;
  52     OfficeConnection aConnection;
  53     int mnPortNumber;
  54
  55     public SimpleOffice (int nPortNumber)
  56     {
  57         mnPortNumber = nPortNumber;
  58         connect ();
  59         getDesktop ();
  60     }
  61
  62     public void connect ()
  63     {
  64         aConnection = new OfficeConnection (mnPortNumber);
  65         mxDesktop = null;
  66         getDesktop ();
  67     }
  68
  69     public XModel loadDocument (String URL)
  70     {
  71         XModel xModel = null;
  72         try
  73         {
  74             //  Load the document from the specified URL.
  75             XComponentLoader xLoader =
  76                 UnoRuntime.queryInterface(
  77                 XComponentLoader.class, mxDesktop);
  78
  79             XComponent xComponent = xLoader.loadComponentFromURL (
  80                 URL,
  81                 "_blank",
  82                 0,
  83                 new PropertyValue[0]
  84                 );
  85
  86             xModel = UnoRuntime.queryInterface(
  87                 XModel.class, xComponent);
  88         }
  89         catch (java.lang.NullPointerException e)
  90         {
  91             MessageArea.println ("caught exception while loading "
  92                 + URL + " : " + e);
  93         }
  94         catch (Exception e)
  95         {
  96             MessageArea.println ("caught exception while loading "
  97                 + URL + " : " + e);
  98         }
  99         return xModel;
 100     }
 101
 102
 103
 104
 105     public XModel getModel (String name)
 106     {
 107         XModel xModel = null;
 108         try
 109         {
 110             XTasksSupplier xTasksSupplier =
 111                 UnoRuntime.queryInterface(
 112                 XTasksSupplier.class, mxDesktop);
 113             XEnumerationAccess xEA = xTasksSupplier.getTasks();
 114             XEnumeration xE = xEA.createEnumeration();
 115             while (xE.hasMoreElements())
 116             {
 117                 XTask xTask = UnoRuntime.queryInterface(
 118                     XTask.class, xE.nextElement());
 119                 MessageArea.print (xTask.getName());
 120             }
 121         }
 122         catch (Exception e)
 123         {
 124             MessageArea.println ("caught exception while getting Model " + name
 125                 + ": " + e);
 126         }
 127         return xModel;
 128     }
 129
 130
 131     public XModel getModel (XDrawView xView)
 132     {
 133         XController xController = UnoRuntime.queryInterface(
 134             XController.class, xView);
 135         if (xController != null)
 136             return xController.getModel();
 137         else
 138         {
 139             MessageArea.println ("can't cast view to controller");
 140             return null;
 141         }
 142     }
 143
 144     public  XDesktop getDesktop ()
 145     {
 146         if (mxDesktop != null)
 147             return mxDesktop;
 148         try
 149         {
 150             //  Get the factory of the connected office.
 151             XMultiServiceFactory xMSF = aConnection.getServiceManager ();
 152             if (xMSF == null)
 153             {
 154                 MessageArea.println ("can't connect to office");
 155                 return null;
 156             }
 157             else
 158                 MessageArea.println ("Connected successfully.");
 159
 160             //  Create a new desktop.
 161             mxDesktop = UnoRuntime.queryInterface(
 162                 XDesktop.class,
 163                 xMSF.createInstance ("com.sun.star.frame.Desktop")
 164                 );
 165         }
 166         catch (Exception e)
 167         {
 168             MessageArea.println ("caught exception while creating desktop: "
 169                 + e);
 170         }
 171
 172         return mxDesktop;
 173     }
 174
 175
 176     /** Return a reference to the extended toolkit which is a broadcaster of
 177         top window, key, and focus events.
 178     */
 179     public XExtendedToolkit getExtendedToolkit ()
 180     {
 181         XExtendedToolkit xToolkit = null;
 182         try
 183         {
 184             //  Get the factory of the connected office.
 185             XMultiServiceFactory xMSF = aConnection.getServiceManager ();
 186             if (xMSF != null)
 187             {
 188                 xToolkit = UnoRuntime.queryInterface(
 189                     XExtendedToolkit.class,
 190                     xMSF.createInstance ("stardiv.Toolkit.VCLXToolkit")
 191                     );
 192             }
 193         }
 194         catch (Exception e)
 195         {
 196             MessageArea.println ("caught exception while creating extended toolkit: " + e);
 197         }
 198
 199         return xToolkit;
 200     }
 201
 202
 203
 204     public XAccessible getAccessibleObject (XInterface xObject)
 205     {
 206         XAccessible xAccessible = null;
 207         try
 208         {
 209             xAccessible = UnoRuntime.queryInterface(
 210                 XAccessible.class, xObject);
 211         }
 212         catch (Exception e)
 213         {
 214             MessageArea.println (
 215                 "caught exception while getting accessible object" + e);
 216             e.printStackTrace();
 217         }
 218         return xAccessible;
 219     }
 220
 221     /** Return the root object of the accessibility hierarchy.
 222     */
 223     public XAccessible getAccessibleRoot (XAccessible xAccessible)
 224     {
 225         try
 226         {
 227             XAccessible xParent = null;
 228             do
 229             {
 230                 XAccessibleContext xContext = xAccessible.getAccessibleContext();
 231                 if (xContext != null)
 232                     xParent = xContext.getAccessibleParent();
 233                 if (xParent != null)
 234                     xAccessible = xParent;
 235             }
 236             while (xParent != null);
 237         }
 238         catch (Exception e)
 239         {
 240             MessageArea.println (
 241                 "caught exception while getting accessible root" + e);
 242             e.printStackTrace();
 243         }
 244         return xAccessible;
 245     }
 246
 247
 248
 249
 250     /** @descr Return the current window associated with the given
 251                 model.
 252     */
 253     public XWindow getCurrentWindow ()
 254     {
 255         return getCurrentWindow (UnoRuntime.queryInterface(
 256                 XModel.class, getDesktop()));
 257     }
 258
 259
 260
 261
 262
 263     public XWindow getCurrentWindow (XModel xModel)
 264     {
 265         XWindow xWindow = null;
 266         try
 267         {
 268             if (xModel == null)
 269                 MessageArea.println ("invalid model (==null)");
 270             XController xController = xModel.getCurrentController();
 271             if (xController == null)
 272                 MessageArea.println ("can't get controller from model");
 273             XFrame xFrame = xController.getFrame();
 274             if (xFrame == null)
 275                 MessageArea.println ("can't get frame from controller");
 276             xWindow = xFrame.getComponentWindow ();
 277             if (xWindow == null)
 278                 MessageArea.println ("can't get window from frame");
 279         }
 280         catch (Exception e)
 281         {
 282             MessageArea.println ("caught exception while getting current window" + e);
 283         }
 284
 285         return xWindow;
 286     }
 287
 288
 289     /** @descr Return the current draw page of the given desktop.
 290     */
 291     public XDrawPage getCurrentDrawPage ()
 292     {
 293         return getCurrentDrawPage (UnoRuntime.queryInterface(
 294                 XDrawView.class, getCurrentView()));
 295     }
 296
 297
 298
 299
 300     public XDrawPage getCurrentDrawPage (XDrawView xView)
 301     {
 302         XDrawPage xPage = null;
 303         try
 304         {
 305             if (xView == null)
 306                 MessageArea.println ("can't get current draw page from null view");
 307             else
 308                 xPage = xView.getCurrentPage();
 309         }
 310         catch (Exception e)
 311         {
 312             MessageArea.println ("caught exception while getting current draw page : " + e);
 313         }
 314
 315         return xPage;
 316     }
 317
 318
 319
 320
 321     /** @descr Return the current view of the given desktop.
 322     */
 323     public XDrawView getCurrentView ()
 324     {
 325         return getCurrentView (getDesktop());
 326     }
 327
 328     public XDrawView getCurrentView (XDesktop xDesktop)
 329     {
 330         if (xDesktop == null)
 331             MessageArea.println ("can't get desktop to retrieve current view");
 332
 333         XDrawView xView = null;
 334         try
 335         {
 336             XComponent xComponent = xDesktop.getCurrentComponent();
 337             if (xComponent == null)
 338                 MessageArea.println ("can't get component to retrieve current view");
 339
 340             XFrame xFrame = xDesktop.getCurrentFrame();
 341             if (xFrame == null)
 342                 MessageArea.println ("can't get frame to retrieve current view");
 343
 344             XController xController = xFrame.getController();
 345             if (xController == null)
 346                 MessageArea.println ("can't get controller to retrieve current view");
 347
 348             xView = UnoRuntime.queryInterface(
 349                 XDrawView.class, xController);
 350             if (xView == null)
 351                 MessageArea.println ("could not cast controller into view");
 352         }
 353         catch (Exception e)
 354         {
 355             MessageArea.println ("caught exception while getting current view : " + e);
 356         }
 357
 358         return xView;
 359     }
 360
 361
 362
 363
 364     //  Return the accessible object of the document window.
 365     public static XAccessible getAccessibleDocumentWindow (XDrawPage xPage)
 366     {
 367         XIndexAccess xShapeList = UnoRuntime.queryInterface(
 368             XIndexAccess.class, xPage);
 369         if (xShapeList.getCount() > 0)
 370         {
 371             // All shapes return as accessible object the document window's
 372             // accessible object.  This is, of course, a hack and will be
 373             // removed as soon as the missing infrastructure for obtaining
 374             // the object directly is implemented.
 375             XShape xShape = null;
 376             try{
 377                 xShape = UnoRuntime.queryInterface(
 378                     XShape.class, xShapeList.getByIndex (0));
 379             } catch (Exception e)
 380             {}
 381             XAccessible xAccessible = UnoRuntime.queryInterface (
 382                 XAccessible.class, xShape);
 383             return xAccessible;
 384         }
 385         else
 386             return null;
 387     }
 388 }