javax.accessibility
Class AccessibleHyperlink

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

public abstract class AccessibleHyperlink
extends Object sample code for java.lang.Object definition code for java.lang.Object
implements AccessibleAction sample code for javax.accessibility.AccessibleAction definition code for javax.accessibility.AccessibleAction

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

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.AccessibleAction sample code for javax.accessibility.AccessibleAction definition code for javax.accessibility.AccessibleAction
DECREMENT sample code for javax.accessibility.AccessibleAction.DECREMENT definition code for javax.accessibility.AccessibleAction.DECREMENT , INCREMENT sample code for javax.accessibility.AccessibleAction.INCREMENT definition code for javax.accessibility.AccessibleAction.INCREMENT , TOGGLE_EXPAND sample code for javax.accessibility.AccessibleAction.TOGGLE_EXPAND definition code for javax.accessibility.AccessibleAction.TOGGLE_EXPAND
 
Constructor Summary
AccessibleHyperlink sample code for javax.accessibility.AccessibleHyperlink.AccessibleHyperlink() definition code for javax.accessibility.AccessibleHyperlink.AccessibleHyperlink() ()
           
 
Method Summary
abstract  boolean doAccessibleAction sample code for javax.accessibility.AccessibleHyperlink.doAccessibleAction(int) definition code for javax.accessibility.AccessibleHyperlink.doAccessibleAction(int) (int i)
          Performs the specified Action on the object
abstract  Object sample code for java.lang.Object definition code for java.lang.Object getAccessibleActionAnchor sample code for javax.accessibility.AccessibleHyperlink.getAccessibleActionAnchor(int) definition code for javax.accessibility.AccessibleHyperlink.getAccessibleActionAnchor(int) (int i)
          Returns an object that represents the link anchor, as appropriate for that link.
abstract  int getAccessibleActionCount sample code for javax.accessibility.AccessibleHyperlink.getAccessibleActionCount() definition code for javax.accessibility.AccessibleHyperlink.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.
abstract  String sample code for java.lang.String definition code for java.lang.String getAccessibleActionDescription sample code for javax.accessibility.AccessibleHyperlink.getAccessibleActionDescription(int) definition code for javax.accessibility.AccessibleHyperlink.getAccessibleActionDescription(int) (int i)
          Returns a String description of this particular link action.
abstract  Object sample code for java.lang.Object definition code for java.lang.Object getAccessibleActionObject sample code for javax.accessibility.AccessibleHyperlink.getAccessibleActionObject(int) definition code for javax.accessibility.AccessibleHyperlink.getAccessibleActionObject(int) (int i)
          Returns an object that represents the link action, as appropriate for that link.
abstract  int getEndIndex sample code for javax.accessibility.AccessibleHyperlink.getEndIndex() definition code for javax.accessibility.AccessibleHyperlink.getEndIndex() ()
          Gets the index with the hypertext document at which this link ends
abstract  int getStartIndex sample code for javax.accessibility.AccessibleHyperlink.getStartIndex() definition code for javax.accessibility.AccessibleHyperlink.getStartIndex() ()
          Gets the index with the hypertext document at which this link begins
abstract  boolean isValid sample code for javax.accessibility.AccessibleHyperlink.isValid() definition code for javax.accessibility.AccessibleHyperlink.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 inherited from class java.lang.Object sample code for java.lang.Object definition code for java.lang.Object
clone sample code for java.lang.Object.clone() definition code for java.lang.Object.clone() , equals sample code for java.lang.Object.equals(java.lang.Object) definition code for java.lang.Object.equals(java.lang.Object) , finalize sample code for java.lang.Object.finalize() definition code for java.lang.Object.finalize() , getClass sample code for java.lang.Object.getClass() definition code for java.lang.Object.getClass() , hashCode sample code for java.lang.Object.hashCode() definition code for java.lang.Object.hashCode() , notify sample code for java.lang.Object.notify() definition code for java.lang.Object.notify() , notifyAll sample code for java.lang.Object.notifyAll() definition code for java.lang.Object.notifyAll() , toString sample code for java.lang.Object.toString() definition code for java.lang.Object.toString() , wait sample code for java.lang.Object.wait() definition code for java.lang.Object.wait() , wait sample code for java.lang.Object.wait(long) definition code for java.lang.Object.wait(long) , wait sample code for java.lang.Object.wait(long, int) definition code for java.lang.Object.wait(long, int)
 

