APIdia Launch Partner
Top Description Constructors Methods
javax.accessibility

public abstract Class AccessibleHyperlink

extends Object
implements AccessibleAction
Class Inheritance
All Implemented Interfaces
javax.accessibility.AccessibleAction
Known Direct Subclasses
javax.swing.JEditorPane.JEditorPaneAccessibleHypertextSupport.HTMLLink

Encapsulation of a link, or set of links (e.g. client side imagemap) in a Hypertext document
Author
Peter Korn
See Also
Accessible, Accessible#getAccessibleContext, AccessibleContext, AccessibleText, AccessibleContext#getAccessibleText

Constructor Summary

AccessConstructor and Description

Method Summary

Modifier and TypeMethod and Description
public abstract boolean

Returns:

true if the action was performed; otherwise false
doAccessibleAction
(int
zero-based index of actions
i
)

Redeclares javax.accessibility.AccessibleAction.doAccessibleAction.

Performs the specified action on the object.

public abstract Object

Returns:

an object representing the hypertext anchor
getAccessibleActionAnchor
(int
zero-based index of the actions
i
)

Returns an object that represents the link anchor, as appropriate for that link.

public abstract int

Returns:

the zero-based number of actions in this object
getAccessibleActionCount
()

Redeclares javax.accessibility.AccessibleAction.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).

public abstract String

Returns:

a string description of the action
getAccessibleActionDescription
(int
zero-based index of the actions
i
)

Redeclares javax.accessibility.AccessibleAction.getAccessibleActionDescription.

Returns a string description of this particular link action.

public abstract Object

Returns:

an object representing the hypertext link itself
getAccessibleActionObject
(int
zero-based index of the actions
i
)

Returns an object that represents the link action, as appropriate for that link.

public abstract int

Returns:

index of end of link
getEndIndex
()

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

public abstract int

Returns:

index of start of link
getStartIndex
()

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

public abstract boolean

Returns:

a flag indicating whether this link is still valid with respect to the AccessibleHypertext it belongs to
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).

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Constructor Detail

Method Detail

doAccessibleActionback to summary
public abstract boolean doAccessibleAction(int i)

Redeclares javax.accessibility.AccessibleAction.doAccessibleAction.

Performs the specified action on the object.

Parameters
i:int

zero-based index of actions

Returns:boolean

true if the action was performed; otherwise false

See Also
getAccessibleActionCount
getAccessibleActionAnchorback to summary
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:int

zero-based index of the actions

Returns:Object

an object representing the hypertext anchor

See Also
getAccessibleActionCount
getAccessibleActionCountback to summary
public abstract int getAccessibleActionCount()

Redeclares javax.accessibility.AccessibleAction.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.

Returns:int

the zero-based number of actions in this object

getAccessibleActionDescriptionback to summary
public abstract String getAccessibleActionDescription(int i)

Redeclares javax.accessibility.AccessibleAction.getAccessibleActionDescription.

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"

Parameters
i:int

zero-based index of the actions

Returns:String

a string description of the action

See Also
getAccessibleActionCount
getAccessibleActionObjectback to summary
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:int

zero-based index of the actions

Returns:Object

an object representing the hypertext link itself

See Also
getAccessibleActionCount
getEndIndexback to summary
public abstract int getEndIndex()

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

Returns:int

index of end of link

getStartIndexback to summary
public abstract int getStartIndex()

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

Returns:int

index of start of link

isValidback to summary
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:boolean

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