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

Go to download
Show more of this group Show more artifacts with this name
Show all versions of org.eclipse.swt.gtk.linux.ppc64le Show documentation
Standard Widget Toolkit for GTK on ppc64le
The newest version!
/*******************************************************************************
 * Copyright (c) 2000, 2016 IBM Corporation and others.
 *
 * This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License 2.0
 * which accompanies this distribution, and is available at
 * https://www.eclipse.org/legal/epl-2.0/
 *
 * SPDX-License-Identifier: EPL-2.0
 *
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/
package org.eclipse.swt.accessibility;


/**
 * This adapter class provides default implementations for the
 * methods described by the AccessibleTextListener interface.
 * 
 * Classes that wish to deal with AccessibleTextEvents can
 * extend this class and override only the methods that they are
 * interested in.
 * 

 * Note: Accessibility clients use child identifiers to specify
 * whether they want information about a control or one of its children.
 * Child identifiers are increasing integers beginning with 0.
 * The identifier CHILDID_SELF represents the control itself.
 * When returning a child identifier to a client, you may use CHILDID_NONE
 * to indicate that no child or control has the required information.
 * 

 * Note: This adapter is typically used by implementors of
 * a custom control to provide very detailed information about
 * the control instance to accessibility clients.
 * 
 *
 * @see AccessibleTextListener
 * @see AccessibleTextEvent
 * @see Sample code and further information
 *
 * @since 3.0
 */
public abstract class AccessibleTextAdapter implements AccessibleTextListener {

	/**
	 * Sent when an accessibility client requests the current character offset
	 * of the text caret.
	 * The default behavior is to do nothing.
	 * 
	 * Return the caret offset in the offset
	 * field of the event object.
	 * 
	 *
	 * @param e an event object containing the following fields:
	 *    childID [IN] - an identifier specifying a child of the control
	 *    offset [OUT] - the current offset of the text caret
	 * 
	 */
	@Override
	public void getCaretOffset (AccessibleTextEvent e) {
	}

	/**
	 * Sent when an accessibility client requests the range of the current
	 * text selection.
	 * The default behavior is to do nothing.
	 * 
	 * Return the selection start offset and non-negative length in the
	 * offset and length fields of the event object.
	 * 
	 *
	 * @param e an event object containing the following fields:
	 *    childID [IN] - an identifier specifying a child of the control
	 *    offset [OUT] - the offset of the current text selection
	 *    length [OUT] - the length of the current text selection
	 * 
	 */
	@Override
	public void getSelectionRange (AccessibleTextEvent e) {
	}
}