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

Class VisualRefreshEvent

java.lang.Object

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

All Implemented Interfaces:

ILayerEvent, IVisualChangeEvent

Direct Known Subclasses:

DiscardDataChangesCompletedEvent, GroupColumnsEvent, GroupRowsEvent, SaveDataChangesCompletedEvent, UngroupColumnsEvent, UngroupRowsEvent

public class VisualRefreshEvent
extends Object
implements IVisualChangeEvent

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	VisualRefreshEvent(VisualRefreshEvent event)
	VisualRefreshEvent(ILayer layer)

Method Summary

Modifier and Type	Method	Description
ILayerEvent	cloneEvent()
boolean	convertToLocal(ILayer localLayer)	Convert the column/row positions carried by the event to the layer about to handle the event.
Collection<org.eclipse.swt.graphics.Rectangle>	getChangedPositionRectangles()
ILayer	getLayer()

Methods inherited from class java.lang.Object

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

Constructor Details

VisualRefreshEvent

public VisualRefreshEvent(ILayer layer)

VisualRefreshEvent

protected VisualRefreshEvent(VisualRefreshEvent event)

Method Details

getLayer

public ILayer getLayer()

Specified by:

getLayer in interface IVisualChangeEvent

Returns:

the layer that the visible change event is originating from.

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

getChangedPositionRectangles

public Collection<org.eclipse.swt.graphics.Rectangle> getChangedPositionRectangles()

Specified by:

getChangedPositionRectangles in interface IVisualChangeEvent

Returns:

the position rectangles that have changed and need to be redrawn. If no rectangles are returned, then the receiver should assume that the entire layer is changed and will need to be redrawn.

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.