JEditorPane.JEditorPaneAccessibleHypertextSupport.HTMLLink (Java Platform SE 6)

This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.

Overview

Package

Class

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

javax.swing
class JEditorPane.JEditorPaneAccessibleHypertextSupport.HTMLLink

java.lang.Object
  javax.accessibility.AccessibleHyperlink
      javax.swing.JEditorPane.JEditorPaneAccessibleHypertextSupport.HTMLLink

All Implemented Interfaces:: AccessibleAction

Enclosing class:: JEditorPane.JEditorPaneAccessibleHypertextSupport

public class JEditorPane.JEditorPaneAccessibleHypertextSupport.HTMLLink
extends AccessibleHyperlink

Constructor Summary
`JEditorPane.JEditorPaneAccessibleHypertextSupport.HTMLLink(Element e)`

Method Summary
`boolean`	`doAccessibleAction(int i)` Perform the specified Action on the object
`Object`	`getAccessibleActionAnchor(int i)` Return an object that represents the link anchor, as appropriate for that link.
`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.
`String`	`getAccessibleActionDescription(int i)` Return a String description of this particular link action.
`Object`	`getAccessibleActionObject(int i)` Returns a URL object that represents the link.
`int`	`getEndIndex()` Get the index with the hypertext document at which this link ends
`int`	`getStartIndex()` Get the index with the hypertext document at which this link begins
`boolean`	`isValid()` Since the document a link is associated with may have changed, this method returns whether this Link is valid anymore (with respect to the document it references).

Methods inherited from class javax.accessibility.AccessibleHyperlink
`doAccessibleAction, getAccessibleActionAnchor, getAccessibleActionCount, getAccessibleActionDescription, getAccessibleActionObject, getEndIndex, getStartIndex, isValid`

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

Constructor Detail

JEditorPane.JEditorPaneAccessibleHypertextSupport.HTMLLink

public JEditorPane.JEditorPaneAccessibleHypertextSupport.HTMLLink(Element e)

Parameters:: e

Method Detail

doAccessibleAction

public boolean doAccessibleAction(int i)

Perform the specified Action on the object

Overrides:: doAccessibleAction in class AccessibleHyperlink
Parameters:: i - zero-based index of actions
Returns:: true if the the action was performed; else false.

getAccessibleActionAnchor

public Object getAccessibleActionAnchor(int i)

Return 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: <a HREF="#top"><img src="top-hat.gif" alt="top hat"></a> this might return the object ImageIcon("top-hat.gif", "top hat");

Overrides:: getAccessibleActionAnchor in class AccessibleHyperlink
Parameters:: i - zero-based index of the actions
Returns:: an Object representing the hypertext anchor

getAccessibleActionCount

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

Overrides:: getAccessibleActionCount in class AccessibleHyperlink
Returns:: the zero-based number of Actions in this object

getAccessibleActionDescription

public String getAccessibleActionDescription(int i)

Return a String description of this particular link action. The string returned is the text within the document associated with the element which contains this link.

Overrides:: getAccessibleActionDescription in class AccessibleHyperlink
Parameters:: i - zero-based index of the actions
Returns:: a String description of the action

getAccessibleActionObject

public Object getAccessibleActionObject(int i)

Returns a URL object that represents the link.

Overrides:: getAccessibleActionObject in class AccessibleHyperlink
Parameters:: i - zero-based index of the actions
Returns:: an URL representing the HTML link itself

getEndIndex

public int getEndIndex()

Get the index with the hypertext document at which this link ends

Overrides:: getEndIndex in class AccessibleHyperlink
Returns:: index of end of link

getStartIndex

public int getStartIndex()

Get the index with the hypertext document at which this link begins

Overrides:: getStartIndex in class AccessibleHyperlink
Returns:: index of start of link

isValid

public boolean isValid()

Since the document a link is associated with may have changed, this method returns whether this Link is valid anymore (with respect to the document it references).

Overrides:: isValid in class AccessibleHyperlink
Returns:: a flag indicating whether this link is still valid with respect to the AccessibleHypertext it belongs to