org.eclipse.nebula.widgets.nattable.edit
Class CellEditorCreatedEvent

java.lang.Object
  org.eclipse.nebula.widgets.nattable.edit.CellEditorCreatedEvent

All Implemented Interfaces:

ILayerEvent

public class CellEditorCreatedEvent
extends Object
implements ILayerEvent

The CellEditorCreatedEvent is fired by the EditController whenever a editor has been created.

Please keep in mind that there is no event fired when the editor is destroyed. Clients should associate a dispose listener to the editor widget to be informed whenever the editor get destroyed.

This event is typically consumed by the NatTable itself to keep track of the active editor. Any other layer may also consume this event to do whatever necessary.

Constructor Summary

CellEditorCreatedEvent(ICellEditor editor)
Creates a new event passing the created editor

Method Summary

ILayerEvent	cloneEvent()
boolean	convertToLocal(ILayer localLayer) Convert the column/row positions carried by the event to the layer about to handle the event.
ICellEditor	getEditor() Returns the editor associated with this event.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CellEditorCreatedEvent

public CellEditorCreatedEvent(ICellEditor editor)

Creates a new event passing the created editor

Parameters:

editor - the new editor

Method Detail

convertToLocal

public boolean convertToLocal(ILayer localLayer)

Description copied from interface: ILayerEvent

Convert the column/row positions carried by the event to the layer about to handle the event.

Specified by:

convertToLocal in interface ILayerEvent

Parameters:

localLayer - layer about to receive the event

Returns:

TRUE if successfully converted, FALSE otherwise

cloneEvent

public ILayerEvent cloneEvent()

Specified by:

cloneEvent in interface ILayerEvent

Returns:

A cloned copy of the event. This cloned copy is provided to each listener.

getEditor

public ICellEditor getEditor()

Returns the editor associated with this event.

Returns:

the created editor