1. /*

  2.  * @(#)AccessibleHypertext.java	1.8 00/02/02

  3.  *

  4.  * Copyright 1998-2000 Sun Microsystems, Inc. All Rights Reserved.

  5.  * 

  6.  * This software is the proprietary information of Sun Microsystems, Inc.  

  7.  * Use is subject to license terms.

  8.  * 

  9.  */

  10. 

  11. package javax.accessibility;

  12. 

  13. 

  14. import java.lang.*;

  15. import java.util.*;

  16. import java.awt.*;

  17. import javax.swing.text.*;

  18. 

  19. 

  20. /**

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

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

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

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

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

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

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

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

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

  30.  * AccessibleHypertext, then that object supports AccessibleHypertext.

  31.  *

  32.  * @see Accessible

  33.  * @see Accessible#getAccessibleContext

  34.  * @see AccessibleContext

  35.  * @see AccessibleText

  36.  * @see AccessibleContext#getAccessibleText

  37.  *

  38.  * @version

  39.  * @author	Peter Korn

  40.  */

  41. public interface AccessibleHypertext extends AccessibleText {

  42. 

  43.     /**

  44.      * Returns the number of links within this hypertext document.

  45.      *

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

  47.      */

  48.     public abstract int getLinkCount();

  49. 

  50.     /**

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

  52.      *

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

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

  55.      */

  56.     public abstract AccessibleHyperlink getLink(int linkIndex);

  57. 

  58.     /**

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

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

  61.      * is no hyperlink associated with this index.

  62.      *

  63.      * @param charIndex index within the text

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

  65.      */

  66.     public abstract int getLinkIndex(int charIndex);

  67. }