AccessibleHypertext (Java Platform SE 6)

This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.

Overview

Package

Class

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

javax.accessibility
interface AccessibleHypertext

All Superinterfaces:: AccessibleText

All Known Implementing Classes:: JEditorPane.JEditorPaneAccessibleHypertextSupport

public interface AccessibleHypertext
extends AccessibleText

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 {@link Accessible}) and then calling the {@link AccessibleContext#getAccessibleText} method of AccessibleContext. If the return value is a class which extends AccessibleHypertext, then that object supports AccessibleHypertext.

Field Summary

Fields inherited from class javax.accessibility.AccessibleText
`CHARACTER, SENTENCE, WORD`

Method Summary
`AccessibleHyperlink`	`getLink(int linkIndex)` Returns the nth Link of this Hypertext document.
`int`	`getLinkCount()` Returns the number of links within this hypertext document.
`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.

Methods inherited from class javax.accessibility.AccessibleText
`getAfterIndex, getAtIndex, getBeforeIndex, getCaretPosition, getCharacterAttribute, getCharacterBounds, getCharCount, getIndexAtPoint, getSelectedText, getSelectionEnd, getSelectionStart`

Method Detail

getLink

public AccessibleHyperlink getLink(int linkIndex)

Returns the nth Link of this Hypertext document.

Parameters:: linkIndex - within the links of this Hypertext
Returns:: Link object encapsulating the nth link(s)

getLinkCount

public int getLinkCount()

Returns the number of links within this hypertext document.

Returns:: number of links in this hypertext doc.

getLinkIndex

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 - index within the text
Returns:: index into the set of hyperlinks for this hypertext doc.