accessible/public/nsIAccessibleRetrieval.idlScriptable
An interface for in-process accessibility clients wishing to get an nsIAccessible or nsIAccessNode for a given DOM node.
Inherits from: nsISupports Last changed in Gecko 2.0 (Firefox 4 / Thunderbird 3.3 / SeaMonkey 2.1)

Method overview

nsIAccessible getAccessibleFor(in nsIDOMNode aNode);
nsIAccessible getAccessibleInShell(in nsIDOMNode aNode, in nsIPresShell aPresShell);
nsIAccessible getAccessibleInWeakShell(in nsIDOMNode aNode, in nsIWeakReference aPresShell); Obsolete since Gecko 2.0
nsIAccessible getAccessibleInWindow(in nsIDOMNode aNode, in nsIDOMWindow aDOMWin); Obsolete since Gecko 2.0
nsIAccessible getApplicationAccessible();
nsIAccessible getAttachedAccessibleFor(in nsIDOMNode aNode);
nsIAccessible getCachedAccessible(in nsIDOMNode aNode, in nsIWeakReference aShell); Obsolete since Gecko 2.0
nsIAccessNode getCachedAccessNode(in nsIDOMNode aNode, in nsIWeakReference aShell); Obsolete since Gecko 2.0
nsIDOMNode getRelevantContentNodeFor(in nsIDOMNode aNode);
AString getStringEventType(in unsigned long aEventType);
AString getStringRelationType(in unsigned long aRelationType);
AString getStringRole(in unsigned long aRole);
nsIDOMDOMStringList getStringStates(in unsigned long aStates, in unsigned long aExtraStates);

Methods

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
);
Parameters
aNode
The DOM node to get an accessible for.
Return value

The nsIAccessible for the given DOM node.

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
);
Parameters
aNode
The DOM node to get an accessible for.
aPresShell
The presentation shell which contains layout info for the DOM node.
Return value

The nsIAccessible for the given DOM node.

getAccessibleInWeakShell()

Obsolete since Gecko 2.0 (Firefox 4 / Thunderbird 3.3 / SeaMonkey 2.1)

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
);
Parameters
aNode
The DOM node to get an accessible for.
aPresShell
The presentation shell which contains layout info for the DOM node.
Return value

The nsIAccessible for the given DOM node.

getAccessibleInWindow()

Obsolete since Gecko 2.0 (Firefox 4 / Thunderbird 3.3 / SeaMonkey 2.1)

Return an nsIAccessible for a DOM node in present 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
);
Parameters
aNode
The DOM node to get an accessible for.
aDOMWin
The DOM window containing the node.
Return value

The nsIAccessible for the given DOM node.

getApplicationAccessible()

Return application accessible.

nsIAccessible getApplicationAccessible();
Parameters

None.

Return value

The nsIAccessible for the application.

getAttachedAccessibleFor()

Similar to getAccessibleFor() except it returns accessible only if it is attached, that is accessible is certified to be a descendant of the root accessible.

nsIAccessible getAttachedAccessibleFor(
  in nsIDOMNode aNode
);
Parameters
aNode
The DOM node to get an accessible for.
Return value

The accessible for the given DOM node.

getCachedAccessible()

Obsolete since Gecko 2.0 (Firefox 4 / Thunderbird 3.3 / SeaMonkey 2.1)

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
);
Parameters
aNode
The DOM node to get an accessible for.
aShell
The presentation shell which contains layout info for the DOM node.
Return value

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

getCachedAccessNode()

Obsolete since Gecko 2.0 (Firefox 4 / Thunderbird 3.3 / SeaMonkey 2.1)

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
);
Parameters
aNode
The DOM node to get an access node for.
aShell
The presentation shell which contains layout info for the DOM node.
Return value

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

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
);
Parameters
aNode
The DOM node to get relevant content node.
Return value

The DOM node for parent attached accessible.

getStringEventType()

Get the type of accessible event as a string.

AString getStringEventType(
  in unsigned long aEventType
);
Parameters
aEventType
The accessible event type constant.
Return value

Accessible event type presented as human readable string.

getStringRelationType()

Get the type of accessible relation as a string.

AString getStringRelationType(
  in unsigned long aRelationType
);
Parameters
aRelationType
The accessible relation type constant.
Return value

Accessible relation type presented as human readable string.

getStringRole()

Returns accessible role as a string.

AString getStringRole(
  in unsigned long aRole
);
Parameters
aRole
The accessible role constants.
Return value

Accessible role as a string.

getStringStates()

Returns a list which contains accessible states as strings.

nsIDOMDOMStringList getStringStates(
  in unsigned long aStates,
  in unsigned long aExtraStates
);
Parameters
aStates
Accessible states.
aExtraStates
Accessible extra states.
Return value

A list which contains accessible states as strings. 

See also