org.eclipse.swt.events.SelectionEvent 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.ppc64 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) 2000, 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.events;


import org.eclipse.swt.widgets.*;

/**
 * Instances of this class are sent as a result of
 * widgets being selected.
 * 
 * Note: The fields that are filled in depend on the widget.
 * 
 *
 * @see SelectionListener
 * @see Sample code and further information
 */

public class SelectionEvent extends TypedEvent {
	
	/**
	 * The item that was selected.
	 */
	public Widget item;
	
	/**
	 * Extra detail information about the selection, depending on the widget.
	 * 
	 * Sash

	 * {@link org.eclipse.swt.SWT#DRAG}
	 * 
ScrollBar and Slider

	 * {@link org.eclipse.swt.SWT#DRAG}
	 * {@link org.eclipse.swt.SWT#HOME}
	 * {@link org.eclipse.swt.SWT#END}
	 * {@link org.eclipse.swt.SWT#ARROW_DOWN}
	 * {@link org.eclipse.swt.SWT#ARROW_UP}
	 * {@link org.eclipse.swt.SWT#PAGE_DOWN}
	 * {@link org.eclipse.swt.SWT#PAGE_UP}
	 * 
Table and Tree

	 * {@link org.eclipse.swt.SWT#CHECK}
	 * 
Text

	 * {@link org.eclipse.swt.SWT#CANCEL}
	 * 
CoolItem and ToolItem

	 * {@link org.eclipse.swt.SWT#ARROW}
	 * 

	 */
	public int detail;

	/**
	 * The x location of the selected area.
	 */
	public int x;
	
	/**
	 * The y location of selected area.
	 */
	public int y;
	
	/**
	 * The width of selected area.
	 */
	public int width;
	
	/**
	 * The height of selected area.
	 */
	public int height;

	/**
	 * The state of the keyboard modifier keys at the time
	 * the event was generated.
	 */
	public int stateMask;

	/**
	 * The text of the hyperlink that was selected.
	 * This will be either the text of the hyperlink or the value of its HREF,
	 * if one was specified.
	 * 
	 * @see org.eclipse.swt.widgets.Link#setText(String)
	 * @since 3.1
	 */
	public String text;
	
	/**
	 * A flag indicating whether the operation should be allowed.
	 * Setting this field to false will cancel the
	 * operation, depending on the widget.
	 */
	public boolean doit;
	
	static final long serialVersionUID = 3976735856884987953L;
	
/**
 * Constructs a new instance of this class based on the
 * information in the given untyped event.
 *
 * @param e the untyped event containing the information
 */
public SelectionEvent(Event e) {
	super(e);
	this.item = e.item;
	this.x = e.x;
	this.y = e.y;
	this.width = e.width;
	this.height = e.height;
	this.detail = e.detail;
	this.stateMask = e.stateMask;
	this.text = e.text;
	this.doit = e.doit;
}

/**
 * Returns a string containing a concise, human-readable
 * description of the receiver.
 *
 * @return a string representation of the event
 */
public String toString() {
	String string = super.toString ();
	return string.substring (0, string.length() - 1) // remove trailing '}'
		+ " item=" + item
		+ " detail=" + detail
		+ " x=" + x
		+ " y=" + y
		+ " width=" + width
		+ " height=" + height
		+ " stateMask=0x" + Integer.toHexString(stateMask)
		+ " text=" + text
		+ " doit=" + doit
		+ "}";
}
}