javax.accessibility
Interface AccessibleHypertext

All Superinterfaces:
AccessibleText sample code for javax.accessibility.AccessibleText definition code for javax.accessibility.AccessibleText
All Known Implementing Classes:
JEditorPane.JEditorPaneAccessibleHypertextSupport sample code for javax.swing.JEditorPane.JEditorPaneAccessibleHypertextSupport definition code for javax.swing.JEditorPane.JEditorPaneAccessibleHypertextSupport

public interface AccessibleHypertext
extends AccessibleText sample code for javax.accessibility.AccessibleText definition code for javax.accessibility.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 Accessible sample code for javax.accessibility.Accessible definition code for javax.accessibility.Accessible ) and then calling the AccessibleContext.getAccessibleText() sample code for javax.accessibility.AccessibleContext.getAccessibleText() definition code for javax.accessibility.AccessibleContext.getAccessibleText() method of AccessibleContext. If the return value is a class which extends AccessibleHypertext, then that object supports AccessibleHypertext.

See Also:
Accessible sample code for javax.accessibility.Accessible definition code for javax.accessibility.Accessible , Accessible.getAccessibleContext() sample code for javax.accessibility.Accessible.getAccessibleContext() definition code for javax.accessibility.Accessible.getAccessibleContext() , AccessibleContext sample code for javax.accessibility.AccessibleContext definition code for javax.accessibility.AccessibleContext , AccessibleText sample code for javax.accessibility.AccessibleText definition code for javax.accessibility.AccessibleText , AccessibleContext.getAccessibleText() sample code for javax.accessibility.AccessibleContext.getAccessibleText() definition code for javax.accessibility.AccessibleContext.getAccessibleText()

Field Summary
 
Fields inherited from interface javax.accessibility.AccessibleText sample code for javax.accessibility.AccessibleText definition code for javax.accessibility.AccessibleText
CHARACTER sample code for javax.accessibility.AccessibleText.CHARACTER definition code for javax.accessibility.AccessibleText.CHARACTER , SENTENCE sample code for javax.accessibility.AccessibleText.SENTENCE definition code for javax.accessibility.AccessibleText.SENTENCE , WORD sample code for javax.accessibility.AccessibleText.WORD definition code for javax.accessibility.AccessibleText.WORD
 
Method Summary
 AccessibleHyperlink sample code for javax.accessibility.AccessibleHyperlink definition code for javax.accessibility.AccessibleHyperlink getLink sample code for javax.accessibility.AccessibleHypertext.getLink(int) definition code for javax.accessibility.AccessibleHypertext.getLink(int) (int linkIndex)
          Returns the nth Link of this Hypertext document.
 int getLinkCount sample code for javax.accessibility.AccessibleHypertext.getLinkCount() definition code for javax.accessibility.AccessibleHypertext.getLinkCount() ()
          Returns the number of links within this hypertext document.
 int getLinkIndex sample code for javax.accessibility.AccessibleHypertext.getLinkIndex(int) definition code for javax.accessibility.AccessibleHypertext.getLinkIndex(int) (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 interface javax.accessibility.AccessibleText sample code for javax.accessibility.AccessibleText definition code for javax.accessibility.AccessibleText
getAfterIndex sample code for javax.accessibility.AccessibleText.getAfterIndex(int, int) definition code for javax.accessibility.AccessibleText.getAfterIndex(int, int) , getAtIndex sample code for javax.accessibility.AccessibleText.getAtIndex(int, int) definition code for javax.accessibility.AccessibleText.getAtIndex(int, int) , getBeforeIndex sample code for javax.accessibility.AccessibleText.getBeforeIndex(int, int) definition code for javax.accessibility.AccessibleText.getBeforeIndex(int, int) , getCaretPosition sample code for javax.accessibility.AccessibleText.getCaretPosition() definition code for javax.accessibility.AccessibleText.getCaretPosition() , getCharacterAttribute sample code for javax.accessibility.AccessibleText.getCharacterAttribute(int) definition code for javax.accessibility.AccessibleText.getCharacterAttribute(int) , getCharacterBounds sample code for javax.accessibility.AccessibleText.getCharacterBounds(int) definition code for javax.accessibility.AccessibleText.getCharacterBounds(int) , getCharCount sample code for javax.accessibility.AccessibleText.getCharCount() definition code for javax.accessibility.AccessibleText.getCharCount() , getIndexAtPoint sample code for javax.accessibility.AccessibleText.getIndexAtPoint(java.awt.Point) definition code for javax.accessibility.AccessibleText.getIndexAtPoint(java.awt.Point) , getSelectedText sample code for javax.accessibility.AccessibleText.getSelectedText() definition code for javax.accessibility.AccessibleText.getSelectedText() , getSelectionEnd sample code for javax.accessibility.AccessibleText.getSelectionEnd() definition code for javax.accessibility.AccessibleText.getSelectionEnd() , getSelectionStart sample code for javax.accessibility.AccessibleText.getSelectionStart() definition code for javax.accessibility.AccessibleText.getSelectionStart()
 

Method Detail

getLinkCount sample code for javax.accessibility.AccessibleHypertext.getLinkCount() definition code for javax.accessibility.AccessibleHypertext.getLinkCount()

int getLinkCount()
Returns the number of links within this hypertext document.

Returns:
number of links in this hypertext doc.

getLink sample code for javax.accessibility.AccessibleHypertext.getLink(int) definition code for javax.accessibility.AccessibleHypertext.getLink(int)

AccessibleHyperlink sample code for javax.accessibility.AccessibleHyperlink definition code for javax.accessibility.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)

getLinkIndex sample code for javax.accessibility.AccessibleHypertext.getLinkIndex(int) definition code for javax.accessibility.AccessibleHypertext.getLinkIndex(int)

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.