Difference between revisions of "Documentation/DevGuide/Accessibility/XAccessibleHyperlink"

From Apache OpenOffice Wiki
Jump to: navigation, search
m (1 revision(s))
m
Line 9: Line 9:
 
{{DISPLAYTITLE:XAccessibleHyperlink}}
 
{{DISPLAYTITLE:XAccessibleHyperlink}}
 
<!--<idltopic>com.sun.star.accessibility.XAccessibleHyperlink</idltopic>-->
 
<!--<idltopic>com.sun.star.accessibility.XAccessibleHyperlink</idltopic>-->
Hyperlinks contained in a hypertext document are modeled by the <idls>com.sun.star.accessibility.XAccessibleHyperlink</idls> interface. In its simplest form, a hyperlink corresponds to an HTML link. However, there may be more complex hyperlinks where there is more than one action assigned to a single hyperlink. An example of this is HTML image maps. To give access to the actions, the interface is derived from the <idl>com.sun.star.accessibility.XAccessibleAction</idl> interface. In addition to the information provided by the <idl>com.sun.star.accessibility.XAccessibleAction</idl> interface, you can request an action's anchor and object. A typical return value of the <idlm>com.sun.star.accessibility.XAccessibleHyperlink:getAccessibleActionAnchor</idlm>() function for HTML links would be the text between the <code><a href...></code> and <code></a></code> tags. Likewise, the [http://api.openoffice.org/docs/common/ref/com/sun/star/accessibility/XAccessibleHyperlink.html#getAccessibleActionObject com.sun.star.accessibility.XAccessibleHyperlink:getAccessibleActionObject]() function returns a HTML link's URL.
+
Hyperlinks contained in a hypertext document are modeled by the <idls>com.sun.star.accessibility.XAccessibleHyperlink</idls> interface. In its simplest form, a hyperlink corresponds to an HTML link. However, there may be more complex hyperlinks where there is more than one action assigned to a single hyperlink. An example of this is HTML image maps. To give access to the actions, the interface is derived from the <idl>com.sun.star.accessibility.XAccessibleAction</idl> interface. In addition to the information provided by the <idl>com.sun.star.accessibility.XAccessibleAction</idl> interface, you can request an action's anchor and object. A typical return value of the <idlm>com.sun.star.accessibility.XAccessibleHyperlink:getAccessibleActionAnchor</idlm>() function for HTML links would be the text between the <code><a href...></code> and <code></a></code> tags. Likewise, the <idlml>com.sun.star.accessibility.XAccessibleHyperlink:getAccessibleActionObject</idlml>() function returns a HTML link's URL.
  
 
A hyperlink specifies its text relative to the enclosing hypertext by providing a start- and end index through the <idlm>com.sun.star.accessibility.XAccessibleHyperlink:getStartIndex</idlm>() and <idlm>com.sun.star.accessibility.XAccessibleHyperlink:getEndIndex</idlm>() functions. You can ask a link about the validity of the referenced target by calling its <idlm>com.sun.star.accessibility.XAccessibleHyperlink:isValid</idlm>() function. Note that this state is volatile and may change without notice.
 
A hyperlink specifies its text relative to the enclosing hypertext by providing a start- and end index through the <idlm>com.sun.star.accessibility.XAccessibleHyperlink:getStartIndex</idlm>() and <idlm>com.sun.star.accessibility.XAccessibleHyperlink:getEndIndex</idlm>() functions. You can ask a link about the validity of the referenced target by calling its <idlm>com.sun.star.accessibility.XAccessibleHyperlink:isValid</idlm>() function. Note that this state is volatile and may change without notice.

Revision as of 19:51, 14 April 2008



Hyperlinks contained in a hypertext document are modeled by the XAccessibleHyperlink interface. In its simplest form, a hyperlink corresponds to an HTML link. However, there may be more complex hyperlinks where there is more than one action assigned to a single hyperlink. An example of this is HTML image maps. To give access to the actions, the interface is derived from the com.sun.star.accessibility.XAccessibleAction interface. In addition to the information provided by the com.sun.star.accessibility.XAccessibleAction interface, you can request an action's anchor and object. A typical return value of the getAccessibleActionAnchor() function for HTML links would be the text between the <a href...> and </a> tags. Likewise, the <idlml>com.sun.star.accessibility.XAccessibleHyperlink:getAccessibleActionObject</idlml>() function returns a HTML link's URL.

A hyperlink specifies its text relative to the enclosing hypertext by providing a start- and end index through the getStartIndex() and getEndIndex() functions. You can ask a link about the validity of the referenced target by calling its isValid() function. Note that this state is volatile and may change without notice.

Content on this page is licensed under the Public Documentation License (PDL).
Personal tools