English:

The Free and Open Productivity Suite
New: Apache OpenOffice 4.1.1 released!

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous


:: com :: sun :: star :: accessibility ::

interface XAccessibleHypertext
Base Interfaces
XAccessibleHypertextXAccessibleText

XAccessibleText
(referenced interface's summary:)
Implement this interface to give read-only access to a text.
Description
Implement this interface to expose the hypertext structure of a document.

The XAccessibleHypertext interface is the main interface to expose hyperlinks in a document, typically a text document, that are used to reference other (parts of) documents. For supporting the getLinkIndex method of this interface and other character related methods of the XAccessibleHyperlink interface, it is necessary to also support the XAccessibleText interface.

Since
OOo 1.1.2
See also
XAccessibleHyperlink,
XAccessibleText
Developers Guide
Accessibility - XAccessibleHypertext

Methods' Summary
getHyperLinkCount Returns the number of links and link groups contained within this hypertext document.  
getHyperLink Return the specified link.  
getHyperLinkIndex Returns the index of the hyperlink that is associated with this character index.  
Methods' Details
getHyperLinkCount
long
getHyperLinkCount();

Description
Returns the number of links and link groups contained within this hypertext document.
Returns
The number of links and link groups within this hypertext document. Returns 0 if there is no link.
getHyperLink
XAccessibleHyperlink
getHyperLink( [in] long  nLinkIndex )
raises( ::com::sun::star::lang::IndexOutOfBoundsException );

Description
Return the specified link.

The returned XAccessibleHyperlink object encapsulates the hyperlink and provides several kinds of information describing it.

Parameter nLinkIndex
This index specifies the hyperlink to return.
Returns
If the given index is valid, i.e. lies in the intervall from 0 to the number of links minus one, a reference to the specified hyperlink object is returned. If the index is invalid then an empty reference is returned.
getHyperLinkIndex
long
getHyperLinkIndex( [in] long  nCharIndex )
raises( ::com::sun::star::lang::IndexOutOfBoundsException );

Description
Returns the index of the hyperlink that is associated with this character index.

In a HTML document this is the case when a <a href> tag spans (includes) the given character index.

Parameter nCharIndex
Index of the character for which to return the link index. If the XAccessibleText interface is used to represent the text containting the link, then the character index is only valid if it is greater than or equal to zero and lower then the number of characters in the text. See that interface's documentation for more details.
Returns
Returns the index of the hyperlink that is associated with this character index, or throws an exception if there is no hyperlink associated with this index.
See also
XAccessibleText.
Top of Page

Logo ApacheCon Europe 2014

Apache Feather

Copyright & License | Privacy | Website Feedback | Contact Us | Donate | Thanks

Apache, the Apache feather logo, and OpenOffice are trademarks of The Apache Software Foundation. OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.