odk/examples/DevelopersGuide/Accessibility/TextualDisplay.java

   1 /*************************************************************************
   2  *
   3  *  $RCSfile: TextualDisplay.java,v $
   4  *
   5  *  $Revision: 1.3 $
   6  *
   7  *  last change: $Author: hr $ $Date: 2003-06-30 15:07:53 $
   8  *
   9  *  The Contents of this file are made available subject to the terms of
  10  *  the BSD license.
  11  *
  12  *  Copyright (c) 2003 by Sun Microsystems, Inc.
  13  *  All rights reserved.
  14  *
  15  *  Redistribution and use in source and binary forms, with or without
  16  *  modification, are permitted provided that the following conditions
  17  *  are met:
  18  *  1. Redistributions of source code must retain the above copyright
  19  *     notice, this list of conditions and the following disclaimer.
  20  *  2. Redistributions in binary form must reproduce the above copyright
  21  *     notice, this list of conditions and the following disclaimer in the
  22  *     documentation and/or other materials provided with the distribution.
  23  *  3. Neither the name of Sun Microsystems, Inc. nor the names of its
  24  *     contributors may be used to endorse or promote products derived
  25  *     from this software without specific prior written permission.
  26  *
  27  *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  28  *  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  29  *  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  30  *  FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
  31  *  COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
  32  *  INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
  33  *  BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
  34  *  OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  35  *  ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
  36  *  TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
  37  *  USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  38  *
  39  *************************************************************************/
  40
  41 import java.awt.Color;
  42 import java.awt.Font;
  43 import java.awt.Dimension;
  44 import javax.swing.JTextArea;
  45 import javax.swing.JScrollPane;
  46 import java.util.Vector;
  47
  48 import com.sun.star.accessibility.XAccessible;
  49 import com.sun.star.accessibility.XAccessibleContext;
  50 import com.sun.star.accessibility.XAccessibleComponent;
  51 import com.sun.star.accessibility.XAccessibleStateSet;
  52
  53 import com.sun.star.uno.AnyConverter;
  54 import com.sun.star.uno.UnoRuntime;
  55
  56 import com.sun.star.awt.Point;
  57 import com.sun.star.awt.Size;
  58
  59 /** Display textual information for a given accessible object.  This
  60     includes the names of that object of its ancestors as well as some
  61     information retrieved from the XAccessibleContext and
  62     XAccessibleComponent interfaces.
  63 */
  64 class TextualDisplay
  65     extends JScrollPane
  66     implements IAccessibleObjectDisplay
  67 {
  68     /** Create a new scroll pane that contains a text widget which display
  69         information about given accessible objects.
  70     */
  71     public TextualDisplay ()
  72     {
  73         // Create a text widget for displaying the text information...
  74         maText = new JTextArea (80,10);
  75         maText.setBackground (new Color (250,240,230));
  76         maText.setFont (new Font ("Courier", Font.PLAIN, 11));
  77
  78         // ...and set-up the scroll pane to show this widget.
  79         setViewportView (maText);
  80         setVerticalScrollBarPolicy (JScrollPane.VERTICAL_SCROLLBAR_ALWAYS);
  81         setHorizontalScrollBarPolicy (JScrollPane.HORIZONTAL_SCROLLBAR_ALWAYS);
  82     }
  83
  84
  85
  86
  87     /** Set the accessible object to display.  Call this method e.g. when a
  88         new object has been focused.
  89     */
  90     public synchronized void setAccessibleObject (XAccessibleContext xContext)
  91     {
  92         // First clear the display area.
  93         msTextContent = new String ();
  94
  95         if (xContext != null)
  96         {
  97             String sIndentation = showParents (xContext);
  98             showContextInfo (xContext, sIndentation);
  99             showComponentInfo (xContext, sIndentation);
 100         }
 101
 102         maText.setText (msTextContent);
 103     }
 104
 105
 106
 107
 108     public synchronized void updateAccessibleObject (XAccessibleContext xContext)
 109     {
 110         setAccessibleObject (xContext);
 111     }
 112
 113
 114
 115     /** Show some of the information available over the given object's
 116         XAccessibleContext interface.
 117     */
 118     private void showContextInfo (XAccessibleContext xContext, String sIndentation)
 119     {
 120         // Show the description.
 121         msTextContent += sIndentation + "Description: "
 122             + xContext.getAccessibleDescription() + "\n";
 123
 124         showStates (xContext, sIndentation);
 125     }
 126
 127
 128
 129
 130     /** Show a list of all of the the given object's states.  Use the
 131         NameConverter class to transform the numerical state ids into human
 132         readable names.
 133         @param xContext
 134             The accessible context for which to show the state names.
 135     */
 136     private void showStates (XAccessibleContext xContext, String sIndentation)
 137     {
 138         // Get the state set object...
 139         XAccessibleStateSet xStateSet = xContext.getAccessibleStateSet();
 140         // ...and retrieve an array of numerical ids.
 141         short aStates[] = xStateSet.getStates();
 142
 143         // Iterate over the array and print the names of the states.
 144         msTextContent += sIndentation + "States     : ";
 145         for (int i=0; i<aStates.length; i++)
 146         {
 147             if (i > 0)
 148                 msTextContent += ", ";
 149             msTextContent += NameProvider.getStateName(aStates[i]);
 150         }
 151         msTextContent += "\n";
 152     }
 153
 154
 155
 156
 157     /** When the given object supports the XAccessibleComponent interface then
 158         show its size and location on the screen.
 159     */
 160     private void showComponentInfo (XAccessibleContext xContext, String sIndentation)
 161     {
 162         // Try to cast the given accessible context to the
 163         // XAccessibleComponent interface.
 164         XAccessibleComponent xComponent =
 165             (XAccessibleComponent)UnoRuntime.queryInterface(
 166                 XAccessibleComponent.class, xContext);
 167         if (xComponent != null)
 168         {
 169             Point aLocation = xComponent.getLocationOnScreen();
 170             msTextContent += sIndentation + "Position   : "
 171                 + aLocation.X + ", " + aLocation.Y + "\n";
 172
 173             Size aSize = xComponent.getSize();
 174             msTextContent += sIndentation + "Size       : "
 175                 + aSize.Width + ", " + aSize.Height + "\n";
 176         }
 177     }
 178
 179
 180
 181
 182
 183     /** Print the names of the given object and its parents and return an
 184         indentation string that can be used to print further information
 185         about the object.
 186     */
 187     private String showParents (XAccessibleContext xContext)
 188     {
 189         // Create the path from the given object to its tree's root.
 190         Vector aPathToRoot = new Vector();
 191         while (xContext != null)
 192         {
 193             aPathToRoot.add (xContext);
 194             // Go up the hierarchy one level to the object's parent.
 195             try
 196             {
 197                 XAccessible xParent = xContext.getAccessibleParent();
 198                 if (xParent != null)
 199                     xContext = xParent.getAccessibleContext();
 200                 else
 201                     xContext = null;
 202             }
 203             catch (Exception e)
 204             {
 205                 System.err.println ("caught exception " + e + " while getting path to root");
 206             }
 207         }
 208
 209         // Print the path in the accessibility tree from the given context to
 210         // the root.
 211         String sIndentation = new String ();
 212         for (int i=aPathToRoot.size()-1; i>=0; i--)
 213         {
 214             XAccessibleContext xParentContext = (XAccessibleContext)aPathToRoot.get(i);
 215             String sParentName = xParentContext.getAccessibleName();
 216             if (sParentName.length() == 0)
 217                 sParentName = "<unnamed> / Role "
 218                     + NameProvider.getRoleName(xParentContext.getAccessibleRole());
 219             msTextContent += sIndentation + sParentName + "\n";
 220             sIndentation += msIndentation;
 221         }
 222
 223         return sIndentation;
 224     }
 225
 226
 227
 228     /// The text widget that is used for the actual text display.
 229     private JTextArea maText;
 230
 231     /// The indentation with which an object's child is indented.
 232     private final String msIndentation = new String("  ");
 233
 234     /// The text content displayed by this object.
 235     private String msTextContent = new String ();
 236 }