javax.accessibility

Class AccessibleHyperlink

Implemented Interfaces:
AccessibleAction
Known Direct Subclasses:
JEditorPane.JEditorPaneAccessibleHypertextSupport.HTMLLink

public abstract class AccessibleHyperlink
extends Object
implements AccessibleAction

This object encapsulates actions associated with navigating hypertext.

Since:
1.2

See Also:
Accessible, AccessibleContext, AccessibleText, AccessibleContext.getAccessibleText()

Constructor Summary

AccessibleHyperlink()
The default constructor.

Method Summary

boolean
doAccessibleAction(int i)
Perform the specified action.
Object
getAccessibleActionAnchor(int i)
Get the anchor appropriate for the link, or null if the index is out of bounds.
int
getAccessibleActionCount()
Get the number possible actions for this object, starting from 0.
String
getAccessibleActionDescription(int i)
Get the anchor text of the link, or null if the index is out of bounds.
Object
getAccessibleActionObject(int i)
Get the link location, or null if the index is out of bounds.
int
getEndIndex()
Gets the character index where this link ends in the parent hypertext document.
int
getStartIndex()
Gets the character index where this link starts in the parent hypertext document.
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 Details

AccessibleHyperlink

public AccessibleHyperlink()
The default constructor.

Method Details

doAccessibleAction

public boolean doAccessibleAction(int i)
Perform the specified action. Does nothing if out of bounds.
Specified by:
doAccessibleAction in interface AccessibleAction

Parameters:
i - the action to perform, 0-based

Returns:
true if the action was performed

See Also:
getAccessibleActionCount()


getAccessibleActionAnchor

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

Parameters:
i - the link to retrieve, 0-based

Returns:
the link anchor object

See Also:
getAccessibleActionCount()


getAccessibleActionCount

public 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

Returns:
the 0-based number of actions


getAccessibleActionDescription

public 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

Parameters:
i - the link to retrieve, 0-based

Returns:
the link anchor text

See Also:
getAccessibleActionCount()


getAccessibleActionObject

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

Parameters:
i - the link to retrieve, 0-based

Returns:
the link location

See Also:
getAccessibleActionCount()


getEndIndex

public int getEndIndex()
Gets the character index where this link ends in the parent hypertext document.

Returns:
the ending index


getStartIndex

public int getStartIndex()
Gets the character index where this link starts in the parent hypertext document.

Returns:
the starting index


isValid

public boolean isValid()
Returns whether the document the link references is still valid, as the association may have changed with a text edit.

Returns:
true if the link is valid with respect to the AccessibleHypertext


AccessibleHyperlink.java -- aids in accessibly navigating hypertext Copyright (C) 2002, 2005 Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.