Overview | Module | Use | Devguide | Index

Methods' Summary | Attributes' Summary | Methods' Details | Attributes' Details

:: com :: sun :: star :: accessibility ::
unpublished | interface XAccessibleHyperlink |
  Base Interfaces
      XAccessibleHyperlink
      ┗ XAccessibleAction
  XAccessibleAction | (referenced interface's summary:) Implement this interface to give access to actions that can be executed for accessible objects.
Usage Restrictions not published 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. Furthermore, the object that implements this interface has to be connected implicitly or explicitly 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. Since OOo 1.1.2

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 representation of the hyperlink (group) ends.
isValid | Returns whether the document referenced by this links is still valid.

Methods' Details
getAccessibleActionAnchor
any
getAccessibleActionAnchor( | [in] long | nIndex )
raises( | ::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 determined 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 | nIndex )
raises( | ::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 determined 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
long
getStartIndex();
Description Returns the index at which the textual representation of the hyperlink (group) starts. The returned value relates to the XAccessibleText interface that owns this hyperlink. Returns The index relates to the text exposed by the XAccessibleHypertext interface.
getEndIndex
long
getEndIndex();
Description Returns the index at which the textual representation of the hyperlink (group) ends. The returned value relates to the XAccessibleText interface that owns this hyperlink. Returns The index relates to the text exposed by the XAccessibleText interface.
isValid
boolean
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 © 2000, 2013 LibreOffice contributors and/or their affiliates. All rights reserved.

LibreOffice was created by The Document Foundation, based on OpenOffice.org, which is Copyright 2000, 2010 Oracle and/or its affiliates.

The Document Foundation acknowledges all community members, please find more info at our website.

Privacy Policy | Impressum (Legal Info) | Copyright information: The source code of LibreOffice is licensed under the GNU Lesser General Public License (LGPLv3). "LibreOffice" and "The Document Foundation" are registered trademarks of their corresponding registered owners or are in actual use as trademarks in one or more countries. Their respective logos and icons are also subject to international copyright laws. Use thereof is explained in our trademark policy.