/*
* @(#)AccessibleExtendedText.java 1.2 03/12/19
*
* Copyright 2004 Sun Microsystems, Inc. All rights reserved.
* SUN PROPRIETARY/CONFIDENTIAL. Use is subject to license terms.
*/
package javax.accessibility;
import java.util.*;
import java.awt.*;
import javax.swing.text.*;
/**
* <P>The AccessibleExtendedText interface contains additional methods
* not provided by the AccessibleText interface
*
* Applications can determine if an object supports the AccessibleExtendedText
* interface by first obtaining its AccessibleContext (see {@link Accessible})
* and then calling the {@link AccessibleContext#getAccessibleText} method of
* AccessibleContext. If the return value is an instance of
* AccessibleExtendedText, the object supports this interface.
*
* @see Accessible
* @see Accessible#getAccessibleContext
* @see AccessibleContext
* @see AccessibleContext#getAccessibleText
* @see AccessibleText.AccessibleTextChunk
*
* @version 1.2 12/19/03
* @author Peter Korn
* @author Lynn Monsanto
*/
public interface AccessibleExtendedText {
/**
* Constant used to indicate that the part of the text that should be
* retrieved is a line of text.
*
* @see #getAtIndex
* @see #getAfterIndex
* @see #getBeforeIndex
*/
public static final int LINE = 4; // BugID: 4849720
/**
* Constant used to indicate that the part of the text that should be
* retrieved is contiguous text with the same text attributes.
*
* @see #getAtIndex
* @see #getAfterIndex
* @see #getBeforeIndex
*/
public static final int ATTRIBUTE_RUN = 5; // BugID: 4849720
/**
* Returns the text between two indices
*
* @param startIndex the start index in the text
* @param endIndex the end index in the text
* @return the text string if the indices are valid.
* Otherwise, null is returned.
*/
public String getTextRange(int startIndex, int endIndex);
/**
* Returns the AccessibleTextSequence at a given index.
*
* @param part the CHARACTER, WORD, SENTENCE, LINE or ATTRIBUTE_RUN to
* retrieve
* @param index an index within the text
* @return an AccessibleTextSequence specifying the text if part and index
* are valid. Otherwise, null is returned.
*
* @see AccessibleText.CHARACTER
* @see AccessibleText.WORK
* @see AccessibleText.SENTENCE
*/
public AccessibleTextSequence getTextSequenceAt(int part, int index);
/**
* Returns the AccessibleTextSequence after a given index.
*
* @param part the CHARACTER, WORD, SENTENCE, LINE or ATTRIBUTE_RUN to
* retrieve
* @param index an index within the text
* @return an AccessibleTextSequence specifying the text if part and index
* are valid. Otherwise, null is returned.
*
* @see AccessibleText.CHARACTER
* @see AccessibleText.WORK
* @see AccessibleText.SENTENCE
*/
public AccessibleTextSequence getTextSequenceAfter(int part, int index);
/**
* Returns the AccessibleTextSequence before a given index.
*
* @param part the CHARACTER, WORD, SENTENCE, LINE or ATTRIBUTE_RUN to
* retrieve
* @param index an index within the text
* @return an AccessibleTextSequence specifying the text if part and index
* are valid. Otherwise, null is returned.
*
* @see AccessibleText.CHARACTER
* @see AccessibleText.WORK
* @see AccessibleText.SENTENCE
*/
public AccessibleTextSequence getTextSequenceBefore(int part, int index);
/**
* Returns the bounding rectangle of the text between two indices.
*
* @param startIndex the start index in the text
* @param endIndex the end index in the text
* @return the bounding rectangle of the text if the indices are valid.
* Otherwise, null is returned.
*/
public Rectangle getTextBounds(int startIndex, int endIndex);
}
|