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

Class ColumnStructuralChangeEvent

java.lang.Object

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

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

All Implemented Interfaces:

ILayerEvent, IStructuralChangeEvent, IVisualChangeEvent

Direct Known Subclasses:

ColumnDeleteEvent, ColumnInsertEvent, ColumnReorderEvent, ColumnResizeEvent, HideColumnPositionsEvent, ShowColumnPositionsEvent

public abstract class ColumnStructuralChangeEvent
extends ColumnVisualChangeEvent
implements IStructuralChangeEvent

Event indicating a change in the structure of the columns. This event carried ColumnDiffs (Collection<StructuralDiff>) indicating the columns which have changed.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ColumnStructuralChangeEvent(ColumnStructuralChangeEvent event)	Creates a new ColumnStructuralChangeEvent based on the given instance.
	ColumnStructuralChangeEvent(ILayer layer, Collection<Range> columnPositionRanges)	Creates a new ColumnStructuralChangeEvent based on the given information.
	ColumnStructuralChangeEvent(ILayer layer, Collection<Range> columnPositionRanges, int... columnIndexes)	Creates a new ColumnStructuralChangeEvent based on the given information.
	ColumnStructuralChangeEvent(ILayer layer, Collection<Range> columnPositionRanges, Collection<Integer> columnIndexes)	Creates a new ColumnStructuralChangeEvent based on the given information.
	ColumnStructuralChangeEvent(ILayer layer, Range... columnPositionRanges)	Creates a new ColumnStructuralChangeEvent based on the given information.

Method Summary

Modifier and Type	Method	Description
Collection<org.eclipse.swt.graphics.Rectangle>	getChangedPositionRectangles()
Collection<StructuralDiff>	getRowDiffs()
boolean	isHorizontalStructureChanged()
boolean	isVerticalStructureChanged()

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

convertToLocal, getColumnIndexes, getColumnPositionRanges, getLayer, setColumnPositionRanges, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.nebula.widgets.nattable.layer.event.ILayerEvent

cloneEvent, convertToLocal

Methods inherited from interface org.eclipse.nebula.widgets.nattable.layer.event.IStructuralChangeEvent

getColumnDiffs

Methods inherited from interface org.eclipse.nebula.widgets.nattable.layer.event.IVisualChangeEvent

getLayer

Constructor Details

ColumnStructuralChangeEvent

public ColumnStructuralChangeEvent(ILayer layer,
 Range... columnPositionRanges)

Creates a new ColumnStructuralChangeEvent based on the given information.

Parameters:

layer - The ILayer to which the given column positions match.

columnPositionRanges - The column position ranges for the columns that have changed.

ColumnStructuralChangeEvent

public ColumnStructuralChangeEvent(ILayer layer,
 Collection<Range> columnPositionRanges)

Creates a new ColumnStructuralChangeEvent based on the given information.

Parameters:

layer - The ILayer to which the given column positions match.

columnPositionRanges - The column position ranges for the columns that have changed.

ColumnStructuralChangeEvent

public ColumnStructuralChangeEvent(ILayer layer,
 Collection<Range> columnPositionRanges,
 Collection<Integer> columnIndexes)

Creates a new ColumnStructuralChangeEvent based on the given information.

Parameters:

layer - The ILayer to which the given column positions match.

columnPositionRanges - The column position ranges for the columns that have changed.

columnIndexes - The indexes of the columns that have changed.

Since:

1.6

ColumnStructuralChangeEvent

public ColumnStructuralChangeEvent(ILayer layer,
 Collection<Range> columnPositionRanges,
 int... columnIndexes)

Creates a new ColumnStructuralChangeEvent based on the given information.

Parameters:

layer - The ILayer to which the given column positions match.

columnPositionRanges - The column position ranges for the columns that have changed.

columnIndexes - The indexes of the columns that have changed.

Since:

2.0

ColumnStructuralChangeEvent

protected ColumnStructuralChangeEvent(ColumnStructuralChangeEvent event)

Creates a new ColumnStructuralChangeEvent based on the given instance. Mainly needed for cloning.

Parameters:

event - The ColumnStructuralChangeEvent out of which the new instance should be created.

Method Details

getChangedPositionRectangles

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

Specified by:

getChangedPositionRectangles in interface IVisualChangeEvent

Overrides:

getChangedPositionRectangles in class ColumnVisualChangeEvent

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

getRowDiffs

public Collection<StructuralDiff> getRowDiffs()

Specified by:

getRowDiffs in interface IStructuralChangeEvent