Overview | Module | Use | Devguide | Index

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

:: com :: sun :: star :: accessibility ::
interface XAccessibleHypertext
  Base Hierarchy
      ::com::sun::star::uno::XInterface
       |
       +-XAccessibleText
          |
          +-XAccessibleHypertext
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. See also XAccessibleHyperlink, XAccessibleText Since version OpenOffice.org 1.1.1 Developers Guide 17.7.1 Accessibility - Using the Accessibility API - A Simple Screen Reader - Putting the Accessibility Interfaces to Work - 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 raises( | nLinkIndex ) ::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 raises( | nCharIndex ) ::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

Copyright © 2003 Sun Microsystems, Inc.