<html> <head> <title>Interface XAccessibleHyperlink</title> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <link rel="stylesheet" type="text/css" href="../../../../idl.css"> </head> <body> <div id="adc-idlref"> <a name="_top_"> </a><table class="navimain" border="0" cellpadding="3"> <tr> <td class="navimain"><a href="../module-ix.html" class="navimain">Overview</a></td> <td class="navimain"><a href="module-ix.html" class="navimain">Module</a></td> <td class="navimain"><a href="XAccessibleHyperlink-xref.html" class="navimain">Use</a></td> <td class="navimain"><a href="http://wiki.services.openoffice.org/wiki/Documentation/DevGuide/Accessibility/XAccessibleHyperlink" class="navimain">Devguide</a></td> <td class="navimain"><a href="../../../../index-files/index-1.html" class="navimain">Index</a></td> </tr> </table> <table class="navisub" border="0" cellpadding="0"> <tr> <td class="navisub"><a href="#MethodsSummary" class="navisub">Methods' Summary</a></td> <td class="navisub">Attributes' Summary</td> <td class="navisub"><a href="#MethodsDetails" class="navisub">Methods' Details</a></td> <td class="navisub">Attributes' Details</td> </tr> </table> <hr> <table border="0" width="100%" cellpadding="5" cellspacing="3" class="title-table" style="margin-bottom:6pt;"> <tr> <td><p class="namechain"><a href="../../../../module-ix.html" class="namechain">::</a> <a href="../../../module-ix.html" class="namechain">com</a> :: <a href="../../module-ix.html" class="namechain">sun</a> :: <a href="../module-ix.html" class="namechain">star</a> :: <a href="module-ix.html" class="namechain">accessibility</a> :: </p> </td> </tr> <tr> <td class="title">interface XAccessibleHyperlink</td> </tr> <tr> <td><dl> <dt><b>Base Interfaces</b></dt> <dd><pre style="font-family:monospace;"><strong>XAccessibleHyperlink</strong> ┗ <a href="XAccessibleAction.html">XAccessibleAction</a> </pre></dd> <dd><a name/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="crosstitle"> <tr> <td class="imsum_left"><a href="XAccessibleAction.html">XAccessibleAction</a></td> <td class="imsum_right"><dl> <dt>(referenced interface's summary:)</dt> <dd>Implement this interface to give access to actions that can be executed for accessible objects. </dd> </dl> </td> </tr> </table> </dd> </dl> </td> </tr> <tr> <td><dl> <dt><b>Description</b></dt> <dd>Implement this interface to represent a hyperlink or a group of hyperlinks. </dd> <dd><p>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 <a href="XAccessibleAction.html">XAccessibleAction</a> interface. Especially that interface's <a href="XAccessibleAction.html">XAccessibleAction</a>::<a href="XAccessibleAction.html#getActionCount">getActionCount</a> method is needed to obtain a maximum value for the indices passed to the <a href="XAccessibleHyperlink.html#getAccessibleActionAnchor">getAccessibleActionAnchor</a> and <a href="XAccessibleHyperlink.html#getAccessibleActionObject">getAccessibleActionObject</a> methods.</p> <p>Furhtermore, the object that implements this interface has to be connected implicitely or explicitely with an object that implements the the <a href="XAccessibleText.html">XAccessibleText</a> interface. The <a href="XAccessibleHyperlink.html#getStartIndex">getStartIndex</a> and <a href="XAccessibleHyperlink.html#getEndIndex">getEndIndex</a> methods return indices with respect to the text exposed by that interface.</p> </dd> <dt><b>Since </b></dt> <dd>OpenOffice 1.1.2</dd> </dl> <a name="devmanual"> </a><dl> <dt><b>Developers Guide</b></dt> <dd><a href="http://wiki.services.openoffice.org/wiki/Documentation/DevGuide/Accessibility/XAccessibleHyperlink">Accessibility - XAccessibleHyperlink</a></dd> </dl> </td> </tr> </table> <hr> <a name="MethodsSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Methods' Summary</td> </tr> <tr> <td class="imsum_left"><a href="#getAccessibleActionAnchor">getAccessibleActionAnchor</a></td> <td class="imsum_right">Returns an object that represents the link anchor, as appropriate for that link. </td> </tr> <tr> <td class="imsum_left"><a href="#getAccessibleActionObject">getAccessibleActionObject</a></td> <td class="imsum_right">Returns an object that represents the link anchor, as appropriate for that link. </td> </tr> <tr> <td class="imsum_left"><a href="#getStartIndex">getStartIndex</a></td> <td class="imsum_right">Returns the index at which the textual representation of the hyperlink (group) starts. </td> </tr> <tr> <td class="imsum_left"><a href="#getEndIndex">getEndIndex</a></td> <td class="imsum_right">Returns the index at which the textual rerpesentation of the hyperlink (group) ends. </td> </tr> <tr> <td class="imsum_left"><a href="#isValid">isValid</a></td> <td class="imsum_right">Returns whether the document referenced by this links is still valid. </td> </tr> </table> <a name="MethodsDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle">Methods' Details</td> </tr> <tr> <td class="imdetail"><a name="getAccessibleActionAnchor" class="membertitle">getAccessibleActionAnchor</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">any</td> </tr> <tr> <td valign="top"><b>getAccessibleActionAnchor</b>(</td> <td valign="top">[in] long</td> <td valign="bottom"> nIndex )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2">::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IndexOutOfBoundsException.html">IndexOutOfBoundsException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Returns an object that represents the link anchor, as appropriate for that link. </dd> <dd><p>For an HTML link for example, this method would return the string enclosed by the <&a href> tag.</p> </dd> <dt><b>Parameter nIndex</b></dt> <dd>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 <a href="XAccessibleAction.html">XAccessibleAction</a>::<a href="XAccessibleAction.html#getActionCount">getActionCount</a> method. </dd> <dt><b>Returns</b></dt> <dd>If the index is not valid then an exception is thrown. Otherwise it returns an implementation dependent value. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getAccessibleActionObject" class="membertitle">getAccessibleActionObject</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">any</td> </tr> <tr> <td valign="top"><b>getAccessibleActionObject</b>(</td> <td valign="top">[in] long</td> <td valign="bottom"> nIndex )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2">::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IndexOutOfBoundsException.html">IndexOutOfBoundsException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Returns an object that represents the link anchor, as appropriate for that link. </dd> <dd><p>For an HTML link for example, this method would return the URL of the <&a href> tag.</p> </dd> <dt><b>Parameter nIndex</b></dt> <dd>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 <a href="XAccessibleAction.html">XAccessibleAction</a>::<a href="XAccessibleAction.html#getActionCount">getActionCount</a> method. </dd> <dt><b>Returns</b></dt> <dd>If the index is not valid then an exception is thrown. Otherwise it returns an implementation dependent value. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getStartIndex" class="membertitle">getStartIndex</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">long</td> </tr> <tr> <td valign="top"><b>getStartIndex</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Returns the index at which the textual representation of the hyperlink (group) starts. </dd> <dd><p>The returned value relates to the <a href="XAccessibleText.html">XAccessibleText</a> interface that ownes this hyperlink.</p> </dd> <dt><b>Returns</b></dt> <dd>The index relates to the text exposed by the <a href="XAccessibleHypertext.html">XAccessibleHypertext</a> interface. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getEndIndex" class="membertitle">getEndIndex</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">long</td> </tr> <tr> <td valign="top"><b>getEndIndex</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Returns the index at which the textual rerpesentation of the hyperlink (group) ends. </dd> <dd><p>The returned value relates to the <a href="XAccessibleText.html">XAccessibleText</a> interface that ownes this hyperlink.</p> </dd> <dt><b>Returns</b></dt> <dd>The index relates to the text exposed by the <a href="XAccessibleText.html">XAccessibleText</a> interface. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="isValid" class="membertitle">isValid</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">boolean</td> </tr> <tr> <td valign="top"><b>isValid</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Returns whether the document referenced by this links is still valid. </dd> <dd><p>This is a volatile state that may change without further warning like e.g. sending an appropriate event.</p> </dd> <dt><b>Returns</b></dt> <dd>Returns <b>true</b> if the referenced document is still valid and <b>false</b> otherwise. </dd> </dl> </td> </tr> </table> </td> </tr> </table> <a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright © 2011, Oracle and/or its affiliates. All rights reserved. Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.</p> </div> <!-- id="adc-idlref" --> </body> </html>
distrib
>
Mandriva
>
current
>
i586
>
media
>
main-updates
>
by-pkgid
>
fc480f9d5aabed8eeaffe8ad3401a94c
>
files
>
619
