Eclipse Platform
2.0

org.eclipse.jface.viewers
Interface ICellEditorListener


public interface ICellEditorListener

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.


Method Summary
 void applyEditorValue()
          Notifies that the end user has requested applying a value.
 void cancelEditor()
          Notifies that the end user has canceled editing.
 void editorValueChanged(boolean oldValidState, boolean newValidState)
          Notifies that the end user has changed the value in the cell editor.
 

Method Detail

applyEditorValue

public void applyEditorValue()
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.


cancelEditor

public void cancelEditor()
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.


editorValueChanged

public void editorValueChanged(boolean oldValidState,
                               boolean newValidState)
Notifies that the end user has changed the value in the cell editor. This notification is normally sent only by text-based editors in response to a keystroke, so that interested party may show an error message reflecting the current valid state. 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.

Parameters:
oldValidState - the valid state before the end user changed the value
newValidState - the current valid state

Eclipse Platform
2.0

Copyright (c) IBM Corp. and others 2000, 2002. All Rights Reserved.