org.eclipse.swt.accessibility.AccessibleEditableTextAdapter Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of org.eclipse.swt.win32.win32.x86 Show documentation
SWT is an open source widget toolkit for Java designed to provide efficient, portable access to the user-interface facilities of the operating systems on which it is implemented.
The newest version!
/*******************************************************************************
 * Copyright (c) 2010, 2011 IBM Corporation and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/
package org.eclipse.swt.accessibility;

/**
 * This adapter class provides default implementations for the
 * methods in the AccessibleEditableTextListener interface.
 * 
 * Classes that wish to deal with AccessibleEditableText events can
 * extend this class and override only the methods that they are
 * interested in.
 * 
 *
 * @see AccessibleEditableTextListener
 * @see AccessibleEditableTextEvent
 * @see AccessibleTextAttributeEvent
 *
 * @since 3.7
 */
public class AccessibleEditableTextAdapter implements AccessibleEditableTextListener {
	/**
	 * Copies the substring beginning at the specified start offset
	 * and extending to the character at offset end - 1 to the clipboard.
	 * 
	 * @param e an event object containing the following information:
	 * [in] start - the 0 based offset of the first character of the substring
	 * 		to be copied to the clipboard
	 * [in] end - the 0 based offset after the last character of the substring
	 * 		to be copied to the clipboard
	 * [out] result - set to {@link ACC#OK} if the operation was completed successfully
	 * 
	 */
	public void copyText(AccessibleEditableTextEvent e) {};

	/**
	 * Moves the substring beginning at the specified start offset
	 * and extending to the character at offset end - 1 to the clipboard.
	 * 
	 * @param e an event object containing the following information:
	 * [in] start - the 0 based offset of the first character of the substring
	 * 		to be moved to the clipboard
	 * [in] end - the 0 based offset after the last character of the substring
	 * 		to be moved to the clipboard
	 * [out] result - set to {@link ACC#OK} if the operation was completed successfully
	 * 
	 */
	public void cutText(AccessibleEditableTextEvent e) {};

	/**
	 * Inserts the text in the clipboard at the leading edge of the specified start offset.
	 * 
	 * @param e an event object containing the following information:
	 * [in] start - the offset at which to insert the text from the clipboard.
	 * 		The valid range is 0..length
	 * [out] result - set to {@link ACC#OK} if the operation was completed successfully
	 * 
	 */
	public void pasteText(AccessibleEditableTextEvent e) {};

	/**
	 * Replaces the substring beginning at the specified start offset
	 * and extending to the character at offset end - 1 by the specified string.
	 * 
	 * This event notification is also used to delete text if string is an empty string,
	 * or to insert text at the leading edge of the specified offset if start and end are equal.
	 * 
	 * 
	 * @param e an event object containing the following information:
	 * [in] start - the 0 based offset of the first character of the substring
	 * 		to be replaced
	 * [in] end - the 0 based offset after the last character of the substring
	 * 		to be replaced
	 * [in] string - the string that replaces the substring beginning at
	 * 		start and extending to end - 1
	 * [out] result - set to {@link ACC#OK} if the operation was completed successfully
	 * 
	 */
	public void replaceText(AccessibleEditableTextEvent e) {};

	/**
	 * Replaces the set of attributes of the substring beginning at the specified start offset
	 * and extending to the character at offset end - 1 by the specified set of attributes.
	 * 
	 * @param e an event object containing the following information:
	 * [in] start - the 0 based offset of the first character of the substring
	 * 		whose attributes are modified
	 * [in] end - the 0 based offset after the last character of the substring
	 * 		whose attributes are modified
	 * [in] textStyle - the TextStyle which contains attributes that replace the old set of attributes.
	 * 		The foreground, background, and font fields of this TextStyle are only valid for the duration of the event.
	 * 		The value of this field may be null if none of the attributes to be set correspond to TextStyle fields.
	 * [in] attributes - an array of alternating key and value Strings that represent the complete
	 * 		set of attributes to replace the old set of attributes.
	 * 		The value of this field may be null if no attributes are to be set.
	 * [out] result - set to {@link ACC#OK} if the operation was completed successfully
	 * 
	 */
	public void setTextAttributes(AccessibleTextAttributeEvent e) {};
}