org.eclipse.actf.accservice.core
Interface IAccessibleElement2

All Superinterfaces:
IAccessibleElement
All Known Implementing Classes:
IA2Accessible, JavaAccessible

public interface IAccessibleElement2
extends IAccessibleElement

extended interface for exposing more semantically rich properties and relations that might be provided by some accessibility APIs. The Java Accessibility API is one such API.

In most cases, implementations of this interface will be primarily native and platform-dependent.

Author:
Mike Smith
See Also:
AccessibleContext

Method Summary
 IAccessibleEditableTextElement getAccessibleEditableText()
          get the accessible Editable Text for this object
 IAccessibleImageElement[] getAccessibleImage()
          get the accessible image elements for this object
 Map getAccessibleRelations()
          get the relations for this accessible element.
 IAccessibleTableElement getAccessibleTable()
          get the accessible table element for this object
 IAccessibleTextElement getAccessibleText()
          get the accessible text element for this object
 
Methods inherited from interface org.eclipse.actf.accservice.core.IAccessibleElement
checkIsValid, element, getAccessibleAction, getAccessibleChild, getAccessibleChildCount, getAccessibleChildren, getAccessibleDescription, getAccessibleIndexInParent, getAccessibleKeyboardShortcut, getAccessibleLocation, getAccessibleName, getAccessibleParent, getAccessibleRole, getAccessibleSelection, getAccessibleState, getAccessibleValue
 

Method Detail

getAccessibleTable

IAccessibleTableElement getAccessibleTable()
                                           throws InvalidComponentException
get the accessible table element for this object

Returns:
table or null if no table is available
Throws:
InvalidComponentException

getAccessibleText

IAccessibleTextElement getAccessibleText()
                                         throws InvalidComponentException
get the accessible text element for this object

Returns:
text object or null if no text is available
Throws:
InvalidComponentException

getAccessibleImage

IAccessibleImageElement[] getAccessibleImage()
                                             throws InvalidComponentException
get the accessible image elements for this object

Returns:
array of image objects or empty array if no images are available
Throws:
InvalidComponentException

getAccessibleRelations

Map getAccessibleRelations()
                           throws InvalidComponentException
get the relations for this accessible element. Such objects express this element's relation to other accessible elements (e.g. the element is a "member of" or "labeled by" some other element). The map should have the relation type as key and relation target(s) as value. The value will be an array of IAccessibleElement objects.

Note: All attempts will be made to use keys that match one of the pre-defined relation constants in AccessibleConstants. Should the relation type be unknown or not match one of the pre-defined constants, the original relationship type from the underlying accessibility model will be returned.

Returns:
accessible relations held by this element to other accessible elements
Throws:
InvalidComponentException

getAccessibleEditableText

IAccessibleEditableTextElement getAccessibleEditableText()
                                                         throws InvalidComponentException
get the accessible Editable Text for this object

Returns:
EditbleText object or null if no EditableText is available
Throws:
InvalidComponentException