:: drafts :: com :: sun :: star :: accessibility ::
|
interface XAccessibleHyperlink |
- Base Hierarchy
::com::sun::star::uno::XInterface
|
+-XAccessibleAction
|
+-XAccessibleHyperlink
|
- Description
- Implement this interface to represent a hyperlink or a group of
hyperlinks.
Single hyperlinks correspond to simple <a href> tags. Groups
of hyperlinks are contained in client side image maps. Linked objects
and anchors are implementation dependent. This interface inherits the
XAccessibleAction interface. Especially that interface's
XAccessibleAction::getActionCount method is needed to
obtain a maximum value for the indices passed to the
getAccessibleActionAnchor and
getAccessibleActionObject
methods.
Furhtermore, the object that implements this interface has to be
connected implicitely or explicitely with an object that implements the
the XAccessibleText interface. The
getStartIndex and
getEndIndex methods return
indices with respect to the text exposed by that interface.
|
Methods' Summary |
getAccessibleActionAnchor |
Returns an object that represents the link anchor, as appropriate
for that link.
|
getAccessibleActionObject |
Returns an object that represents the link anchor, as appropriate
for that link.
|
getStartIndex |
Returns the index at which the textual representation of the
hyperlink (group) starts.
|
getEndIndex |
Returns the index at which the textual rerpesentation of the
hyperlink (group) ends.
|
isValid |
Returns whether the document referenced by this links is
still valid.
|
Methods' Details |
getAccessibleActionAnchor
any
getAccessibleActionAnchor( |
[in] long
raises(
|
nIndex )
::com::sun::star::lang::IndexOutOfBoundsException ); |
- Description
- Returns an object that represents the link anchor, as appropriate
for that link.
For an HTML link for example, this method would return the string
enclosed by the <&a href> tag.
- Parameter nIndex
-
This 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 can be determinded by calling
the XAccessibleAction::getActionCount method.
- Returns
-
If the index is not valid then an exception is thrown.
Otherwise it returns an implementation dependent value.
|
|
getAccessibleActionObject
any
getAccessibleActionObject( |
[in] long
raises(
|
nIndex )
::com::sun::star::lang::IndexOutOfBoundsException ); |
- Description
- Returns an object that represents the link anchor, as appropriate
for that link.
For an HTML link for example, this method would return the URL of
the <&a href> tag.
- Parameter nIndex
-
This index identifies the action object when, as in the case of
an image map, there is more than one link represented by this
object. The valid maximal index can be determinded by calling
the XAccessibleAction::getActionCount method.
- Returns
-
If the index is not valid then an exception is thrown.
Otherwise it returns an implementation dependent value.
|
|
getStartIndex
- Description
- Returns the index at which the textual representation of the
hyperlink (group) starts.
The returned value relates to the XAccessibleText
interface of the AccessibleHypertext service that ownes
this hyperlink.
- Returns
-
The index relates to the text exposed by the
::XAccessibleHyperText interface.
|
|
getEndIndex
- Description
- Returns the index at which the textual rerpesentation of the
hyperlink (group) ends.
The returned value relates to the XAccessibleText
interface of the AccessibleHypertext service that ownes
this hyperlink.
- Returns
-
The index relates to the text exposed by the
XAccessibleText interface.
|
|
isValid
- Description
- Returns whether the document referenced by this links is
still valid.
This is a volatile state that may change without further warning
like e.g. sending an appropriate event.
- Returns
-
Returns true if the referenced document is still valid and
false otherwise.
|
|
Top of Page
Copyright © 2003 Sun Microsystems, Inc.