accessible/public/nsIAccessibleHyperText.idlScriptable
This interface is the main interface to expose hyperlinks in a document, typically a text document, that are used to reference other documents. A typical implementation is to implement this interface on the small text object such as a paragraph of text.
Inherits from: nsISupports Last changed in Gecko 1.9 (Firefox 3)

Method overview

nsIAccessibleHyperLink getLink(in long linkIndex);
long getLinkIndex(in long charIndex);
long getSelectedLinkIndex(); Obsolete since Gecko 1.9

Attributes

Attribute Type Description
linkCount long The number of links contained within this hypertext object. Read only.
Note: Renamed from links in Gecko 1.9

Methods

getLink()

Retrieves the nsIAccessibleHyperLink object at the given link index.

nsIAccessibleHyperLink getLink(
  in long linkIndex
);
Parameters
linkIndex

0-based index of the link that is to be retrieved. This can be retrieved via getLinkIndex().

Return value

An nsIAccessibleHyperLink object.

Exceptions thrown
NS_ERROR_FAILURE
Indicates that the accessible is unattached from the accessible tree.
NS_ERROR_INVALID_ARG
The link index is invalid.

getLinkIndex()

The link index at the given offset (character index).

long getLinkIndex(
  in long charIndex
);
Parameters
charIndex
The 0-based character index.
Return value

The index of the link if it's presented on the given character index, otherwise -1.

Exceptions thrown
NS_ERROR_FAILURE
Indicates that the accessible is unattached from the accessible tree.

getSelectedLinkIndex()

Obsolete since Gecko 1.9 (Firefox 3) 

long getSelectedLinkIndex();
Parameters

None.

Return value

Missing Description

Exceptions thrown
NS_ERROR_FAILURE
Indicates that the accessible is unattached from the accessible tree.

See also