qadevOOo/runner/util/AccessibilityTools.java

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