Overview  Package   Class  Use  Deprecated  Index
Home >> All >> javax >> [ accessibility overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

javax.accessibility
Class AccessibleHyperlink  

java.lang.Object
  javax.accessibility.AccessibleHyperlink

All Implemented Interfaces:

AccessibleAction

---

public abstract class AccessibleHyperlink

extends java.lang.Object

implements AccessibleAction

This object encapsulates actions associated with navigating hypertext.

Since:

1.2

---

Field Summary

 

Fields inherited from interface javax.accessibility.AccessibleAction

DECREMENT, INCREMENT, TOGGLE_EXPAND

 

Constructor Summary

AccessibleHyperlink()           The default constructor.

 

Method Summary
abstract  boolean	doAccessibleAction(int i)           Perform the specified action.
abstract  java.lang.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  java.lang.String	getAccessibleActionDescription(int i)           Get the anchor text of the link, or null if the index is out of bounds.
abstract  java.lang.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.

---

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

---

doAccessibleAction

public abstract boolean doAccessibleAction(int i)

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

Specified by:

doAccessibleAction in interface AccessibleAction

---

getAccessibleActionDescription

public abstract java.lang.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

---

getAccessibleActionObject

public abstract java.lang.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/").

---

getAccessibleActionAnchor

public abstract java.lang.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").

---

getStartIndex

public abstract int getStartIndex()

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

---

getEndIndex

public abstract int getEndIndex()

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

---

Overview  Package   Class  Use  Deprecated  Index
Home >> All >> javax >> [ accessibility overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---