org.eclipse.swt.accessibility.AccessibleAttributeAdapter 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) 2009, 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 in the AccessibleAttributeListener interface.
 * 
 * Classes that wish to deal with AccessibleAttribute events can
 * extend this class and override only the methods that they are
 * interested in.
 * 
 *
 * @see AccessibleAttributeListener
 * @see AccessibleAttributeEvent
 * @see AccessibleTextAttributeEvent
 *
 * @since 3.6
 */
public class AccessibleAttributeAdapter implements AccessibleAttributeListener {
	/**
	 * Returns attributes specific to this Accessible object.
	 *
	 * @param e an event object containing the following fields:
	 * [out] topMargin - the top margin in pixels
	 * [out] bottomMargin - the bottom margin in pixels
	 * [out] leftMargin - the left margin in pixels
	 * [out] rightMargin - the right margin in pixels
	 * [out] tabStops - an array of pixel locations
	 * [out] justify - whether or not to justify the text
	 * [out] alignment - one of SWT#LEFT, SWT#RIGHT or SWT#CENTER
	 * [out] indent - the indent in pixels
	 * [out] groupLevel - the level of this accessible in its group
	 * [out] groupCount - the number of similar children in this accessible's group
	 * [out] groupIndex - the index of this accessible in its group
	 * [out] attributes - an array of alternating key and value Strings
	 * 		which represent additional (i.e. non predefined) attributes
	 * 
	 */
	@Override
	public void getAttributes(AccessibleAttributeEvent e) {}

	/**
	 * Returns text attributes specific to this Accessible object.
	 *
	 * @param e an event object containing the following fields:
	 * [in] offset - the 0 based text offset for which to return attribute information
	 * [out] start - the 0 based starting offset of the character range
	 * 		over which all text attributes match those of offset
	 * [out] end - the 0 based offset after the last character of the character range
	 * 		over which all text attributes match those of offset
	 * [out] textStyle - the TextStyle of the character range
	 * [out] attributes - an array of alternating key and value Strings
	 * 		that represent additional attributes that do not correspond to TextStyle fields
	 * 
	 */
	@Override
	public void getTextAttributes(AccessibleTextAttributeEvent e) {}
}