Dead
[official-gcc.git] / gomp-20050608-branch / libjava / classpath / javax / accessibility / AccessibleHypertext.java
blobc70357272fca3ccb2d527cc346e9e50fe0fc1b48
1 /* AccessibleHypertext.java -- aids in accessibly rendering hypertext
2 Copyright (C) 2000, 2002, 2005 Free Software Foundation, Inc.
4 This file is part of GNU Classpath.
6 GNU Classpath is free software; you can redistribute it and/or modify
7 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)
9 any later version.
11 GNU Classpath is distributed in the hope that it will be useful, but
12 WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with GNU Classpath; see the file COPYING. If not, write to the
18 Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
19 02110-1301 USA.
21 Linking this library statically or dynamically with other modules is
22 making a combined work based on this library. Thus, the terms and
23 conditions of the GNU General Public License cover the whole
24 combination.
26 As a special exception, the copyright holders of this library give you
27 permission to link this library with independent modules to produce an
28 executable, regardless of the license terms of these independent
29 modules, and to copy and distribute the resulting executable under
30 terms of your choice, provided that you also meet, for each linked
31 independent module, the terms and conditions of the license of that
32 module. An independent module is a module which is not derived from
33 or based on this library. If you modify this library, you may extend
34 this exception to your version of the library, but you are not
35 obligated to do so. If you do not wish to do so, delete this
36 exception statement from your version. */
39 package javax.accessibility;
41 /**
42 * Objects which present hyperlinks in a document should implement this
43 * interface. Accessibility software can use the implementations of this
44 * interface to aid the user in navigating the links.
46 * <p>The <code>AccessibleContext.getAccessibleText()</code> method
47 * should return an instance of this interface only when it is supported.
49 * @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
57 public interface AccessibleHypertext extends AccessibleText
59 /**
60 * Returns the number of links in the document, if any exist.
62 * @return the number of links, or -1
64 int getLinkCount();
66 /**
67 * Returns link object denoted by the number <code>i</code> in this
68 * document, or null if i is out of bounds.
70 * @param i the ith hyperlink of the document
71 * @return link object denoted by <code>i</code>
73 AccessibleHyperlink getLink(int i);
75 /**
76 * Returns the link index for this character index if it resides within
77 * one of the hyperlinks of the document. If no association exists at that
78 * character, or c is out of bounds, returns -1.
80 * @param c the character index
81 * @return the link index, or -1
83 int getLinkIndex(int c);
84 } // interface AccessibleHypertext