Class AccessibleHyperlink

java.lang.Object

javax.accessibility.AccessibleHyperlink

All Implemented Interfaces:

AccessibleAction

Direct Known Subclasses:

JEditorPane.JEditorPaneAccessibleHypertextSupport.HTMLLink

public abstract class AccessibleHyperlink
extends Object
implements AccessibleAction

Encapsulation of a link, or set of links (e.g. client side imagemap) in a Hypertext document

See Also:

• Accessible
• Accessible.getAccessibleContext()
• AccessibleContext
• AccessibleText
• AccessibleContext.getAccessibleText()

Field Summary

Fields declared in interface AccessibleAction

CLICK, DECREMENT, INCREMENT, TOGGLE_EXPAND, TOGGLE_POPUP

Modifier and Type	Field	Description
static final String	CLICK	An action which causes a component to execute its default action.
static final String	DECREMENT	An action which decrements a value.
static final String	INCREMENT	An action which increments a value.
static final String	TOGGLE_EXPAND	An action which causes a tree node to collapse if expanded and expand if collapsed.
static final String	TOGGLE_POPUP	An action which causes a popup to become visible if it is hidden and hidden if it is visible.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AccessibleHyperlink()	Constructor for subclasses to call.

Method Summary

Modifier and Type	Method	Description
abstract boolean	doAccessibleAction(int i)	Performs the specified action on the object.
abstract Object	getAccessibleActionAnchor(int i)	Returns an object that represents the link anchor, as appropriate for that link.
abstract int	getAccessibleActionCount()	Returns the number of accessible actions available in this Link If there are more than one, the first one is NOT considered the "default" action of this LINK object (e.g. in an HTML imagemap).
abstract String	getAccessibleActionDescription(int i)	Returns a string description of this particular link action.
abstract Object	getAccessibleActionObject(int i)	Returns an object that represents the link action, as appropriate for that link.
abstract int	getEndIndex()	Gets the index with the hypertext document at which this link ends.
abstract int	getStartIndex()	Gets the index with the hypertext document at which this link begins.
abstract boolean	isValid()	Since the document a link is associated with may have changed, this method returns whether or not this Link is still valid (with respect to the document it references).

Methods declared in class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Modifier and Type	Method	Description
protected Object	clone()	Answers a new instance of the same class as the receiver, whose slots have been filled in with the values in the slots of the receiver.
boolean	equals(Object o)	Compares the argument to the receiver, and answers true if they represent the same object using a class specific comparison.
protected void	finalize()	Deprecated, for removal: This API element is subject to removal in a future version. May cause performance issues, deadlocks and hangs.
final Class<? extends Object>	getClass()	Answers the unique instance of java.lang.Class which represents the class of the receiver.
int	hashCode()	Answers an integer hash code for the receiver.
final void	notify()	Causes one thread which is waiting on the receiver to be made ready to run.
final void	notifyAll()	Causes all threads which are waiting on the receiver to be made ready to run.
String	toString()	Answers a string containing a concise, human-readable description of the receiver.
final void	wait()	Causes the thread which sent this message to be made not ready to run pending some change in the receiver (as indicated by notify or notifyAll).
final void	wait(long time)	Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by notify or notifyAll) or the expiration of the timeout.
final void	wait(long time, int frac)	Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by notify or notifyAll) or the expiration of the timeout.

Constructor Details

AccessibleHyperlink

protected AccessibleHyperlink()

Constructor for subclasses to call.

Method Details

isValid

public abstract boolean isValid()

Since the document a link is associated with may have changed, this method returns whether or not this Link is still valid (with respect to the document it references).

Returns:

a flag indicating whether this link is still valid with respect to the AccessibleHypertext it belongs to

getAccessibleActionCount

public abstract int getAccessibleActionCount()

Returns the number of accessible actions available in this Link If there are more than one, the first one is NOT considered the "default" action of this LINK object (e.g. in an HTML imagemap). In general, links will have only one AccessibleAction in them.

Specified by:

getAccessibleActionCount in interface AccessibleAction

Returns:

the zero-based number of actions in this object

doAccessibleAction

public abstract boolean doAccessibleAction(int i)

Performs the specified action on the object.

Specified by:

doAccessibleAction in interface AccessibleAction

Parameters:

i - zero-based index of actions

Returns:

true if the action was performed; otherwise false

See Also:

• getAccessibleActionCount()

getAccessibleActionDescription

public abstract String getAccessibleActionDescription(int i)

Returns a string description of this particular link action. This should be a text string associated with anchoring text, this should be the anchor text. E.g. from HTML: <a HREF="http://www.sun.com/access">Accessibility</a> this method would return "Accessibility".

Similarly, from this HTML: <a HREF="#top"><img src="top-hat.gif" alt="top hat"></a> this method would return "top hat"

Specified by:

getAccessibleActionDescription in interface AccessibleAction

Parameters:

i - zero-based index of the actions

Returns:

a string description of the action

See Also:

• getAccessibleActionCount()

getAccessibleActionObject

public abstract Object getAccessibleActionObject(int i)

Returns an object that represents the link action, as appropriate for that link. E.g. from HTML: <a HREF="http://www.sun.com/access">Accessibility</a> this method would return a java.net.URL("http://www.sun.com/access.html");

Parameters:

i - zero-based index of the actions

Returns:

an object representing the hypertext link itself

See Also:

• getAccessibleActionCount()

getAccessibleActionAnchor

public abstract Object getAccessibleActionAnchor(int i)

Returns an object that represents the link anchor, as appropriate for that link. E.g. from HTML: <a href="http://www.sun.com/access">Accessibility</a> this method would return a String containing the text: "Accessibility".

Similarly, from this HTML: <a HREF="#top"><img src="top-hat.gif" alt="top hat"></a> this might return the object ImageIcon("top-hat.gif", "top hat");

Parameters:

i - zero-based index of the actions

Returns:

an object representing the hypertext anchor

See Also:

• getAccessibleActionCount()

getStartIndex

public abstract int getStartIndex()

Gets the index with the hypertext document at which this link begins.

Returns:

index of start of link

getEndIndex

public abstract int getEndIndex()

Gets the index with the hypertext document at which this link ends.

Returns:

index of end of link