nsIAccessibleRetrieval

From MDC

An interface for in-process accessibility clients wishing to get an nsIAccessible or nsIAccessNode for a given DOM node.

Contents 1 Method overview 2 Methods 2.1 getAccessibleFor() 2.1.1 Parameters 2.1.2 Return value 2.2 getAttachedAccessibleFor() 2.2.1 Parameters 2.2.2 Return value 2.3 getRelevantContentNodeFor() 2.3.1 Parameters 2.3.2 Return value 2.4 getAccessibleInWindow() 2.4.1 Parameters 2.4.2 Return value 2.5 getAccessibleInWeakShell() 2.5.1 Parameters 2.5.2 Return value 2.6 getAccessibleInShell() 2.6.1 Parameters 2.6.2 Return value 2.7 getCachedAccessNode() 2.7.1 Parameters 2.7.2 Return value 2.8 getCachedAccessible() 2.8.1 Parameters 2.8.2 Return value 2.9 getStringRole() 2.9.1 Parameters 2.10 getStringStates() 2.10.1 Parameters 2.11 getStringEventType() 2.11.1 Parameters 2.11.2 Return value 2.12 getStringRelationType() 2.12.1 Parameters 2.12.2 Return value

nsIAccessibleRetrieval is defined in accessible/public/nsIAccessibleRetrieval.idl. It is scriptable and is currently under review.

Inherits from: nsISupports

[edit] Method overview

nsIAccessible getAccessibleFor(in nsIDOMNode aNode);

nsIAccessible getAttachedAccessibleFor(in nsIDOMNode aNode);

nsIDOMNode getRelevantContentNodeFor(in nsIDOMNode aNode);

nsIAccessible getAccessibleInWindow(in nsIDOMNode aNode, in nsIDOMWindow aDOMWin);

nsIAccessible getAccessibleInWeakShell(in nsIDOMNode aNode, in nsIWeakReference aPresShell);

nsIAccessible getAccessibleInShell(in nsIDOMNode aNode, in nsIPresShell aPresShell);

nsIAccessNode getCachedAccessNode(in nsIDOMNode aNode, in nsIWeakReference aShell);

nsIAccessible getCachedAccessible(in nsIDOMNode aNode, in nsIWeakReference aShell);

AString getStringRole(in unsigned long aRole);

nsIDOMDOMStringList getStringStates(in unsigned long aStates, in unsigned long aExtraStates);

AString getStringEventType(in unsigned long aEventType);

AString getStringRelationType(in unsigned long aRelationType);

[edit] Methods

[edit] getAccessibleFor()

Return an nsIAccessible for a DOM node in pres shell 0. Create a new accessible of the appropriate type if necessary, or use one from the accessibility cache if it already exists.

  nsIAccessible getAccessibleFor(
     in nsIDOMNode aNode
  );

[edit] Parameters

aNode

The DOM node to get an accessible for.

[edit] Return value

The nsIAccessible for the given DOM node.

[edit] getAttachedAccessibleFor()

The same like getAccessibleFor method except it returns accessible only if it is attached, i.e. accessible is certified to be a descendent of the root accessible.

  nsIAccessible getAttachedAccessibleFor(
     in nsIDOMNode aNode
  );

[edit] Parameters

aNode

The DOM node to get an accessible for.

[edit] Return value

The accessible for the given DOM node.

[edit] getRelevantContentNodeFor()

Return an DOM node that is relevant to attached accesible check. This node is either from bindings chain if given node is anonymous and owner binding denies accessible in anonymous content or given node (it's not important whether it is accessible or not). This method doesn't create accessible object for returned node.

  nsIDOMNode getRelevantContentNodeFor(
     in nsIDOMNode aNode
  );

[edit] Parameters

aNode

The DOM node to get relevant content node.

[edit] Return value

The DOM node for parent attached accessible

[edit] getAccessibleInWindow()

Return an nsIAccessible for a DOM node in pres shell for this DOM window. Create a new accessible of the appropriate type if necessary, or use one from the accessibility cache if it already exists.

  nsIAccessible getAccessibleInWindow(
     in nsIDOMNode aNode, 
     in nsIDOMWindow aDOMWin
  );

[edit] Parameters

aNode

The DOM node to get an accessible for.

aDOMWin

The DOM window containing the node.

[edit] Return value

The nsIAccessible for the given DOM node.

[edit] getAccessibleInWeakShell()

Return an nsIAccessible for a DOM node in the given weak shell. Create a new accessible of the appropriate type if necessary, or use one from the accessibility cache if it already exists.

  nsIAccessible getAccessibleInWeakShell(
     in nsIDOMNode aNode, 
     in nsIWeakReference aPresShell
  );

[edit] Parameters

aNode

The DOM node to get an accessible for.

aPresShell

The presentation shell which contains layout info for the DOM node.

[edit] Return value

The nsIAccessible for the given DOM node.

[edit] getAccessibleInShell()

Return an nsIAccessible for a DOM node in the given pres shell. Create a new accessible of the appropriate type if necessary, or use one from the accessibility cache if it already exists.

  nsIAccessible getAccessibleInShell(
     in nsIDOMNode aNode, 
     in nsIPresShell aPresShell
  );

[edit] Parameters

aNode

The DOM node to get an accessible for.

aPresShell

The presentation shell which contains layout info for the DOM node.

[edit] Return value

The nsIAccessible for the given DOM node.

[edit] getCachedAccessNode()

Return an nsIAccessNode for an already created DOM node in the given weak shell. Does not create a new one -- only returns cached access nodes.

  nsIAccessNode getCachedAccessNode(
     in nsIDOMNode aNode, 
     in nsIWeakReference aShell
  );

[edit] Parameters

aNode

The DOM node to get an access node for.

aShell

The presentation shell which contains layout info for the DOM node.

[edit] Return value

The nsIAccessNode for the given DOM node or null if an access node does not already exist for this DOM node.

[edit] getCachedAccessible()

Return an nsIAccessible for an already created DOM node in the given weak shell. Does not create a new one -- only returns cached accessibles.

  nsIAccessible getCachedAccessible(
     in nsIDOMNode aNode, 
     in nsIWeakReference aShell
  );

[edit] Parameters

aNode

The DOM node to get an accessible for.

aShell

The presentation shell which contains layout info for the DOM node.

[edit] Return value

The nsIAccessible for the given DOM node or null if an accessible does not already exist for this DOM node.

[edit] getStringRole()

Returns accessible role as a string.

  AString getStringRole(
     in unsigned long aRole
  );

[edit] Parameters

aRole

The accessible role constants.

[edit] getStringStates()

Returns list which contains accessible states as a strings.

  nsIDOMDOMStringList getStringStates(
     in unsigned long aStates,
     in unsigned long aExtraStates
  );

[edit] Parameters

aStates

accessible states.

aExtraStates

accessible extra states.

[edit] getStringEventType()

Get the type of accessible event as a string.

  AString getStringEventType(
     in unsigned long aEventType
  );

[edit] Parameters

aEventType

the accessible event type constant

[edit] Return value

accessible event type presented as human readable string

[edit] getStringRelationType()

Get the type of accessible relation as a string.

  AString getStringRelationType(
     in unsigned long aRelationType
  );

[edit] Parameters

aRelationType

the accessible relation type constant

[edit] Return value

accessible relation type presented as human readable string