/**************************************************************
*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*
*************************************************************/
package ifc.accessibility;
import com.sun.star.accessibility.IllegalAccessibleComponentStateException;
import com.sun.star.accessibility.XAccessible;
import com.sun.star.accessibility.XAccessibleContext;
import com.sun.star.accessibility.XAccessibleRelationSet;
import com.sun.star.accessibility.XAccessibleStateSet;
import com.sun.star.lang.Locale;
import lib.MultiMethodTest;
import util.AccessibilityTools;
/**
* Testing <code>com.sun.star.accessibility.XAccessibleContext</code>
* interface methods :
* <ul>
* <li><code> getAccessibleChildCount()</code></li>
* <li><code> getAccessibleChild()</code></li>
* <li><code> getAccessibleParent()</code></li>
* <li><code> getAccessibleIndexInParent()</code></li>
* <li><code> getAccessibleRole()</code></li>
* <li><code> getAccessibleDescription()</code></li>
* <li><code> getAccessibleName()</code></li>
* <li><code> getAccessibleRelationSet()</code></li>
* <li><code> getAccessibleStateSet()</code></li>
* <li><code> getLocale()</code></li>
* </ul> <p>
*
* @see com.sun.star.accessibility.XAccessibleContext
*/
public class _XAccessibleContext extends MultiMethodTest {
private static final String className = "com.sun.star.accessibility.XAccessibleContext";
public XAccessibleContext oObj = null;
private int childCount = 0;
private XAccessible parent = null;
// temporary while accessibility package is in com.sun.star
protected String getTestedClassName() {
return className;
}
/**
* Calls the method and stores the number of children. <p>
* Has <b> OK </b> status if non-negative number rutrned.
*/
public void _getAccessibleChildCount() {
childCount = oObj.getAccessibleChildCount();
log.println("" + childCount + " children found.");
tRes.tested("getAccessibleChildCount()", childCount > -1);
}
/**
* Tries to get every child and checks its parent. <p>
*
* Has <b> OK </b> status if parent of every child
* and the tested component are the same objects.
*
* The following method tests are to be completed successfully before :
* <ul>
* <li> <code> getAccessibleChildCount() </code> : to have a number of
* children </li>
* </ul>
*/
public void _getAccessibleChild() {
requiredMethod("getAccessibleChildCount()");
log.println("testing 'getAccessibleChild()'...");
boolean bOK = true;
int counter = childCount;
if (childCount > 500) {
counter = 500;
}
for (int i = 0; i < counter; i++) {
try {
XAccessible ch = oObj.getAccessibleChild(i);
XAccessibleContext chAC = ch.getAccessibleContext();
log.println("## Child " + i + ": " +
chAC.getAccessibleDescription());
if (!AccessibilityTools.equals(chAC.getAccessibleParent()
.getAccessibleContext(),
oObj)) {
log.println("The parent of child and component " +
"itself differ.");
log.println("\tRole:");
log.println("Getting: " +
chAC.getAccessibleParent()
.getAccessibleContext()
.getAccessibleRole());
log.println("Expected: " + oObj.getAccessibleRole());
log.println("\tImplementationName:");
log.println("Getting: " +
util.utils.getImplName(
chAC.getAccessibleParent()
.getAccessibleContext()));
log.println("Expected: " + util.utils.getImplName(oObj));
log.println("\tAccessibleDescription:");
log.println("Getting(Description): " +
chAC.getAccessibleParent()
.getAccessibleContext()
.getAccessibleDescription());
log.println("Expected(Description): " +
oObj.getAccessibleDescription());
log.println("\tAccessibleName:");
log.println("Getting(Name): " +
chAC.getAccessibleParent()
.getAccessibleContext()
.getAccessibleName());
log.println("Expected(Name): " +
oObj.getAccessibleName());
log.println("\tChildCount:");
log.println("Getting: " +
chAC.getAccessibleParent()
.getAccessibleContext()
.getAccessibleChildCount());
log.println("Expected: " +
oObj.getAccessibleChildCount());
log.println("\tParentName:");
log.println("Getting (Name): " +
chAC.getAccessibleParent()
.getAccessibleContext()
.getAccessibleParent()
.getAccessibleContext()
.getAccessibleName());
log.println("Expected(Name): " +
oObj.getAccessibleParent()
.getAccessibleContext()
.getAccessibleName());
log.println("##");
bOK = false;
} else {
log.println("Role: " + chAC.getAccessibleRole());
log.println("Name: " + chAC.getAccessibleName());
log.println("IndexInParent: " +
chAC.getAccessibleIndexInParent());
log.println("ImplementationName: " +
util.utils.getImplName(chAC));
}
} catch (com.sun.star.lang.IndexOutOfBoundsException e) {
e.printStackTrace(log);
bOK = false;
}
}
tRes.tested("getAccessibleChild()", bOK);
}
/**
* Just gets the parent. <p>
*
* Has <b> OK </b> status if parent is not null.
*/
public void _getAccessibleParent() {
// assume that the component is not ROOT
parent = oObj.getAccessibleParent();
tRes.tested("getAccessibleParent()", parent != null);
}
/**
* Retrieves the index of tested component in its parent.
* Then gets the parent's child by this index and compares
* it with tested component.<p>
*
* Has <b> OK </b> status if the parent's child and the tested
* component are the same objects.
*
* The following method tests are to be completed successfully before :
* <ul>
* <li> <code> getAccessibleParent() </code> : to have a parent </li>
* </ul>
*/
public void _getAccessibleIndexInParent() {
requiredMethod("getAccessibleParent()");
boolean bOK = true;
int idx = oObj.getAccessibleIndexInParent();
XAccessibleContext parentAC = parent.getAccessibleContext();
try {
if (parentAC.getAccessibleChild(idx) == null) {
log.println("Parent has no child with this index");
bOK &= false;
} else {
bOK &= AccessibilityTools.equals(parentAC.getAccessibleChild(
idx)
.getAccessibleContext(),
oObj);
}
if (!bOK) {
log.println("Expected: " + util.utils.getImplName(oObj));
if (parentAC.getAccessibleChild(idx) != null) {
log.println("Getting: " +
util.utils.getImplName(
parentAC.getAccessibleChild(idx)
.getAccessibleContext()));
}
}
} catch (com.sun.star.lang.IndexOutOfBoundsException e) {
e.printStackTrace(log);
bOK = false;
}
tRes.tested("getAccessibleIndexInParent()", bOK);
}
/**
* Get the accessible role of component. <p>
*
* Has <b> OK </b> status if non-negative number rutrned.
*/
public void _getAccessibleRole() {
short role = oObj.getAccessibleRole();
log.println("The role is " + role);
tRes.tested("getAccessibleRole()", role > -1);
}
/**
* Get the accessible name of the component. <p>
*
* Has <b> OK </b> status if the name has non-zero length.
*/
public void _getAccessibleName() {
String name = oObj.getAccessibleName();
log.println("The name is '" + name + "'");
tRes.tested("getAccessibleName()", name != null);
}
/**
* Get the accessible description of the component. <p>
*
* Has <b> OK </b> status if the description has non-zero length.
*/
public void _getAccessibleDescription() {
String descr = oObj.getAccessibleDescription();
log.println("The description is '" + descr + "'");
tRes.tested("getAccessibleDescription()", descr != null);
}
/**
* Just gets the set. <p>
*
* Has <b> OK </b> status if the set is not null.
*/
public void _getAccessibleRelationSet() {
XAccessibleRelationSet set = oObj.getAccessibleRelationSet();
tRes.tested("getAccessibleRelationSet()", true);
}
/**
* Just gets the set. <p>
*
* Has <b> OK </b> status if the set is not null.
*/
public void _getAccessibleStateSet() {
XAccessibleStateSet set = oObj.getAccessibleStateSet();
boolean res = true;
String[] expectedStateNames = (String[]) tEnv.getObjRelation(
"expectedStateNames");
short[] expectedStates = (short[]) tEnv.getObjRelation(
"expectedStates");
if ((expectedStateNames != null) && (expectedStates != null)) {
res = checkStates(expectedStateNames, expectedStates, set);
} else {
res = set != null;
}
tRes.tested("getAccessibleStateSet()", res);
}
/**
* Gets the locale. <p>
*
* Has <b> OK </b> status if <code>Country</code> and
* <code>Language</code> fields of locale structure
* are not empty.
*/
public void _getLocale() {
Locale loc = null;
try {
loc = oObj.getLocale();
log.println("The locale is " + loc.Language + "," + loc.Country);
} catch (IllegalAccessibleComponentStateException e) {
e.printStackTrace(log);
}
tRes.tested("getLocale()",
(loc != null) && (loc.Language.length() > 0));
}
protected boolean checkStates(String[] expectedStateNames,
short[] expectedStates,
XAccessibleStateSet set) {
boolean works = true;
for (int k = 0; k < expectedStateNames.length; k++) {
boolean contains = set.contains(expectedStates[k]);
if (contains) {
log.println("Set contains " + expectedStateNames[k] +
" ... OK");
works &= true;
} else {
log.println("Set doesn't contain " + expectedStateNames[k] +
" ... FAILED");
works &= false;
}
}
return works;
}
}