toolkit/test/accessibility/AccessibilityWorkBench.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.frame.XFrame;
  20 import com.sun.star.frame.XTerminateListener;
  21 import com.sun.star.uno.UnoRuntime;
  22
  23 import com.sun.star.accessibility.XAccessibleContext;
  24 import com.sun.star.awt.XExtendedToolkit;
  25
  26 import java.awt.*;
  27 import java.awt.event.*;
  28 import javax.swing.*;
  29 import javax.swing.tree.*;
  30 import javax.swing.event.TreeSelectionListener;
  31 import javax.swing.event.TreeSelectionEvent;
  32 import ov.ObjectViewContainer;
  33
  34 /** This class manages the GUI of the work bench.
  35     @see AccessibilityTreeModel
  36         for the implementation of the tree view on the left side which also
  37         manages the registration of accessibility listeners.
  38     @see Canvas
  39         for the graphical view of the accessible objects.
  40 */
  41 public class AccessibilityWorkBench
  42     extends JFrame
  43     implements ActionListener, XTerminateListener, TreeSelectionListener
  44
  45 {
  46     private static final String msVersion = "v1.7.2";
  47     private String msOptionsFileName = ".AWBrc";
  48
  49     public static void main (String args[])
  50     {
  51         int nPortNumber = 5678;
  52
  53         for (int i=0; i<args.length; i++)
  54         {
  55             if (args[i].equals ("-h") || args[i].equals ("--help") || args[i].equals ("-?"))
  56             {
  57                 System.out.println ("usage: AccessibilityWorkBench <option>*");
  58                 System.out.println ("options:");
  59                 System.out.println ("   -p <port-number>   Port on which to connect to StarOffice.");
  60                 System.out.println ("                      Defaults to 5678.");
  61                 System.exit (0);
  62             }
  63             else if (args[i].equals ("-p"))
  64             {
  65                 nPortNumber = Integer.parseInt (args[++i]);
  66             }
  67         }
  68
  69         saWorkBench = new AccessibilityWorkBench (nPortNumber);
  70     }
  71
  72
  73
  74
  75     /** Return the one instance of the AccessibilityWorkBench
  76         @return
  77             Returns null when the AccessibilityWorkBench could not be
  78             created successfully.
  79     */
  80     public static AccessibilityWorkBench Instance ()
  81     {
  82         return saWorkBench;
  83     }
  84
  85
  86
  87     /** Create an accessibility work bench that listens at the specified
  88         port to Office applications.
  89     */
  90     private AccessibilityWorkBench (int nPortNumber)
  91     {
  92         mbInitialized = false;
  93
  94         Layout ();
  95
  96         MessageArea.println (System.getProperty ("os.name") + " / "
  97             + System.getProperty ("os.arch") + " / "
  98             + System.getProperty ("os.version"));
  99         MessageArea.println ("Using port " + nPortNumber);
 100         office = new SimpleOffice (nPortNumber);
 101
 102         maAccessibilityTree.getComponent().addTreeSelectionListener (this);
 103
 104         addWindowListener (new WindowAdapter ()
 105             { @Override
 106             public void windowClosing (WindowEvent e)
 107                   { System.exit(0); }
 108             });
 109
 110         initialize ();
 111     }
 112
 113
 114
 115
 116     /** Create and arrange the widgets of the GUI.
 117     */
 118     private void Layout  ()
 119     {
 120         setSize (new Dimension (8000,600));
 121
 122         // Create new layout.
 123         GridBagLayout aLayout = new GridBagLayout ();
 124         getContentPane().setLayout (aLayout);
 125
 126         //  Accessible Tree.
 127         maAccessibilityTree = new AccessibilityTree ();
 128         JScrollPane aTreeScrollPane = new JScrollPane(
 129             maAccessibilityTree.getComponent(),
 130             JScrollPane.VERTICAL_SCROLLBAR_ALWAYS,
 131             JScrollPane.HORIZONTAL_SCROLLBAR_ALWAYS);
 132         aTreeScrollPane.setPreferredSize (new Dimension (400,300));
 133
 134         // Object view shows details about the currently selected accessible
 135         // object.
 136         maObjectViewContainer = new ObjectViewContainer ();
 137         JScrollPane aObjectViewContainerScrollPane = new JScrollPane(
 138             maObjectViewContainer,
 139             JScrollPane.VERTICAL_SCROLLBAR_AS_NEEDED,
 140             JScrollPane.HORIZONTAL_SCROLLBAR_AS_NEEDED);
 141         aObjectViewContainerScrollPane.setPreferredSize (new Dimension (400,300));
 142
 143         // Split pane for tree view and object view.
 144         JSplitPane aLeftViewSplitPane = new JSplitPane (
 145             JSplitPane.VERTICAL_SPLIT,
 146             aTreeScrollPane,
 147             aObjectViewContainerScrollPane
 148             );
 149         aLeftViewSplitPane.setDividerLocation (300);
 150
 151         //  Canvas.
 152         maCanvas = new Canvas ();
 153         maCanvas.setTree (maAccessibilityTree.getComponent());
 154         maAccessibilityTree.SetCanvas (maCanvas);
 155         JScrollPane aScrolledCanvas = new JScrollPane(maCanvas,
 156             JScrollPane.VERTICAL_SCROLLBAR_AS_NEEDED,
 157             JScrollPane.HORIZONTAL_SCROLLBAR_AS_NEEDED);
 158         aScrolledCanvas.getViewport().setBackground (Color.RED);
 159         aScrolledCanvas.setPreferredSize (new Dimension(600,400));
 160
 161         // Split pane for tree view and canvas.
 162         JSplitPane aViewSplitPane = new JSplitPane (
 163             JSplitPane.HORIZONTAL_SPLIT,
 164             aLeftViewSplitPane,
 165             aScrolledCanvas
 166             );
 167         aViewSplitPane.setOneTouchExpandable(true);
 168         aViewSplitPane.setDividerLocation (400);
 169
 170         //  Text output area.
 171         MessageArea aMessageArea = MessageArea.Instance ();
 172
 173         // Split pane for the two views and the message area.
 174         JSplitPane aSplitPane = new JSplitPane (JSplitPane.VERTICAL_SPLIT,
 175             aViewSplitPane, aMessageArea);
 176         aSplitPane.setOneTouchExpandable(true);
 177         addGridElement (aViewSplitPane, 0,0, 2,1, 3,3,
 178             GridBagConstraints.CENTER, GridBagConstraints.BOTH);
 179
 180         // Button bar.
 181         maButtonBar = new JPanel();
 182         maButtonBar.setLayout (new FlowLayout());
 183         addGridElement (maButtonBar, 0,3, 2,1, 1,0,
 184             GridBagConstraints.WEST, GridBagConstraints.HORIZONTAL);
 185
 186         //  Buttons.
 187         aConnectButton = createButton ("Connect", "connect");
 188         aUpdateButton = createButton ("Update", "update");
 189         aShapesButton = createButton ("Expand Shapes", "shapes");
 190         aExpandButton = createButton ("Expand All", "expand");
 191         aQuitButton = createButton ("Quit", "quit");
 192         UpdateButtonStates ();
 193
 194         Options.Instance().Load (msOptionsFileName);
 195
 196         setJMenuBar (CreateMenuBar ());
 197
 198         setTitle("Accessibility Workbench " + msVersion);
 199
 200         pack ();
 201         setVisible (true);
 202         validate ();
 203         repaint();
 204     }
 205
 206
 207
 208
 209     /** Shortcut method for adding an object to a GridBagLayout.
 210     */
 211     private void addGridElement (JComponent object,
 212         int x, int y, int width, int height, int weightx, int weighty,
 213         int anchor, int fill)
 214     {
 215         GridBagConstraints constraints = new GridBagConstraints ();
 216         constraints.gridx = x;
 217         constraints.gridy = y;
 218         constraints.gridwidth = width;
 219         constraints.gridheight = height;
 220         constraints.weightx = weightx;
 221         constraints.weighty = weighty;
 222         constraints.anchor = anchor;
 223         constraints.fill = fill;
 224         getContentPane().add (object, constraints);
 225     }
 226
 227
 228
 229
 230     /** Create a new button and place at the right most position into the
 231         button bar.
 232     */
 233     private JButton createButton (String title, String command)
 234     {
 235         JButton aButton = new JButton (title);
 236         aButton.setEnabled (false);
 237         aButton.setActionCommand (command);
 238         aButton.addActionListener (this);
 239
 240         maButtonBar.add (aButton);
 241         return aButton;
 242     }
 243
 244
 245
 246
 247     /** Create a menu bar for the application.
 248         @return
 249             Returns the new menu bar.  The returned reference is also
 250             remembered in the data member <member>maMenuBar</member>.
 251     */
 252     private JMenuBar CreateMenuBar ()
 253     {
 254         // Menu bar.
 255         JMenuBar aMenuBar = new JMenuBar ();
 256
 257         // File menu.
 258         JMenu aFileMenu = new JMenu ("File");
 259         aMenuBar.add (aFileMenu);
 260         JMenuItem aItem;
 261         aItem = new JMenuItem ("Quit");
 262         aFileMenu.add (aItem);
 263         aItem.addActionListener (this);
 264
 265         // View menu.
 266         JMenu aViewMenu = new JMenu ("View");
 267         aMenuBar.add (aViewMenu);
 268         ButtonGroup aGroup = new ButtonGroup ();
 269         JRadioButtonMenuItem aRadioButton = new JRadioButtonMenuItem ("Whole Screen");
 270         aGroup.add (aRadioButton);
 271         aViewMenu.add (aRadioButton);
 272         aRadioButton.addActionListener (this);
 273         aRadioButton = new JRadioButtonMenuItem ("200%");
 274         aGroup.add (aRadioButton);
 275         aViewMenu.add (aRadioButton);
 276         aRadioButton.addActionListener (this);
 277         aRadioButton = new JRadioButtonMenuItem ("100%");
 278         aGroup.add (aRadioButton);
 279         aViewMenu.add (aRadioButton);
 280         aRadioButton.addActionListener (this);
 281         aRadioButton = new JRadioButtonMenuItem ("50%");
 282         aGroup.add (aRadioButton);
 283         aViewMenu.add (aRadioButton);
 284         aRadioButton.addActionListener (this);
 285         aRadioButton = new JRadioButtonMenuItem ("25%");
 286         aGroup.add (aRadioButton);
 287         aViewMenu.add (aRadioButton);
 288         aRadioButton.addActionListener (this);
 289         aRadioButton = new JRadioButtonMenuItem ("10%");
 290         aGroup.add (aRadioButton);
 291         aViewMenu.add (aRadioButton);
 292         aRadioButton.addActionListener (this);
 293
 294         // Options menu.
 295         JMenu aOptionsMenu = new JMenu ("Options");
 296         aMenuBar.add (aOptionsMenu);
 297         JCheckBoxMenuItem aCBItem;
 298         aCBItem = new JCheckBoxMenuItem ("Show Descriptions", maCanvas.getShowDescriptions());
 299         aOptionsMenu.add (aCBItem);
 300         aCBItem.addActionListener (this);
 301
 302         aCBItem = new JCheckBoxMenuItem ("Show Names", maCanvas.getShowNames());
 303         aOptionsMenu.add (aCBItem);
 304         aCBItem.addActionListener (this);
 305
 306         aCBItem = new JCheckBoxMenuItem ("Show Text", maCanvas.getShowText());
 307         aOptionsMenu.add (aCBItem);
 308         aCBItem.addActionListener (this);
 309
 310         aCBItem = new JCheckBoxMenuItem ("Antialiased Rendering", maCanvas.getAntialiasing());
 311         aOptionsMenu.add (aCBItem);
 312         aCBItem.addActionListener (this);
 313
 314         // Help menu.
 315         JMenu aHelpMenu = new JMenu ("Help");
 316         aMenuBar.add (aHelpMenu);
 317
 318         aItem = new JMenuItem ("Help");
 319         aHelpMenu.add (aItem);
 320         aItem.addActionListener (this);
 321
 322         aItem = new JMenuItem ("News");
 323         aHelpMenu.add (aItem);
 324         aItem.addActionListener (this);
 325
 326         aItem = new JMenuItem ("About");
 327         aHelpMenu.add (aItem);
 328         aItem.addActionListener (this);
 329
 330         return aMenuBar;
 331     }
 332
 333
 334
 335
 336     /** Initialize the AWB.  This includes clearing the canvas, add
 337         listeners, creation of a new tree model for the tree list box and
 338         the update of the button states.
 339
 340         This method may be called any number of times.  Note that all
 341         actions will be carried out every time.  The main purpose of a
 342         second call is that of a re-initialization after a reconnect.
 343     */
 344     private void initialize ()
 345     {
 346         maCanvas.clear();
 347
 348         AccessibilityTreeModel aModel = null;
 349         aModel = new AccessibilityTreeModel (createTreeModelRoot());
 350
 351         aModel.setCanvas (maCanvas);
 352         maAccessibilityTree.getComponent().setModel (aModel);
 353
 354         if (office != null)
 355         {
 356             // Add terminate listener.
 357             if (office.getDesktop() != null)
 358                 office.getDesktop().addTerminateListener (this);
 359
 360             XExtendedToolkit xToolkit = office.getExtendedToolkit();
 361             // Remove old top window listener.
 362             if (maTopWindowListener != null)
 363                 xToolkit.removeTopWindowListener (maQueuedTopWindowListener);
 364             // Add top window listener.
 365             if (xToolkit != null)
 366             {
 367                 MessageArea.println ("registering at extended toolkit");
 368                 maTopWindowListener = new TopWindowListener (aModel, office);
 369                 maQueuedTopWindowListener = new QueuedTopWindowListener (maTopWindowListener);
 370                 xToolkit.addTopWindowListener (maQueuedTopWindowListener);
 371                 maTopWindowListener.Initialize ();
 372             }
 373             else
 374                 maTopWindowListener = null;
 375         }
 376
 377         mbInitialized = true;
 378         UpdateButtonStates ();
 379     }
 380
 381
 382
 383
 384     /** Update the states of the buttons according to the internal state of
 385         the AWB.
 386     */
 387     private void UpdateButtonStates ()
 388     {
 389         aConnectButton.setEnabled (mbInitialized);
 390         aQuitButton.setEnabled (mbInitialized);
 391         aUpdateButton.setEnabled (mbInitialized);
 392         aExpandButton.setEnabled (mbInitialized);
 393         aShapesButton.setEnabled (mbInitialized);
 394     }
 395
 396
 397
 398     /** Callback for GUI actions from the buttons.
 399     */
 400     public void actionPerformed (java.awt.event.ActionEvent e)
 401     {
 402         if (e.getActionCommand().equals("connect"))
 403         {
 404             office.connect();
 405             initialize ();
 406         }
 407         else if (e.getActionCommand().equals("quit"))
 408         {
 409             AccessibilityTreeModel aModel = (AccessibilityTreeModel)maAccessibilityTree.getComponent().getModel();
 410             aModel.clear();
 411             System.exit (0);
 412         }
 413         else if (e.getActionCommand().equals("update"))
 414         {
 415             initialize ();
 416         }
 417         else if (e.getActionCommand().equals("shapes"))
 418         {
 419             Cursor aCursor = getCursor();
 420             setCursor (new Cursor (Cursor.WAIT_CURSOR));
 421             maAccessibilityTree.expandShapes();
 422             setCursor (aCursor);
 423         }
 424         else if (e.getActionCommand().equals("expand"))
 425         {
 426             Cursor aCursor = getCursor();
 427             setCursor (new Cursor (Cursor.WAIT_CURSOR));
 428             maAccessibilityTree.expandAll();
 429             setCursor (aCursor);
 430         }
 431         else if (e.getActionCommand().equals ("Quit"))
 432         {
 433             System.out.println ("exiting");
 434             System.exit (0);
 435         }
 436         else if (e.getActionCommand().equals ("Show Descriptions"))
 437         {
 438             maCanvas.setShowDescriptions ( ! maCanvas.getShowDescriptions());
 439             Options.Instance().Save (msOptionsFileName);
 440         }
 441         else if (e.getActionCommand().equals ("Show Names"))
 442         {
 443             maCanvas.setShowNames ( ! maCanvas.getShowNames());
 444             Options.Instance().Save (msOptionsFileName);
 445         }
 446         else if (e.getActionCommand().equals ("Antialiased Rendering"))
 447         {
 448             maCanvas.setAntialiasing ( ! maCanvas.getAntialiasing());
 449             Options.Instance().Save (msOptionsFileName);
 450         }
 451         else if (e.getActionCommand().equals ("Help"))
 452         {
 453             HelpWindow.Instance().loadFile ("help.html");
 454         }
 455         else if (e.getActionCommand().equals ("News"))
 456         {
 457             try{
 458                 HelpWindow.Instance().loadFile ("news.html");
 459             } catch (Exception ex) {}
 460         }
 461         else if (e.getActionCommand().equals ("About"))
 462         {
 463             HelpWindow.Instance().loadFile ("about.html");
 464         }
 465         else if (e.getActionCommand().equals ("Whole Screen"))
 466         {
 467             maCanvas.setZoomMode (Canvas.WHOLE_SCREEN);
 468             Options.Instance().Save (msOptionsFileName);
 469         }
 470         else if (e.getActionCommand().equals ("200%"))
 471         {
 472             maCanvas.setZoomMode (200);
 473             Options.Instance().Save (msOptionsFileName);
 474         }
 475         else if (e.getActionCommand().equals ("100%"))
 476         {
 477             maCanvas.setZoomMode (100);
 478             Options.Instance().Save (msOptionsFileName);
 479         }
 480         else if (e.getActionCommand().equals ("50%"))
 481         {
 482             maCanvas.setZoomMode (50);
 483             Options.Instance().Save (msOptionsFileName);
 484         }
 485         else if (e.getActionCommand().equals ("25%"))
 486         {
 487             maCanvas.setZoomMode (25);
 488             Options.Instance().Save (msOptionsFileName);
 489         }
 490         else if (e.getActionCommand().equals ("10%"))
 491         {
 492             maCanvas.setZoomMode (10);
 493             Options.Instance().Save (msOptionsFileName);
 494         }
 495         else
 496         {
 497             System.err.println("unknown command " + e.getActionCommand());
 498         }
 499     }
 500
 501
 502
 503
 504     /** Create an AccessibilityTreeModel root which contains the documents
 505         (top windows) that are present at the moment.
 506     */
 507     private AccessibleTreeNode createTreeModelRoot()
 508     {
 509         // create root node
 510         VectorNode aRoot = new VectorNode ("Accessibility Tree", null);
 511         if (maTopWindowListener != null)
 512             maTopWindowListener.Initialize ();
 513         return aRoot;
 514     }
 515
 516
 517     // TreeSelectionListener
 518     public void valueChanged (TreeSelectionEvent aEvent)
 519     {
 520         TreePath aPath = aEvent.getPath();
 521         Object aObject = aPath.getLastPathComponent();
 522         if (aObject instanceof AccTreeNode)
 523         {
 524             AccTreeNode aNode = (AccTreeNode) aObject;
 525             XAccessibleContext xContext = aNode.getContext();
 526             maObjectViewContainer.SetObject (xContext);
 527         }
 528     }
 529
 530
 531
 532
 533     // XEventListener
 534     public void disposing( com.sun.star.lang.EventObject aSourceObj )
 535     {
 536         XFrame xFrame = UnoRuntime.queryInterface(XFrame.class, aSourceObj.Source);
 537
 538         if( xFrame != null )
 539             System.out.println("frame disposed");
 540         else
 541             System.out.println("controller disposed");
 542     }
 543
 544
 545
 546
 547     // XTerminateListener
 548     public void queryTermination (final com.sun.star.lang.EventObject aEvent) throws RuntimeException
 549     {
 550         System.out.println ("Terminate Event : " + aEvent);
 551     }
 552
 553
 554
 555
 556     // XTerminateListener
 557     public void notifyTermination (final com.sun.star.lang.EventObject aEvent) throws RuntimeException
 558     {
 559         System.out.println ("Notify Termination Event : " + aEvent);
 560     }
 561
 562
 563
 564     /// The Singleton Workbench object.
 565     private static AccessibilityWorkBench
 566         saWorkBench = null;
 567
 568     private SimpleOffice
 569         office;
 570
 571     private JPanel
 572         maButtonBar;
 573     private Canvas
 574         maCanvas;
 575     private AccessibilityTree
 576         maAccessibilityTree;
 577     private ObjectViewContainer
 578         maObjectViewContainer;
 579     private JButton
 580         aConnectButton,
 581         aQuitButton,
 582         aUpdateButton,
 583         aExpandButton,
 584         aShapesButton;
 585     private boolean
 586         mbInitialized;
 587     private TopWindowListener
 588         maTopWindowListener;
 589     private QueuedTopWindowListener
 590         maQueuedTopWindowListener;
 591 }