javax.accessibility
Class AccessibleHyperlink

java.lang.Object
  extended by javax.accessibility.AccessibleHyperlink
All Implemented Interfaces:
AccessibleAction
Direct Known Subclasses:
JEditorPane.JEditorPaneAccessibleHypertextSupport.HTMLLink

public abstract class AccessibleHyperlink
extends Object
implements AccessibleAction

This object encapsulates actions associated with navigating hypertext.

Since:
1.2
See Also:
Accessible, AccessibleContext, AccessibleText, AccessibleContext.getAccessibleText()

Field Summary
 
Fields inherited from interface javax.accessibility.AccessibleAction
CLICK, DECREMENT, INCREMENT, TOGGLE_EXPAND, TOGGLE_POPUP
 
Constructor Summary
AccessibleHyperlink()
          The default constructor.
 
Method Summary
abstract  boolean doAccessibleAction(int i)
          Perform the specified action.
abstract  Object getAccessibleActionAnchor(int i)
          Get the anchor appropriate for the link, or null if the index is out of bounds.
abstract  int getAccessibleActionCount()
          Get the number possible actions for this object, starting from 0.
abstract  String getAccessibleActionDescription(int i)
          Get the anchor text of the link, or null if the index is out of bounds.
abstract  Object getAccessibleActionObject(int i)
          Get the link location, or null if the index is out of bounds.
abstract  int getEndIndex()
          Gets the character index where this link ends in the parent hypertext document.
abstract  int getStartIndex()
          Gets the character index where this link starts in the parent hypertext document.
abstract  boolean isValid()
          Returns whether the document the link references is still valid, as the association may have changed with a text edit.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AccessibleHyperlink

public AccessibleHyperlink()
The default constructor.

Method Detail

isValid

public abstract boolean isValid()
Returns whether the document the link references is still valid, as the association may have changed with a text edit.

Returns:
true if the link is valid with respect to the AccessibleHypertext

getAccessibleActionCount

public abstract int getAccessibleActionCount()
Get the number possible actions for this object, starting from 0. In general, a hypertext link has only one action, except for an image map, so there isn't really a default action.

Specified by:
getAccessibleActionCount in interface AccessibleAction
Returns:
the 0-based number of actions

doAccessibleAction

public abstract boolean doAccessibleAction(int i)
Perform the specified action. Does nothing if out of bounds.

Specified by:
doAccessibleAction in interface AccessibleAction
Parameters:
i - the action to perform, 0-based
Returns:
true if the action was performed
See Also:
getAccessibleActionCount()

getAccessibleActionDescription

public abstract String getAccessibleActionDescription(int i)
Get the anchor text of the link, or null if the index is out of bounds. For example, <a href="http://www.gnu.org/">GNU Home Page</a> would return "GNU Home Page", while <a HREF="#top"> <img src="top-hat.png" alt="top hat"></a> would return "top hat".

Specified by:
getAccessibleActionDescription in interface AccessibleAction
Parameters:
i - the link to retrieve, 0-based
Returns:
the link anchor text
See Also:
getAccessibleActionCount()

getAccessibleActionObject

public abstract Object getAccessibleActionObject(int i)
Get the link location, or null if the index is out of bounds. For example, <a href="http://www.gnu.org/">GNU Home Page</a> would return a java.net.URL("http://www.gnu.org/").

Parameters:
i - the link to retrieve, 0-based
Returns:
the link location
See Also:
getAccessibleActionCount()

getAccessibleActionAnchor

public abstract Object getAccessibleActionAnchor(int i)
Get the anchor appropriate for the link, or null if the index is out of bounds. For example, <a href="http://www.gnu.org/">GNU Home Page </a> would return "GNU Home Page", while <a HREF="#top"> <img src="top-hat.png" alt="top hat"></a> would return an ImageIcon("top-hat.png", "top hat").

Parameters:
i - the link to retrieve, 0-based
Returns:
the link anchor object
See Also:
getAccessibleActionCount()

getStartIndex

public abstract int getStartIndex()
Gets the character index where this link starts in the parent hypertext document.

Returns:
the starting index

getEndIndex

public abstract int getEndIndex()
Gets the character index where this link ends in the parent hypertext document.

Returns:
the ending index