1. /*

  2.  * @(#)AccessibleHypertext.java	1.5 01/11/29

  3.  *

  4.  * Copyright 2002 Sun Microsystems, Inc. All rights reserved.

  5.  * SUN PROPRIETARY/CONFIDENTIAL. Use is subject to license terms.

  6.  */

  7. 

  8. package javax.accessibility;

  9. 

  10. 

  11. import java.lang.*;

  12. import java.util.*;

  13. import java.awt.*;

  14. import javax.swing.text.*;

  15. 

  16. 

  17. /**

  18.  * <P>The AccessibleHypertext class is the base class for all

  19.  * classes that present hypertext information on the display.  This class

  20.  * provides the standard mechanism for an assistive technology to access

  21.  * that text via its content, attributes, and spatial location.

  22.  * It also provides standard mechanisms for manipulating hyperlinks.

  23.  * Applications can determine if an object supports the AccessibleHypertext

  24.  * interface by first obtaining its AccessibleContext (see {@link Accessible})

  25.  * and then calling the {@link AccessibleContext#getAccessibleText}

  26.  * method of AccessibleContext.  If the return value is a class which extends

  27.  * AccessibleHypertext, then that object supports AccessibleHypertext.

  28.  *

  29.  * @see Accessible

  30.  * @see Accessible#getAccessibleContext

  31.  * @see AccessibleContext

  32.  * @see AccessibleText

  33.  * @see AccessibleContext#getAccessibleText

  34.  *

  35.  * @version

  36.  * @author	Peter Korn

  37.  */

  38. public interface AccessibleHypertext extends AccessibleText {

  39. 

  40.     /**

  41.      * Returns the number of links within this hypertext doc.

  42.      *

  43.      * @return number of links in this hypertext doc.

  44.      */

  45.     public abstract int getLinkCount();

  46. 

  47.     /**

  48.      * Returns the nth Link of this Hypertext document.

  49.      *

  50.      * @param linkIndex within the links of this Hypertext

  51.      * @return Link object encapsulating the nth link(s)

  52.      */

  53.     public abstract AccessibleHyperlink getLink(int linkIndex);

  54. 

  55.     /**

  56.      * Returns the index into an array of hyperlinks that

  57.      * is associated with this character index, or -1 if there

  58.      * is no hyperlink associated with this index.

  59.      *

  60.      * @param charIndex index within the text

  61.      * @return index into the set of hyperlinks for this hypertext doc.

  62.      */

  63.     public abstract int getLinkIndex(int charIndex);

  64. }