org.eclipse.actf.accservice.core.win32.ia2
Class IA2AccessibleHyperlink

java.lang.Object
  extended by org.eclipse.actf.accservice.core.win32.ia2.IA2AccessibleHyperlink

public class IA2AccessibleHyperlink
extends Object

This interface represents hyperlinks. This interface represents a hyperlink associated with a single substring of text or single non-text object. Non-text objects can have either a single link or a collection of links such as when the non-text object is an image map. Linked objects and anchors are implementation dependent. This interface reflects all methods found in IAccessibleAction. IAccessibleAction::nActions indicates the maximum value for the indices used with the methods of this interface. Furthermore, the object that implements this interface has to be connected implicitly or explicitly with an object that implements IAccessibleText. IAccessibleHyperlink::startIndex and IAccessibleHyperlink::endIndex are indices with respect to the text exposed by IAccessibleText.

Author:
Kavitha Teegala
See Also:
IA2Accessible

Constructor Summary
IA2AccessibleHyperlink(int val, IA2Accessible parent)
          Constructor used to create an accessible image object
 
Method Summary
 Object getAnchor(int index)
          Returns an object that represents the link anchor, as appropriate for the link at the specified index.
 Object getAnchorTarget(int index)
          Returns an object that represents the target of the link, as appropriate for the link at the specified index.
 int getEndIndex()
          Returns the index at which the textual rerpesentation of the hyperlink ends.
 int getStartIndex()
          Returns the index at which the textual rerpesentation of the hyperlink starts.
protected  Object internalGetAnchor(int index)
           
protected  Object internalGetAnchorTarget(int index)
           
protected  int internalGetEndIndex()
           
protected  int internalGetStartIndex()
           
protected  boolean internalIsValid()
           
 int internalRef()
          used by native code only.
 boolean isValid()
          Returns whether the target object referenced by this link is still valid.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

IA2AccessibleHyperlink

public IA2AccessibleHyperlink(int val,
                              IA2Accessible parent)
Constructor used to create an accessible image object

Parameters:
image - reference pointer to the IA2Accessible image object
parent - IA2Accessible parent of this object
Method Detail

internalRef

public int internalRef()
used by native code only. Clients should not call directly.

Returns:
ptr address for native object

getAnchor

public Object getAnchor(int index)
Returns an object that represents the link anchor, as appropriate for the link at the specified index.

Parameters:
index- - A 0 based index identifies the anchor when, as in the case of an image map, there is more than one link represented by this object. The valid maximal index is indicated by IAccessibleAction::nActions.

internalGetAnchor

protected Object internalGetAnchor(int index)

getAnchorTarget

public Object getAnchorTarget(int index)
Returns an object that represents the target of the link, as appropriate for the link at the specified index.

Parameters:
index- - A 0 based index identifies the anchor when, as in the case of an image map, there is more than one link represented by this object. The valid maximal index is indicated by IAccessibleAction::nActions.

internalGetAnchorTarget

protected Object internalGetAnchorTarget(int index)

getStartIndex

public int getStartIndex()
Returns the index at which the textual rerpesentation of the hyperlink starts.

Returns:
- The returned value is related to the IAccessibleText interface of the object that owns this hyperlink

internalGetStartIndex

protected int internalGetStartIndex()

getEndIndex

public int getEndIndex()
Returns the index at which the textual rerpesentation of the hyperlink ends.

Returns:
- The returned value is related to the IAccessibleText interface of the object that owns this hyperlink. The character at the index is not part of the hypertext.

internalGetEndIndex

protected int internalGetEndIndex()

isValid

public boolean isValid()
Returns whether the target object referenced by this link is still valid. This is a volatile state that may change without sending an appropriate event. Returns TRUE if the referenced target is still valid and FALSE otherwise.

Returns:

internalIsValid

protected boolean internalIsValid()