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