qadevOOo/runner/util/AccessibilityTools.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 package util;
  19
  20 import com.sun.star.accessibility.XAccessible;
  21 import com.sun.star.accessibility.XAccessibleComponent;
  22 import com.sun.star.accessibility.XAccessibleContext;
  23 import com.sun.star.awt.XWindow;
  24 import com.sun.star.frame.XController;
  25 import com.sun.star.frame.XFrame;
  26 import com.sun.star.frame.XModel;
  27 import com.sun.star.lang.XMultiServiceFactory;
  28 import com.sun.star.uno.UnoRuntime;
  29 import com.sun.star.uno.XInterface;
  30
  31 import java.io.PrintWriter;
  32
  33
  34 public class AccessibilityTools {
  35     public static XAccessible SearchedAccessible = null;
  36     private static boolean debug = false;
  37
  38     public AccessibilityTools() {
  39         //done = false;
  40     }
  41
  42     public static XAccessible getAccessibleObject(XInterface xObject) {
  43         return UnoRuntime.queryInterface(XAccessible.class, xObject);
  44     }
  45
  46     public static XWindow getCurrentContainerWindow(XMultiServiceFactory msf,
  47         XModel xModel) {
  48         return getWindow(msf, xModel, true);
  49     }
  50
  51     public static XWindow getCurrentWindow(XMultiServiceFactory msf,
  52         XModel xModel) {
  53         return getWindow(msf, xModel, false);
  54     }
  55
  56     private static XWindow getWindow(XMultiServiceFactory msf, XModel xModel,
  57         boolean containerWindow) {
  58         XWindow xWindow = null;
  59
  60         try {
  61             if (xModel == null) {
  62                 System.out.println("invalid model (==null)");
  63             }
  64
  65             XController xController = xModel.getCurrentController();
  66
  67             if (xController == null) {
  68                 System.out.println("can't get controller from model");
  69             }
  70
  71             XFrame xFrame = xController.getFrame();
  72
  73             if (xFrame == null) {
  74                 System.out.println("can't get frame from controller");
  75             }
  76
  77             if (containerWindow)
  78                 xWindow = xFrame.getContainerWindow();
  79             else
  80                 xWindow = xFrame.getComponentWindow();
  81
  82             if (xWindow == null) {
  83                 System.out.println("can't get window from frame");
  84             }
  85         } catch (Exception e) {
  86             System.out.println("caught exception while getting current window" + e);
  87         }
  88
  89         return xWindow;
  90     }
  91
  92     public static XAccessibleContext getAccessibleObjectForRole(XAccessible xacc,
  93         short role) {
  94         SearchedAccessible = null;
  95         return getAccessibleObjectForRole_(xacc, role);
  96     }
  97
  98     public static XAccessibleContext getAccessibleObjectForRole(XAccessible xacc,
  99         short role,
 100         boolean ignoreShowing) {
 101         SearchedAccessible = null;
 102
 103         if (ignoreShowing) {
 104             return getAccessibleObjectForRoleIgnoreShowing_(xacc, role);
 105         } else {
 106             return getAccessibleObjectForRole_(xacc, role);
 107         }
 108     }
 109
 110     public static XAccessibleContext getAccessibleObjectForRoleIgnoreShowing_(XAccessible xacc,
 111         short role) {
 112         XAccessibleContext ac = xacc.getAccessibleContext();
 113
 114         if (ac.getAccessibleRole() == role) {
 115             SearchedAccessible = xacc;
 116             return ac;
 117         } else {
 118             int k = ac.getAccessibleChildCount();
 119
 120             if (ac.getAccessibleChildCount() > 100) {
 121                 k = 50;
 122             }
 123
 124             for (int i = 0; i < k; i++) {
 125                 try {
 126                     XAccessibleContext ac2 = getAccessibleObjectForRoleIgnoreShowing_(
 127                         ac.getAccessibleChild(i), role);
 128
 129                     if (ac2 != null) {
 130                         return ac2;
 131                     }
 132                 } catch (com.sun.star.lang.IndexOutOfBoundsException e) {
 133                     System.out.println("Couldn't get Child");
 134                 }
 135             }
 136             return null;
 137         }
 138     }
 139
 140     public static XAccessibleContext getAccessibleObjectForRole_(XAccessible xacc,
 141         short role) {
 142         XAccessibleContext ac = xacc.getAccessibleContext();
 143         boolean isShowing = ac.getAccessibleStateSet()
 144         .contains(com.sun.star.accessibility.AccessibleStateType.SHOWING);
 145
 146         if ((ac.getAccessibleRole() == role) && isShowing) {
 147             SearchedAccessible = xacc;
 148             return ac;
 149         } else {
 150             int k = ac.getAccessibleChildCount();
 151
 152             if (ac.getAccessibleChildCount() > 100) {
 153                 k = 50;
 154             }
 155
 156             for (int i = 0; i < k; i++) {
 157                 try {
 158                     XAccessibleContext ac2 = getAccessibleObjectForRole_(ac.getAccessibleChild(i), role);
 159
 160                     if (ac2 != null) {
 161                         return ac2;
 162                     }
 163                 } catch (com.sun.star.lang.IndexOutOfBoundsException e) {
 164                     System.out.println("Couldn't get Child");
 165                 }
 166             }
 167             return null;
 168         }
 169     }
 170
 171     public static XAccessibleContext getAccessibleObjectForRole(XAccessible xacc,
 172         short role,
 173         String name) {
 174         return getAccessibleObjectForRole(xacc, role, name, "");
 175     }
 176
 177     public static XAccessibleContext getAccessibleObjectForRole(XAccessible xacc,
 178         short role,
 179         String name,
 180         boolean ignoreShowing) {
 181         if (ignoreShowing) {
 182             return getAccessibleObjectForRoleIgnoreShowing(xacc, role, name,
 183                 "");
 184         } else {
 185             return getAccessibleObjectForRole(xacc, role, name, "");
 186         }
 187     }
 188
 189     public static XAccessibleContext getAccessibleObjectForRoleIgnoreShowing(XAccessible xacc,
 190         short role,
 191         String name,
 192         String implName) {
 193         XAccessibleContext ac = xacc.getAccessibleContext();
 194         if ((ac.getAccessibleRole() == role) &&
 195             (ac.getAccessibleName().indexOf(name) > -1) &&
 196             (utils.getImplName(ac).indexOf(implName) > -1)) {
 197             SearchedAccessible = xacc;
 198
 199             //System.out.println("FOUND the desired component -- "+ ac.getAccessibleName() +isShowing);
 200             return ac;
 201         } else {
 202             int k = ac.getAccessibleChildCount();
 203
 204             if (ac.getAccessibleChildCount() > 100) {
 205                 k = 50;
 206             }
 207
 208             for (int i = 0; i < k; i++) {
 209                 try {
 210                     XAccessibleContext ac1 = getAccessibleObjectForRoleIgnoreShowing(
 211                         ac.getAccessibleChild(i),
 212                         role, name, implName);
 213
 214                     if (ac1 != null) {
 215                         return ac1;
 216                     }
 217                 } catch (com.sun.star.lang.IndexOutOfBoundsException e) {
 218                     System.out.println("Couldn't get Child");
 219                 }
 220             }
 221         }
 222
 223         return null;
 224     }
 225
 226     public static XAccessibleContext getAccessibleObjectForRole(XAccessible xacc,
 227         short role,
 228         String name,
 229         String implName) {
 230         XAccessibleContext ac = xacc.getAccessibleContext();
 231         boolean isShowing = ac.getAccessibleStateSet()
 232         .contains(com.sun.star.accessibility.AccessibleStateType.SHOWING);
 233
 234         // hotfix for i91828:
 235         // if role to search is 0 then ignore the role.
 236         if ( (role == 0 || ac.getAccessibleRole() == role) &&
 237             (ac.getAccessibleName().indexOf(name) > -1) &&
 238             (utils.getImplName(ac).indexOf(implName) > -1) &&
 239             isShowing) {
 240             SearchedAccessible = xacc;
 241             //System.out.println("FOUND the desired component -- "+ ac.getAccessibleName() +isShowing);
 242             return ac;
 243         } else {
 244             int k = ac.getAccessibleChildCount();
 245
 246             if (ac.getAccessibleChildCount() > 100) {
 247                 k = 50;
 248             }
 249
 250             for (int i = 0; i < k; i++) {
 251                 try {
 252                     XAccessibleContext ac1 = getAccessibleObjectForRole(
 253                         ac.getAccessibleChild(i),
 254                         role, name, implName);
 255
 256                     if (ac1 != null) {
 257                         return ac1;
 258                     }
 259                 } catch (com.sun.star.lang.IndexOutOfBoundsException e) {
 260                     System.out.println("Couldn't get Child");
 261                 }
 262             }
 263         }
 264
 265         return null;
 266     }
 267
 268     /**
 269      * This methods retunrs the <CODE>XAccessibleContext</CODE> of a named Sheet-Cell like "G5".<p>
 270      * @param xSheetAcc The <CODE>XAccessibleContext</CODE> of a Sheet
 271      * @param cellName The name of a cell like "A5"
 272      * @return the <CODE>XAccessiblecontext</CODE> of the named cell
 273      */
 274     public static XAccessibleContext getSheetCell(XAccessibleContext xSheetAcc, String cellName){
 275
 276         int cellIndex = 0;
 277         int column =0;
 278         int charMem = 0;
 279         for (int n=0; n<cellName.length(); n++){
 280             String cha = cellName.substring(n,n+1);
 281             System.out.println("char: " + cha + " ");
 282
 283             byte[] bytes = cha.getBytes();
 284
 285             if ((bytes[0] >= 'A') && (bytes[0] <= 'Z')){
 286                 charMem = bytes[0]-64;
 287                 column++;
 288                 if ( column == 2 ){
 289                     cellIndex += charMem * 26;
 290                 }
 291                 cellIndex= cellIndex+ (bytes[0]-65);
 292             } else {
 293                 String sNumb = cellName.substring(n, cellName.length());
 294                 int iNumb = Integer.valueOf(sNumb).intValue();
 295                 cellIndex += (iNumb-1) * 256;
 296                 System.out.println("numb:" + (iNumb-1) * 256);
 297             }
 298
 299         }
 300
 301         //System.out.println("cellName:  " + cellName + " cellIndex: " + cellIndex);
 302
 303         try {
 304             XAccessibleContext ac = xSheetAcc.getAccessibleChild(cellIndex).getAccessibleContext();
 305             System.out.println(ac.getAccessibleRole() + "," +
 306                 ac.getAccessibleName() + "(" +
 307                 ac.getAccessibleDescription() + "):" +
 308                 utils.getImplName(ac));
 309
 310             return ac;
 311         } catch (com.sun.star.lang.IndexOutOfBoundsException ex) {
 312             System.out.println("ERROR: could not get child at index " + cellIndex +"': " + ex.toString());
 313             return null;
 314         }
 315     }
 316
 317     public static void printAccessibleTree(PrintWriter log, XAccessible xacc, boolean debugIsActive) {
 318         debug = debugIsActive;
 319         if (debug) printAccessibleTree(log, xacc, "");
 320     }
 321
 322     public static void printAccessibleTree(PrintWriter log, XAccessible xacc) {
 323         printAccessibleTree(log, xacc, "");
 324     }
 325
 326     protected static void printAccessibleTree(PrintWriter log,
 327         XAccessible xacc, String indent) {
 328
 329         XAccessibleContext ac = xacc.getAccessibleContext();
 330
 331         logging(log,indent + ac.getAccessibleRole() + "," +
 332             ac.getAccessibleName() + "(" +
 333             ac.getAccessibleDescription() + "):" +
 334             utils.getImplName(ac));
 335
 336         XAccessibleComponent aComp = UnoRuntime.queryInterface(
 337             XAccessibleComponent.class, xacc);
 338
 339         if (aComp != null) {
 340             String bounds = "(" + aComp.getBounds().X + "," +
 341                 aComp.getBounds().Y + ")" + " (" +
 342                 aComp.getBounds().Width + "," +
 343                 aComp.getBounds().Height + ")";
 344             bounds = "The boundary Rectangle is " + bounds;
 345             logging(log,indent + indent + bounds);
 346         }
 347
 348         boolean isShowing = ac.getAccessibleStateSet()
 349         .contains(com.sun.star.accessibility.AccessibleStateType.SHOWING);
 350         logging(log,indent + indent + "StateType contains SHOWING: " +
 351             isShowing);
 352
 353         int k = ac.getAccessibleChildCount();
 354
 355         if (ac.getAccessibleChildCount() > 100) {
 356             k = 50;
 357         }
 358
 359         for (int i = 0; i < k; i++) {
 360             try {
 361                 printAccessibleTree(log, ac.getAccessibleChild(i),
 362                     indent + "  ");
 363             } catch (com.sun.star.lang.IndexOutOfBoundsException e) {
 364                 System.out.println("Couldn't get Child");
 365             }
 366         }
 367
 368         if (ac.getAccessibleChildCount() > 100) {
 369             k = ac.getAccessibleChildCount();
 370
 371             int st = ac.getAccessibleChildCount() - 50;
 372             logging(log,indent + "  " + " ...... [skipped] ......");
 373
 374             for (int i = st; i < k; i++) {
 375                 try {
 376                     printAccessibleTree(log, ac.getAccessibleChild(i),
 377                         indent + "  ");
 378                 } catch (com.sun.star.lang.IndexOutOfBoundsException e) {
 379                     System.out.println("Couldn't get Child");
 380                 }
 381             }
 382         }
 383     }
 384
 385     public static String accessibleToString(Object AC) {
 386         XAccessibleContext xAC = UnoRuntime.queryInterface(
 387             XAccessibleContext.class, AC);
 388
 389         if (xAC != null) {
 390             return "" + xAC.getAccessibleRole() + "," +
 391                 xAC.getAccessibleName() + "(" +
 392                 xAC.getAccessibleDescription() + "):";
 393         }
 394
 395         XAccessible xA = UnoRuntime.queryInterface(
 396             XAccessible.class, AC);
 397
 398         if (xA == null) {
 399             return "(Not supported)";
 400         }
 401
 402         xAC = xA.getAccessibleContext();
 403
 404         return "" + xAC.getAccessibleRole() + "," + xAC.getAccessibleName() +
 405             "(" + xAC.getAccessibleDescription() + ")";
 406     }
 407
 408     public static boolean equals(XAccessible c1, XAccessible c2) {
 409         if ((c1 == null) || (c2 == null)) {
 410             return c1 == c2;
 411         }
 412
 413         return AccessibilityTools.equals(c1.getAccessibleContext(),
 414             c2.getAccessibleContext());
 415     }
 416
 417     public static boolean equals(XAccessibleContext c1, XAccessibleContext c2) {
 418         if ((c1 == null) || (c2 == null)) {
 419             return c1 == c2;
 420         }
 421
 422         if (c1.getAccessibleRole() != c2.getAccessibleRole()) {
 423             return false;
 424         }
 425
 426         if (!c1.getAccessibleName().equals(c2.getAccessibleName())) {
 427             return false;
 428         }
 429
 430         if (!c1.getAccessibleDescription()
 431         .equals(c2.getAccessibleDescription())) {
 432             return false;
 433         }
 434
 435         if (c1.getAccessibleChildCount() != c2.getAccessibleChildCount()) {
 436             return false;
 437         }
 438
 439         return AccessibilityTools.equals(c1.getAccessibleParent(),
 440             c2.getAccessibleParent());
 441     }
 442
 443     private static void logging(PrintWriter log, String content){
 444         if (debug) log.println(content);
 445     }
 446 }