org.eclipse.jface.viewers.ICellEditorListener Maven / Gradle / Ivy
The newest version!
/*******************************************************************************
* 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.jface.viewers;
/**
* A listener which is notified of significant events in the
* life of a cell editor.
*
* This interface should be implemented by classes that wish to
* react to cell editor activity.
*
*
* Note: the cell editor is not passed as a parameter to any
* of these methods; so the assumption is that the listener
* knows which cell editor is talking to it.
*
*/
public interface ICellEditorListener {
/**
* Notifies that the end user has requested applying a value.
* All cell editors send this notification.
*
* The normal reaction is to update the model with the current cell editor value.
* However, if the value is not valid, it should not be applied.
* A typical text-based cell editor would send this message
* when the end user hits Return, whereas other editors would
* send it whenever their value changes.
*
*/
public void applyEditorValue();
/**
* Notifies that the end user has canceled editing.
* All cell editors send this notification.
* A listener should not update the model based on this
* notification; see applyEditorValue.
*/
public void cancelEditor();
/**
* Notifies that the end user is changing the value in the cell editor. This
* notification is normally sent only by text-based editors in response to a
* keystroke, so that the listener may show an error message reflecting the
* current valid state. This notification is sent while the value is being
* actively edited, before the value is applied or canceled. A listener should
* not update the model based on this notification; see
* applyEditorValue.
*
* If the newValidState parameter is true,
* the new value may be retrieved by calling ICellEditor.getValue
* on the appropriate cell editor.
*
*
* @param oldValidState the valid state before the end user changed the value
* @param newValidState the current valid state
*/
public void editorValueChanged(boolean oldValidState, boolean newValidState);
}