org.eclipse.swt.events.SelectionListener Maven / Gradle / Ivy

/*******************************************************************************
 * Copyright (c) 2000, 2016 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
 *     Lars Vogel   - Bug 441116
 *******************************************************************************/
package org.eclipse.swt.events;


import java.util.function.*;

import org.eclipse.swt.internal.*;

/**
 * Classes which implement this interface provide methods
 * that deal with the events that are generated when selection
 * occurs in a control.
 * 
 * After creating an instance of a class that implements
 * this interface it can be added to a control using the
 * addSelectionListener method and removed using
 * the removeSelectionListener method. When
 * selection occurs in a control the appropriate method
 * will be invoked.
 * 
 *
 * @see SelectionAdapter
 * @see SelectionEvent
 */
public interface SelectionListener extends SWTEventListener {

/**
 * Sent when selection occurs in the control.
 * 
 * For example, selection occurs in a List when the user selects
 * an item or items with the keyboard or mouse.  On some platforms,
 * the event occurs when a mouse button or key is pressed.  On others,
 * it happens when the mouse or key is released.  The exact key or
 * mouse gesture that causes this event is platform specific.
 * 
 *
 * @param e an event containing information about the selection
 */
public void widgetSelected(SelectionEvent e);

/**
 * Sent when default selection occurs in the control.
 * 
 * For example, on some platforms default selection occurs in a List
 * when the user double-clicks an item or types return in a Text.
 * On some platforms, the event occurs when a mouse button or key is
 * pressed.  On others, it happens when the mouse or key is released.
 * The exact key or mouse gesture that causes this event is platform
 * specific.
 * 
 *
 * @param e an event containing information about the default selection
 */
public void widgetDefaultSelected(SelectionEvent e);



/**
 * Static helper method to create a SelectionListener for the
 * {@link #widgetSelected(SelectionEvent e)}) method, given a lambda expression
 * or a method reference.
 *
 * @param c the consumer of the event
 * @return SelectionListener
 * @since 3.106
 */
public static SelectionListener widgetSelectedAdapter(Consumer c) {
	return new SelectionAdapter() {
		@Override
		public void widgetSelected(SelectionEvent e) {
			c.accept(e);
		}
	};
}

/**
 * Static helper method to create a SelectionListener for the
 * {@link #widgetDefaultSelected(SelectionEvent e)}) method, given a lambda expression
 * or a method reference.
 *
 * @param c the consumer of the event
 * @return SelectionListener
 * @since 3.106
*/
public static SelectionListener widgetDefaultSelectedAdapter(Consumer c) {
	return new SelectionAdapter() {
		@Override
		public void widgetDefaultSelected(SelectionEvent e) {
			c.accept(e);
		}
	};
}

}