AccessibleHyperlink (Java SE 15 & JDK 15) (original) (raw)

All Implemented Interfaces:

[AccessibleAction](AccessibleAction.html "interface in javax.accessibility")

Direct Known Subclasses:

[JEditorPane.JEditorPaneAccessibleHypertextSupport.HTMLLink](../swing/JEditorPane.JEditorPaneAccessibleHypertextSupport.HTMLLink.html "class in javax.swing")

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

• Constructor Summary

Constructors

• Method Summary

Methods declared in class java.lang.Object

[clone](../../../java.base/java/lang/Object.html#clone%28%29), [equals](../../../java.base/java/lang/Object.html#equals%28java.lang.Object%29), [finalize](../../../java.base/java/lang/Object.html#finalize%28%29), [getClass](../../../java.base/java/lang/Object.html#getClass%28%29), [hashCode](../../../java.base/java/lang/Object.html#hashCode%28%29), [notify](../../../java.base/java/lang/Object.html#notify%28%29), [notifyAll](../../../java.base/java/lang/Object.html#notifyAll%28%29), [toString](../../../java.base/java/lang/Object.html#toString%28%29), [wait](../../../java.base/java/lang/Object.html#wait%28%29), [wait](../../../java.base/java/lang/Object.html#wait%28long%29), [wait](../../../java.base/java/lang/Object.html#wait%28long,int%29)

• Constructor Details

  • AccessibleHyperlink

  public AccessibleHyperlink()

• 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](AccessibleAction.html#getAccessibleActionCount%28%29) in interface [AccessibleAction](AccessibleAction.html "interface in javax.accessibility")
  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](AccessibleAction.html#doAccessibleAction%28int%29) in interface [AccessibleAction](AccessibleAction.html "interface in javax.accessibility")
  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: Accessibility this method would return "Accessibility".
  Similarly, from this HTML: this method would return "top hat"
  Specified by:
  [getAccessibleActionDescription](AccessibleAction.html#getAccessibleActionDescription%28int%29) in interface [AccessibleAction](AccessibleAction.html "interface in javax.accessibility")
  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: Accessibility 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: Accessibility this method would return a String containing the text: "Accessibility".
  Similarly, from this HTML: 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