org.eclipse.actf.accservice
Interface IAccessibilityService

All Superinterfaces:
Serializable
All Known Implementing Classes:
IA2AccessibilityService, JavaAccessibilityService, MozillaAccessibilityService, MsaaAccessibilityService

public interface IAccessibilityService
extends Serializable

a service for accessing platform-specific accessibility models. An IAccessibilityService object is used to access two sorts of objects:

  1. accessible elements corresponding to components of a supported model (e.g. GUI components, document elements)
  2. the event service for registering event listeners with the underlying accessibility model

An IAccessibilityService should be registered with the AccessibilityServiceManager and must include only the default no-argument constructor.

Author:
Mike Squillace
See Also:
AccessibilityServiceManager.registerAccessibilityService(String, String)

Field Summary
static long serialVersionUID
           
 
Method Summary
 IAccessibleElement createAccessibleElement(Object obj, Object[] params)
          create an IAccessibleElement from the given object and optional parameters.
 IAccessibilityEventService getAccessibilityEventService()
          retreaves the event services for the underlying accessibility infrastructure.
 IWindowService getWindowService()
          returns a service for windowing-related functionality.
 void initialize()
          initialize the service by loading native libraries, configuring platform-specific resources, and the like.
 

Field Detail

serialVersionUID

static final long serialVersionUID
See Also:
Constant Field Values
Method Detail

createAccessibleElement

IAccessibleElement createAccessibleElement(Object obj,
                                           Object[] params)
                                           throws InvalidComponentException
create an IAccessibleElement from the given object and optional parameters. IAccessibleElement instances are used to access accesibility-related properties of the given object and need not (and, in most cases, are not) the same object as the given object.

Parameters:
obj - object for which an accessible is desired
params - optional parameters for creating the accessible (may be null)
Returns:
an IAccessibleElement for the given object
Throws:
InvalidComponentException - if the given object is somehow invalid or an accessible cannot b created for the given object

getAccessibilityEventService

IAccessibilityEventService getAccessibilityEventService()
retreaves the event services for the underlying accessibility infrastructure. The IAccessibilityEventService allows clients to register event listeners to listen for low-level, platform-specific events that are used by accessibility devices (like assistive technologies).

Returns:
the IAccessibilityEventService object for this accessibility infrastructure or null if no such event service is available

getWindowService

IWindowService getWindowService()
returns a service for windowing-related functionality. This includes getting the top-level windows of whatever the platform considers to be its desktop, adding listeners to observe creation and destruction of top-level windows, and getting the active or current window.

Returns:
windowing service for this platform or null if no such service exists

initialize

void initialize()
                throws AccessibilityServiceException
initialize the service by loading native libraries, configuring platform-specific resources, and the like. This method will be called by the service manager upon instantiating the service.

Throws:
AccessibilityServiceException