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

Class StructuralRefreshEvent

java.lang.Object

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

All Implemented Interfaces:

ILayerEvent, IStructuralChangeEvent, IVisualChangeEvent

Direct Known Subclasses:

ColumnStructuralRefreshEvent, FreezeEvent, ResizeStructuralRefreshEvent, RowStructuralRefreshEvent, ScrollEvent, UnfreezeEvent

public class StructuralRefreshEvent
extends Object
implements IStructuralChangeEvent

General event indicating that structures cached by the layers need refreshing.

TIP: Consider throwing a more focused event (subclass) if you need to do this.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	StructuralRefreshEvent(StructuralRefreshEvent event)
	StructuralRefreshEvent(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()
Collection<StructuralDiff>	getColumnDiffs()
ILayer	getLayer()
Collection<StructuralDiff>	getRowDiffs()
boolean	isHorizontalStructureChanged()
boolean	isVerticalStructureChanged()

Methods inherited from class java.lang.Object

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

Constructor Detail

StructuralRefreshEvent

public StructuralRefreshEvent(ILayer layer)

StructuralRefreshEvent

protected StructuralRefreshEvent(StructuralRefreshEvent event)

Method Detail

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.

isHorizontalStructureChanged

public boolean isHorizontalStructureChanged()

Specified by:

isHorizontalStructureChanged in interface IStructuralChangeEvent

isVerticalStructureChanged

public boolean isVerticalStructureChanged()

Specified by:

isVerticalStructureChanged in interface IStructuralChangeEvent

getColumnDiffs

public Collection<StructuralDiff> getColumnDiffs()

Specified by:

getColumnDiffs in interface IStructuralChangeEvent

getRowDiffs

public Collection<StructuralDiff> getRowDiffs()

Specified by:

getRowDiffs in interface IStructuralChangeEvent

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.