APIdia Launch Partner
Top Description Fields Methods
javax.accessibility

public Interface AccessibleHypertext

extends AccessibleText
Known Direct Implementers
javax.swing.JEditorPane.JEditorPaneAccessibleHypertextSupport

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.
Author
Peter Korn
See Also
Accessible, Accessible#getAccessibleContext, AccessibleContext, AccessibleText, AccessibleContext#getAccessibleText

Field Summary

Inherited from javax.accessibility.AccessibleText:
CHARACTERSENTENCEWORD

Method Summary

Modifier and TypeMethod and Description
public int

Returns:

number of links in this hypertext doc
getLinkCount
()

Returns the number of links within this hypertext document.

public int

Returns:

index into the set of hyperlinks for this hypertext doc
getLinkIndex
(int
index within the text
charIndex
)

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.

Inherited from javax.accessibility.AccessibleText:
getAfterIndexgetAtIndexgetBeforeIndexgetCaretPositiongetCharacterAttributegetCharacterBoundsgetCharCountgetIndexAtPointgetSelectedTextgetSelectionEndgetSelectionStart

Method Detail

getLinkCountback to summary
public int getLinkCount()

Returns the number of links within this hypertext document.

Returns:int

number of links in this hypertext doc

getLinkIndexback to summary
public int getLinkIndex(int charIndex)

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:int

index within the text

Returns:int

index into the set of hyperlinks for this hypertext doc