blob: 2d29ef7d383de76b3f50a778c590a83b7d4925fd [file] [log] [blame]
/*******************************************************************************
* Copyright (c) 2000, 2015 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.ui;
import java.util.EventListener;
import org.eclipse.jface.viewers.ISelection;
/**
* Interface for listening to selection changes.
* <p>
* This interface may be implemented by clients.
* </p>
*
* @see ISelectionService#addSelectionListener(ISelectionListener)
* @see ISelectionService#addSelectionListener(String, ISelectionListener)
* @see org.eclipse.ui.INullSelectionListener
*/
public interface ISelectionListener extends EventListener {
/**
* Notifies this listener that the selection has changed.
* <p>
* <b>Note:</b> it is important that this method returns as quickly as possible
* to avoid UI freezes. For example, do not update the UI if the UI is not
* visible. See the {@link SelectionListenerFactory} for listeners that are
* build for this purpose.
* </p>
* <p>
* This method is called when the selection changes to a <code>non-null</code>
* value, but not when the selection changes to <code>null</code>. If there is a
* requirement to be notified in the latter scenario, implement
* <code>INullSelectionListener</code>. The event will be posted through this
* method.
* </p>
*
* @param part the workbench part containing the selection
* @param selection the current selection. This may be <code>null</code> if
* <code>INullSelectionListener</code> is implemented.
* @see SelectionListenerFactory#createVisibleListener(IWorkbenchPart,
* ISelectionListener)
* @see SelectionListenerFactory#createVisibleSelfMutedListener(IWorkbenchPart,
* ISelectionListener)
*/
void selectionChanged(IWorkbenchPart part, ISelection selection);
}