javax.accessibility
Interface AccessibleHypertext

All Superinterfaces:

AccessibleText

All Known Implementing Classes:

javax.swing.JEditorPane.JEditorPaneAccessibleHypertextSupport

public interface AccessibleHypertext

extends AccessibleText

Untamed:

The AccessibleHypertext class is the base class for all classes that present hypertext information on the display. This class provides the standard mechanism for an assistive technology to access that text via its content, attributes, and spatial location. It also provides standard mechanisms for manipulating hyperlinks. Applications can determine if an object supports the AccessibleHypertext interface by first obtaining its AccessibleContext (see Accessible) and then calling the AccessibleContext.getAccessibleText() method of AccessibleContext. If the return value is a class which extends AccessibleHypertext, then that object supports AccessibleHypertext.

Version:

Author:

Peter Korn

See Also:

Accessible, Accessible.getAccessibleContext(), AccessibleContext, AccessibleText, AccessibleContext.getAccessibleText()

Field Summary

Fields inherited from interface javax.accessibility.AccessibleText

CHARACTER, SENTENCE, WORD

Method Summary

AccessibleHyperlink	getLink(int linkIndex) Enabled: Returns the nth Link of this Hypertext document.
int	getLinkCount() Enabled: Returns the number of links within this hypertext document.
int	getLinkIndex(int charIndex) Enabled: Returns the index into an array of hyperlinks that is associated with this character index, or -1 if there is no hyperlink associated with this index.

Methods inherited from interface javax.accessibility.AccessibleText

getAfterIndex, getAtIndex, getBeforeIndex, getCaretPosition, getCharacterAttribute, getCharacterBounds, getCharCount, getIndexAtPoint, getSelectedText, getSelectionEnd, getSelectionStart

Method Detail

getLinkCount

public int getLinkCount()

Enabled: Returns the number of links within this hypertext document.

Returns:

number of links in this hypertext doc.

getLink

public AccessibleHyperlink getLink(int linkIndex)

Enabled: Returns the nth Link of this Hypertext document.

Parameters:

linkIndex - within the links of this Hypertext

Returns:

Link object encapsulating the nth link(s)

getLinkIndex

public int getLinkIndex(int charIndex)

Enabled: Returns the index into an array of hyperlinks that is associated with this character index, or -1 if there is no hyperlink associated with this index.

Parameters:

charIndex - index within the text

Returns:

index into the set of hyperlinks for this hypertext doc.