Public Member Functions | Public Attributes

nsIAccessibleHyperLink Interface Reference

A cross-platform interface that supports hyperlink-specific properties and methods. More...

import "nsIAccessibleHyperLink.idl";

List of all members.

Public Member Functions

nsIURI getURI (in long index)
 Returns the URI at the given index.
nsIAccessible getAnchor (in long index)
 Returns a reference to the object at the given index.

Public Attributes

readonly attribute long startIndex
 Returns the offset of the link within the parent accessible.
readonly attribute long endIndex
 Returns the end index of the link within the parent accessible.
readonly attribute boolean valid
 Determines whether the link is valid (e.
readonly attribute boolean selected
 Determines whether the element currently has the focus, e.
readonly attribute long anchorCount
 The numbber of anchors within this Hyperlink.

Detailed Description

A cross-platform interface that supports hyperlink-specific properties and methods.

Anchors, image maps, xul:labels with class="text-link" implement this interface.


Member Function Documentation

nsIAccessible nsIAccessibleHyperLink::getAnchor ( in long  index  ) 

Returns a reference to the object at the given index.

Parameters:
index The 0-based index whose object is to be returned.
Returns:
the nsIAccessible object at the desired index.
nsIURI nsIAccessibleHyperLink::getURI ( in long  index  ) 

Returns the URI at the given index.

Note:
ARIA hyperlinks do not have an URI to point to, since clicks are processed via JavaScript. Therefore this property does not work on ARIA links.
Parameters:
index The 0-based index of the URI to be returned.
Returns:
the nsIURI object containing the specifications for the URI.

Member Data Documentation

readonly attribute long nsIAccessibleHyperLink::anchorCount

The numbber of anchors within this Hyperlink.

Is normally 1 for anchors. This anchor is, for example, the visible output of the html:a tag. With an Image Map, reflects the actual areas within the map.

readonly attribute long nsIAccessibleHyperLink::endIndex

Returns the end index of the link within the parent accessible.

Note:
The link itself is represented by one embedded character within the parent text, so the endIndex should be startIndex + 1.

Determines whether the element currently has the focus, e.

g. after returning from the destination page.

Note:
ARIA links can only be focused if they have the tabindex attribute set. Also, state_focused should then be set on the accessible for this link.
readonly attribute long nsIAccessibleHyperLink::startIndex

Returns the offset of the link within the parent accessible.

Determines whether the link is valid (e.

g. points to a valid URL).

Note:
XXX Currently only used with ARIA links, and the author has to specify that the link is invalid via the aria-invalid="true" attribute. In all other cases, TRUE is returned.

The documentation for this interface was generated from the following file: