toolkit/test/accessibility/AccessibleTreeHandler.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.accessibility.XAccessible;
  20 import com.sun.star.accessibility.XAccessibleContext;
  21 import com.sun.star.lang.IndexOutOfBoundsException;
  22
  23
  24 /**
  25  * Map the tree of accessibility objects into their
  26  * AccessibilityTreeModel counterparts.
  27  */
  28 class AccessibleTreeHandler
  29     extends NodeHandler
  30 {
  31     protected XAccessibleContext mxContext;
  32
  33     public NodeHandler createHandler (XAccessibleContext xContext)
  34     {
  35         if (xContext != null)
  36             return new AccessibleTreeHandler (xContext);
  37         else
  38             return null;
  39     }
  40
  41     public AccessibleTreeHandler ()
  42     {
  43         super();
  44         mxContext = null;
  45     }
  46
  47     public AccessibleTreeHandler (XAccessibleContext xContext)
  48     {
  49         super();
  50         mxContext = xContext;
  51         if (mxContext != null)
  52             // Add one to the number of children to include the string node
  53             // that tells you how many children there are.
  54             synchronized (maChildList)
  55             {
  56                 maChildList.setSize (1 + mxContext.getAccessibleChildCount());
  57             }
  58     }
  59
  60     public AccessibleTreeNode createChild (AccessibleTreeNode aParent, int nIndex)
  61     {
  62         AccessibleTreeNode aChild = null;
  63         if (mxContext != null)
  64         {
  65             if (nIndex == 0)
  66                 aChild = new StringNode ("Child count: " + mxContext.getAccessibleChildCount(),
  67                     aParent);
  68             else
  69             {
  70                 // Lower index to skip the string node.
  71                 nIndex -= 1;
  72                 try
  73                 {
  74                     XAccessible xChild = mxContext.getAccessibleChild (nIndex);
  75                     aChild = NodeFactory.Instance().createDefaultNode (
  76                         xChild, aParent);
  77                 }
  78                 catch( IndexOutOfBoundsException e )
  79                 {
  80                     aChild = new StringNode ("ERROR: no child with index " + nIndex, aParent);
  81                 }
  82             }
  83         }
  84         else
  85             aChild = new StringNode ("XAccessibleContext interface not supported", aParent);
  86         return aChild;
  87     }
  88
  89     /** Try to add the specified accessible child into the lists of
  90         children.  The insertion position is determined from the
  91         getIndexInParent method of the child.
  92     */
  93     public AccessibleTreeNode addAccessibleChild (AccessibleTreeNode aParent, XAccessible xChild)
  94     {
  95         AccessibleTreeNode aChild = null;
  96
  97         if (xChild != null)
  98         {
  99             XAccessibleContext xContext = xChild.getAccessibleContext();
 100             if (xContext != null)
 101             {
 102                 int nIndex = xContext.getAccessibleIndexInParent() + 1;
 103                 synchronized (maChildList)
 104                 {
 105                     if ((nIndex >= 0) || (nIndex <= maChildList.size()))
 106                     {
 107                         aChild = NodeFactory.Instance().createDefaultNode (xChild, aParent);
 108                         maChildList.add (nIndex, aChild);
 109                     }
 110                 }
 111             }
 112         }
 113         return aChild;
 114     }
 115
 116
 117     /** Update only the child count node.  Trust on other ways to update the
 118         accessible children.
 119     */
 120     public void update (AccessibleTreeNode aNode)
 121     {
 122         synchronized (maChildList)
 123         {
 124             maChildList.set (0, null);
 125         }
 126     }
 127 }