Constructor Detail

AccessibleHyperlink sample code for javax.accessibility.AccessibleHyperlink() definition code for javax.accessibility.AccessibleHyperlink()

public AccessibleHyperlink()
Method Detail

isValid sample code for javax.accessibility.AccessibleHyperlink.isValid() definition code for javax.accessibility.AccessibleHyperlink.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 sample code for javax.accessibility.AccessibleHyperlink.getAccessibleActionCount() definition code for javax.accessibility.AccessibleHyperlink.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 sample code for javax.accessibility.AccessibleAction.getAccessibleActionCount() definition code for javax.accessibility.AccessibleAction.getAccessibleActionCount() in interface AccessibleAction sample code for javax.accessibility.AccessibleAction definition code for javax.accessibility.AccessibleAction
Returns:
the zero-based number of Actions in this object

doAccessibleAction sample code for javax.accessibility.AccessibleHyperlink.doAccessibleAction(int) definition code for javax.accessibility.AccessibleHyperlink.doAccessibleAction(int)

public abstract boolean doAccessibleAction(int i)
Performs the specified Action on the object

Specified by:
doAccessibleAction sample code for javax.accessibility.AccessibleAction.doAccessibleAction(int) definition code for javax.accessibility.AccessibleAction.doAccessibleAction(int) in interface AccessibleAction sample code for javax.accessibility.AccessibleAction definition code for javax.accessibility.AccessibleAction
Parameters:
i - zero-based index of actions
Returns:
true if the action was performed; otherwise false.
See Also:
getAccessibleActionCount() sample code for javax.accessibility.AccessibleHyperlink.getAccessibleActionCount() definition code for javax.accessibility.AccessibleHyperlink.getAccessibleActionCount()

getAccessibleActionDescription sample code for javax.accessibility.AccessibleHyperlink.getAccessibleActionDescription(int) definition code for javax.accessibility.AccessibleHyperlink.getAccessibleActionDescription(int)

public abstract String sample code for java.lang.String definition code for java.lang.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 sample code for javax.accessibility.AccessibleAction.getAccessibleActionDescription(int) definition code for javax.accessibility.AccessibleAction.getAccessibleActionDescription(int) in interface AccessibleAction sample code for javax.accessibility.AccessibleAction definition code for javax.accessibility.AccessibleAction
Parameters:
i - zero-based index of the actions
Returns:
a String description of the action
See Also:
getAccessibleActionCount() sample code for javax.accessibility.AccessibleHyperlink.getAccessibleActionCount() definition code for javax.accessibility.AccessibleHyperlink.getAccessibleActionCount()

getAccessibleActionObject sample code for javax.accessibility.AccessibleHyperlink.getAccessibleActionObject(int) definition code for javax.accessibility.AccessibleHyperlink.getAccessibleActionObject(int)

public abstract Object sample code for java.lang.Object definition code for java.lang.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() sample code for javax.accessibility.AccessibleHyperlink.getAccessibleActionCount() definition code for javax.accessibility.AccessibleHyperlink.getAccessibleActionCount()

getAccessibleActionAnchor sample code for javax.accessibility.AccessibleHyperlink.getAccessibleActionAnchor(int) definition code for javax.accessibility.AccessibleHyperlink.getAccessibleActionAnchor(int)

public abstract Object sample code for java.lang.Object definition code for java.lang.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() sample code for javax.accessibility.AccessibleHyperlink.getAccessibleActionCount() definition code for javax.accessibility.AccessibleHyperlink.getAccessibleActionCount()

getStartIndex sample code for javax.accessibility.AccessibleHyperlink.getStartIndex() definition code for javax.accessibility.AccessibleHyperlink.getStartIndex()

public abstract int getStartIndex()
Gets the index with the hypertext document at which this link begins

Returns:
index of start of link

getEndIndex sample code for javax.accessibility.AccessibleHyperlink.getEndIndex() definition code for javax.accessibility.AccessibleHyperlink.getEndIndex()

public abstract int getEndIndex()
Gets the index with the hypertext document at which this link ends

Returns:
index of end of link