toolkit/test/accessibility/TopWindowListener.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 import com.sun.star.awt.XExtendedToolkit;
  21 import com.sun.star.accessibility.XAccessible;
  22 import com.sun.star.accessibility.XAccessibleContext;
  23 import com.sun.star.uno.UnoRuntime;
  24
  25 /** Listen for top window events and create or delete children of the tree
  26     model accordingly.
  27 */
  28 class TopWindowListener
  29 {
  30     TopWindowListener (AccessibilityTreeModel aModel, SimpleOffice aOffice)
  31     {
  32         maModel = aModel;
  33         maOffice = aOffice;
  34     }
  35
  36
  37
  38
  39     /** Use this function to initially fill the accessibility object tree
  40         view with nodes for top level windows.
  41     */
  42     public void Initialize ()
  43     {
  44         XExtendedToolkit xToolkit = maOffice.getExtendedToolkit();
  45         if (xToolkit != null)
  46         {
  47             maModel.lock ();
  48             int nTopWindowCount = xToolkit.getTopWindowCount();
  49             MessageArea.println ("There are " + nTopWindowCount + " top windows.");
  50             for (int i=0; i<nTopWindowCount; i++)
  51             {
  52                 try
  53                 {
  54                     XAccessible xAccessible = maOffice.getAccessibleObject(
  55                         xToolkit.getTopWindow (i));
  56                     // Uncomment the following line to get the real root of
  57                     //   the accessible tree that xAccessible belongs to.
  58                     // xAccessible = maOffice.getAccessibleRoot(xAccessible);
  59                     AddTopLevelNode (xAccessible);
  60                 }
  61                 catch (Exception e)
  62                 {
  63                     System.out.println ("caught exception: " + e);
  64                     e.printStackTrace();
  65                 }
  66             }
  67             maModel.unlock ((AccessibleTreeNode)maModel.getRoot());
  68         }
  69     }
  70
  71
  72
  73     /** Add a new top level node which, to be exact, will be placed on the
  74         second layer of the tree.
  75         @param xNewTopLevelObject
  76             The accessible object of the new top level window.
  77     */
  78     private void AddTopLevelNode (XAccessible xNewTopLevelObject)
  79     {
  80         System.out.println ("adding top level window");
  81         if (xNewTopLevelObject != null)
  82         {
  83             XAccessibleContext xContext = xNewTopLevelObject.getAccessibleContext();
  84             if (xContext == null)
  85                 System.out.println ("top level window not accessible");
  86             else
  87             {
  88                 if ( ! FilterTopLevelNode (xContext))
  89                 {
  90                     Object aRootObject = maModel.getRoot();
  91                     if (aRootObject instanceof VectorNode)
  92                     {
  93                         VectorNode aRoot = (VectorNode) aRootObject;
  94                         AccessibleTreeNode aNode =
  95                             NodeFactory.Instance().createDefaultNode (xNewTopLevelObject, aRoot);
  96                         aRoot.addChild (aNode);
  97                         maModel.fireTreeNodesInserted (maModel.createEvent (aRoot, aNode));
  98                     }
  99                 }
 100             }
 101         }
 102     }
 103
 104     /** Ignore windows that have no accessible name, i.e. do not represent
 105         document windows.
 106         @return
 107             Returns <true/> when the given object should not be displayed,
 108             i.e. filtered out.
 109     */
 110     private boolean FilterTopLevelNode (XAccessibleContext xContext)
 111     {
 112         // No filtering at the moment.
 113         return false;
 114         //        return xContext.getAccessibleName().length() == 0;
 115     }
 116
 117
 118
 119
 120     /** Remove an existing top level node from the tree.
 121         @param xNewTopLevelObject
 122             The accessible object to remove.
 123     */
 124     private void RemoveTopLevelNode (XAccessible xTopLevelObject)
 125     {
 126         Object aObject = maModel.getRoot();
 127         if (aObject instanceof VectorNode && xTopLevelObject != null)
 128         {
 129             System.out.println ("removing node " + xTopLevelObject);
 130             VectorNode aRoot = (VectorNode) aObject;
 131             maModel.removeNode (xTopLevelObject.getAccessibleContext());
 132         }
 133     }
 134
 135
 136
 137
 138
 139     /**  This method exists for debugging.  It prints a list of all top
 140          level windows.
 141     */
 142     private void ShowAllTopLevelWindows ()
 143     {
 144         XExtendedToolkit xToolkit = maOffice.getExtendedToolkit();
 145         if (xToolkit != null)
 146         {
 147             int nTopWindowCount = xToolkit.getTopWindowCount();
 148             for (int i=0; i<nTopWindowCount; i++)
 149             {
 150                 try
 151                 {
 152                     System.out.println (i + " : " + xToolkit.getTopWindow (i));
 153                 }
 154                 catch (Exception e)
 155                 {
 156                     System.out.println ("caught exception; " + e);
 157                 }
 158             }
 159         }
 160     }
 161
 162
 163
 164
 165     // XTopWindowListener
 166     public void windowOpened (final com.sun.star.lang.EventObject aEvent)
 167         throws RuntimeException
 168     {
 169         if (maModel != null)
 170         {
 171             XWindow xWindow = UnoRuntime.queryInterface(
 172                 XWindow.class, aEvent.Source);
 173             if (xWindow == null)
 174                 System.out.println ("event source is no XWindow");
 175             else
 176             {
 177                 XAccessible xAccessible = maOffice.getAccessibleObject(xWindow);
 178                 if (xAccessible == null)
 179                     System.out.println ("event source is no XAccessible");
 180                 else
 181                     AddTopLevelNode (xAccessible);
 182             }
 183         }
 184     }
 185
 186
 187
 188
 189     public void windowClosed (final com.sun.star.lang.EventObject aEvent)
 190         throws RuntimeException
 191     {
 192         if (maModel != null)
 193         {
 194             XWindow xWindow = UnoRuntime.queryInterface(
 195                 XWindow.class, aEvent.Source);
 196             if (xWindow == null)
 197                 System.out.println ("event source is no XWindow");
 198             else
 199             {
 200                 XAccessible xAccessible = maOffice.getAccessibleObject(xWindow);
 201                 if (xAccessible == null)
 202                     System.out.println ("event source is no XAccessible");
 203                 else
 204                     RemoveTopLevelNode (xAccessible);
 205             }
 206         }
 207     }
 208
 209     public void disposing (final com.sun.star.lang.EventObject aEvent)
 210     {
 211         System.out.println ("Top window disposed: " + aEvent);
 212     }
 213
 214
 215
 216
 217     private AccessibilityTreeModel
 218         maModel;
 219     private SimpleOffice
 220         maOffice;
 221 }