/[classpath]/classpath/javax/accessibility/AccessibleHypertext.java
ViewVC logotype

Diff of /classpath/javax/accessibility/AccessibleHypertext.java

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 1.3 by mark, Tue Jan 22 22:27:02 2002 UTC revision 1.4 by ericb, Mon Mar 18 22:22:45 2002 UTC
# Line 1  Line 1 
1  /* AccessibleHypertext.java -- Java interface for aiding in accessibly rendering  /* AccessibleHypertext.java -- aids in accessibly rendering hypertext
2     other Java components     Copyright (C) 2000, 2002 Free Software Foundation, Inc.
    Copyright (C) 2000 Free Software Foundation, Inc.  
3    
4  This file is part of GNU Classpath.  This file is part of GNU Classpath.
5    
# Line 8  GNU Classpath is free software; you can Line 7  GNU Classpath is free software; you can
7  it under the terms of the GNU General Public License as published by  it under the terms of the GNU General Public License as published by
8  the Free Software Foundation; either version 2, or (at your option)  the Free Software Foundation; either version 2, or (at your option)
9  any later version.  any later version.
10    
11  GNU Classpath is distributed in the hope that it will be useful, but  GNU Classpath is distributed in the hope that it will be useful, but
12  WITHOUT ANY WARRANTY; without even the implied warranty of  WITHOUT ANY WARRANTY; without even the implied warranty of
13  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
# Line 36  this exception to your version of the li Line 35  this exception to your version of the li
35  obligated to do so.  If you do not wish to do so, delete this  obligated to do so.  If you do not wish to do so, delete this
36  exception statement from your version. */  exception statement from your version. */
37    
38    
39  package javax.accessibility;  package javax.accessibility;
40    
41  /**  /**
42   * Allows an application to determine a set of hyperlinks for a   * Objects which present hyperlinks in a document should implement this
43   * document and manipulate them.   * interface.  Accessibility software can use the implementations of this
44   * <p>   * interface to aid the user in navigating the links.
45   * The <code>AccessibleContext.getAccessibleText()</code> method   *
46   * should return an object which extends <code>AccessibleHypertext</code>   * <p>The <code>AccessibleContext.getAccessibleText()</code> method
47   * if it supports this interface.   * should return an instance of this interface only when it is supported.
48   *.   *
49   * @see AccessibleContext.getAccessibleText()   * @author Eric Blake <ebb9@email.byu.edu>
50     * @see Accessible
51     * @see AccessibleContext
52     * @see AccessibleText
53     * @see AccessibleContext#getAccessibleText()
54     * @since 1.2
55     * @status updated to 1.4
56   */   */
57  public interface AccessibleHypertext extends AccessibleText {  public interface AccessibleHypertext extends AccessibleText
58    {
59      /**    /**
60       * Returns link object denoted by the number <code>i</code> in this     * Returns the number of links in the document, if any exist.
61       * document.     *
62       *     * @return the number of links, or -1
63       * @param i the ith hyperlink of the document     */
64       * @return link object denoted by <code>i</code>    int getLinkCount();
65       */  
66      public abstract AccessibleHyperlink getLink(int i);    /**
67           * Returns link object denoted by the number <code>i</code> in this
68      /**     * document, or null if i is out of bounds.
69       * Returns the number of links in the document if any exist.  When     *
70       * no links exist, returns -1.     * @param i the ith hyperlink of the document
71       *     * @return link object denoted by <code>i</code>
72       * @return the number of links     */
73       */    AccessibleHyperlink getLink(int i);
74      public abstract int getLinkCount();  
75          /**
76      /**     * Returns the link index for this character index if it resides within
77       * Returns the link index for this character index into the     * one of the hyperlinks of the document. If no association exists at that
78       * document if a hyperlink is associated with the character     * character, or c is out of bounds, returns -1.
79       * specified by the given index.  When no association exists,     *
80       * returns -1.     * @param c the character index
81       *     * @return the link index, or -1
82       * @param c the character index     */
83       * @return the link index    int getLinkIndex(int c);
84       */  } // interface AccessibleHypertext
     public abstract int getLinkIndex(int c);  
 }  

Legend:
Removed from v.1.3  
changed lines
  Added in v.1.4

savannah-hackers-public@gnu.org
ViewVC Help
Powered by ViewVC 1.1.26