Package org.eclipse.nebula.widgets.nattable.layer.event

Class CellVisualUpdateEvent

java.lang.Object

org.eclipse.nebula.widgets.nattable.layer.event.CellVisualChangeEvent

org.eclipse.nebula.widgets.nattable.layer.event.CellVisualUpdateEvent

All Implemented Interfaces:

ILayerEvent, IVisualChangeEvent

public class CellVisualUpdateEvent
extends CellVisualChangeEvent

Specialization of the CellVisualChangeEvent. The only difference is the handling of this type of event in the NatTable event handling. While the CellVisualChangeEvent causes a whole redraw operation of the visible part (which is necessary to update everything if a data value has change, for example important for conditional styling), this event only forces to redraw the specified cell itself. This is for example necessary for hover styling, where redrawing everything is not necessary and would cause lags in applying hover styling.

Field Summary

Fields inherited from class org.eclipse.nebula.widgets.nattable.layer.event.CellVisualChangeEvent

columnPosition, layer, rowPosition

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CellVisualUpdateEvent(CellVisualChangeEvent event)	Create a new CellVisualUpdateEvent out of the given event.
	CellVisualUpdateEvent(ILayer layer, int columnPosition, int rowPosition)	Create a new CellVisualUpdateEvent based on the given information.

Method Summary

Modifier and Type	Method	Description
CellVisualUpdateEvent	cloneEvent()
boolean	convertToLocal(ILayer localLayer)	Convert the column/row positions carried by the event to the layer about to handle the event.

Methods inherited from class org.eclipse.nebula.widgets.nattable.layer.event.CellVisualChangeEvent

getChangedPositionRectangles, getColumnPosition, getLayer, getRowPosition

Methods inherited from class java.lang.Object

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

Constructor Detail

CellVisualUpdateEvent

public CellVisualUpdateEvent(ILayer layer,
                             int columnPosition,
                             int rowPosition)

Create a new CellVisualUpdateEvent based on the given information.

Parameters:

layer - The layer to which the given column and row position belong.

columnPosition - The column position of the cell that needs to be redrawn.

rowPosition - The row position of the cell that needs to be redrawn.

CellVisualUpdateEvent

protected CellVisualUpdateEvent(CellVisualChangeEvent event)

Create a new CellVisualUpdateEvent out of the given event. Used internally for cloning purposes.

Parameters:

event - The event to create the clone from.

Method Detail

cloneEvent

public CellVisualUpdateEvent cloneEvent()

Specified by:

cloneEvent in interface ILayerEvent

Overrides:

cloneEvent in class CellVisualChangeEvent

Returns:

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

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

Overrides:

convertToLocal in class CellVisualChangeEvent

Parameters:

localLayer - layer about to receive the event

Returns:

TRUE if successfully converted, FALSE otherwise