/*
 * Copyright (c) 2000, 2006, Oracle and/or its affiliates. All rights reserved.
 * ORACLE PROPRIETARY/CONFIDENTIAL. Use is subject to license terms.
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 */

package javax.accessibility;

import java.util.*;
import java.awt.*;
import javax.swing.text.*;

/**
 * <P>The AccessibleEditableText interface should be implemented by all
 * classes that present editable textual information on the display.
 * Along with the AccessibleText interface, this interface provides
 * the standard mechanism for an assistive technology to access
 * that text via its content, attributes, and spatial location.
 * Applications can determine if an object supports the AccessibleEditableText
 * interface by first obtaining its AccessibleContext (see {@link Accessible})
 * and then calling the {@link AccessibleContext#getAccessibleEditableText}
 * method of AccessibleContext. If the return value is not null, the object
 * supports this interface.
 *
 * @see Accessible
 * @see Accessible#getAccessibleContext
 * @see AccessibleContext
 * @see AccessibleContext#getAccessibleText
 * @see AccessibleContext#getAccessibleEditableText
 *
 * @author Lynn Monsanto
 * @since 1.4
 */

public interface AccessibleEditableText extends AccessibleText {

 /**
 * Sets the text contents to the specified string.
 *
 * @param s the string to set the text contents
 */
 public void setTextContents(String s);

 /**
 * Inserts the specified string at the given index/
 *
 * @param index the index in the text where the string will
 * be inserted
 * @param s the string to insert in the text
 */
 public void insertTextAtIndex(int index, String s);

 /**
 * Returns the text string between two indices.
 *
 * @param startIndex the starting index in the text
 * @param endIndex the ending index in the text
 * @return the text string between the indices
 */
 public String getTextRange(int startIndex, int endIndex);

 /**
 * Deletes the text between two indices
 *
 * @param startIndex the starting index in the text
 * @param endIndex the ending index in the text
 */
 public void delete(int startIndex, int endIndex);

 /**
 * Cuts the text between two indices into the system clipboard.
 *
 * @param startIndex the starting index in the text
 * @param endIndex the ending index in the text
 */
 public void cut(int startIndex, int endIndex);

 /**
 * Pastes the text from the system clipboard into the text
 * starting at the specified index.
 *
 * @param startIndex the starting index in the text
 */
 public void paste(int startIndex);

 /**
 * Replaces the text between two indices with the specified
 * string.
 *
 * @param startIndex the starting index in the text
 * @param endIndex the ending index in the text
 * @param s the string to replace the text between two indices
 */
 public void replaceText(int startIndex, int endIndex, String s);

 /**
 * Selects the text between two indices.
 *
 * @param startIndex the starting index in the text
 * @param endIndex the ending index in the text
 */
 public void selectText(int startIndex, int endIndex);

 /**
 * Sets attributes for the text between two indices.
 *
 * @param startIndex the starting index in the text
 * @param endIndex the ending index in the text
 * @param as the attribute set
 * @see AttributeSet
 */
 public void setAttributes(int startIndex, int endIndex, AttributeSet as);

}