Index (Frames) | Index (No Frames) | Package | Package Tree | Tree
javax.accessibility

Class AccessibleHyperlink

java.lang.Object
|
+--javax.accessibility.AccessibleHyperlink

All Implemented Interfaces:

AccessibleAction


public abstract class AccessibleHyperlink

extends Object

implements AccessibleAction

This object encapsulates actions associated with navigating hypertext.

Since:Author:See Also:

Constructor Summary

AccessibleHyperlink()

The default constructor.

Method Summary

booleandoAccessibleAction(int i)

Perform the specified action.
java.lang.ObjectgetAccessibleActionAnchor(int i)

Get the anchor appropriate for the link, or null if the index is out of bounds.
intgetAccessibleActionCount()

Get the number possible actions for this object, starting from 0.
java.lang.StringgetAccessibleActionDescription(int i)

Get the anchor text of the link, or null if the index is out of bounds.
java.lang.ObjectgetAccessibleActionObject(int i)

Get the link location, or null if the index is out of bounds.
intgetEndIndex()

Gets the character index where this link ends in the parent hypertext document.
intgetStartIndex()

Gets the character index where this link starts in the parent hypertext document.
booleanisValid()

Returns whether the document the link references is still valid, as the association may have changed with a text edit.

Constructor Details

AccessibleHyperlink

public AccessibleHyperlink()

The default constructor.


Method Details

doAccessibleAction

public boolean doAccessibleAction(int i)

Perform the specified action. Does nothing if out of bounds.

Parameters:

Returns:

See Also:


getAccessibleActionAnchor

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

Returns:

See Also:


getAccessibleActionCount

public 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.

Returns:


getAccessibleActionDescription

public 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".

Parameters:

Returns:

See Also:


getAccessibleActionObject

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

Returns:

See Also:


getEndIndex

public int getEndIndex()

Gets the character index where this link ends in the parent hypertext document.

Returns:


getStartIndex

public int getStartIndex()

Gets the character index where this link starts in the parent hypertext document.

Returns:


isValid

public boolean isValid()

Returns whether the document the link references is still valid, as the association may have changed with a text edit.

Returns: