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 inherited from interface javax.accessibility.AccessibleAction CLICK, DECREMENT, INCREMENT, TOGGLE_EXPAND, TOGGLE_POPUP

Constructor Summary
Constructors
Constructor and Description

AccessibleHyperlink()

AccessibleHyperlink (Java Platform SE 7 ) Home of API Java Contents Haut

Method Summary

Methods
Modifier and Type	Method and 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.
`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).

AccessibleHyperlink (Java Platform SE 7 ) Home of API Java Contents Haut

Methods inherited from class java.lang.Object clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - AccessibleHyperlink
    public AccessibleHyperlink()
- Method Detail
  - 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="https://www.gaudry.be/en/java-api/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" rel="nofollow">Accessibility</a> this method would return a String containing the text: "Accessibility". Similarly, from this HTML: <a HREF="#top"><img src="https://www.gaudry.be/en/java-api/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

Document created the 11/06/2005, last modified the 04/03/2020
Source of the printed document:https://www.gaudry.be/en/java-api-rf-javax/accessibility/accessiblehyperlink.html

The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.

References

Manuel PHP : https://docs.oracle.com

These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author This site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.

Contents Haut

Class AccessibleHyperlink

References