001/* AccessibleHypertext.java -- aids in accessibly rendering hypertext
002   Copyright (C) 2000, 2002, 2005  Free Software Foundation, Inc.
003
004This file is part of GNU Classpath.
005
006GNU Classpath is free software; you can redistribute it and/or modify
007it under the terms of the GNU General Public License as published by
008the Free Software Foundation; either version 2, or (at your option)
009any later version.
010
011GNU Classpath is distributed in the hope that it will be useful, but
012WITHOUT ANY WARRANTY; without even the implied warranty of
013MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
014General Public License for more details.
015
016You should have received a copy of the GNU General Public License
017along with GNU Classpath; see the file COPYING.  If not, write to the
018Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
01902110-1301 USA.
020
021Linking this library statically or dynamically with other modules is
022making a combined work based on this library.  Thus, the terms and
023conditions of the GNU General Public License cover the whole
024combination.
025
026As a special exception, the copyright holders of this library give you
027permission to link this library with independent modules to produce an
028executable, regardless of the license terms of these independent
029modules, and to copy and distribute the resulting executable under
030terms of your choice, provided that you also meet, for each linked
031independent module, the terms and conditions of the license of that
032module.  An independent module is a module which is not derived from
033or based on this library.  If you modify this library, you may extend
034this exception to your version of the library, but you are not
035obligated to do so.  If you do not wish to do so, delete this
036exception statement from your version. */
037
038
039package javax.accessibility;
040
041/**
042 * Objects which present hyperlinks in a document should implement this
043 * interface.  Accessibility software can use the implementations of this
044 * interface to aid the user in navigating the links.
045 *
046 * <p>The <code>AccessibleContext.getAccessibleText()</code> method
047 * should return an instance of this interface only when it is supported.
048 *
049 * @author Eric Blake (ebb9@email.byu.edu)
050 * @see Accessible
051 * @see AccessibleContext
052 * @see AccessibleText
053 * @see AccessibleContext#getAccessibleText()
054 * @since 1.2
055 * @status updated to 1.4
056 */
057public interface AccessibleHypertext extends AccessibleText
058{
059  /**
060   * Returns the number of links in the document, if any exist.
061   *
062   * @return the number of links, or -1
063   */
064  int getLinkCount();
065
066  /**
067   * Returns link object denoted by the number <code>i</code> in this
068   * document, or null if i is out of bounds.
069   *
070   * @param i the ith hyperlink of the document
071   * @return link object denoted by <code>i</code>
072   */
073  AccessibleHyperlink getLink(int i);
074
075  /**
076   * Returns the link index for this character index if it resides within
077   * one of the hyperlinks of the document. If no association exists at that
078   * character, or c is out of bounds, returns -1.
079   *
080   * @param c the character index
081   * @return the link index, or -1
082   */
083  int getLinkIndex(int c);
084} // interface AccessibleHypertext