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

Class HideColumnPositionsEvent

java.lang.Object

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

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

org.eclipse.nebula.widgets.nattable.hideshow.event.HideColumnPositionsEvent

All Implemented Interfaces:

ILayerEvent, IStructuralChangeEvent, IVisualChangeEvent

public class HideColumnPositionsEvent
extends ColumnStructuralChangeEvent

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	HideColumnPositionsEvent(HideColumnPositionsEvent event)	Clone constructor.
	HideColumnPositionsEvent(ILayer layer, int... columnPositions)	Creates a new HideColumnPositionsEvent based on the given information.
	HideColumnPositionsEvent(ILayer layer, int[] columnPositions, int[] columnIndexes)	Creates a new HideColumnPositionsEvent based on the given information.
	HideColumnPositionsEvent(ILayer layer, Collection<Integer> columnPositions)	Creates a new HideColumnPositionsEvent based on the given information.
	HideColumnPositionsEvent(ILayer layer, Collection<Integer> columnPositions, Collection<Integer> columnIndexes)	Creates a new HideColumnPositionsEvent based on the given information.

Method Summary

Modifier and Type	Method	Description
HideColumnPositionsEvent	cloneEvent()
boolean	convertToLocal(ILayer localLayer)	Convert the column/row positions carried by the event to the layer about to handle the event.
Collection<StructuralDiff>	getColumnDiffs()

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

getChangedPositionRectangles, getRowDiffs, isHorizontalStructureChanged, isVerticalStructureChanged

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

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.IVisualChangeEvent

getLayer

Constructor Detail

HideColumnPositionsEvent

public HideColumnPositionsEvent(ILayer layer,
                                Collection<Integer> columnPositions)

Creates a new HideColumnPositionsEvent based on the given information.

Parameters:

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

columnPositions - The positions of the columns that have changed.

HideColumnPositionsEvent

public HideColumnPositionsEvent(ILayer layer,
                                int... columnPositions)

Creates a new HideColumnPositionsEvent based on the given information.

Parameters:

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

columnPositions - The positions of the columns that have changed.

Since:

2.0

HideColumnPositionsEvent

public HideColumnPositionsEvent(ILayer layer,
                                Collection<Integer> columnPositions,
                                Collection<Integer> columnIndexes)

Creates a new HideColumnPositionsEvent based on the given information.

Parameters:

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

columnPositions - The positions of the columns that have changed.

columnIndexes - The indexes of the columns that have changed.

Since:

1.6

HideColumnPositionsEvent

public HideColumnPositionsEvent(ILayer layer,
                                int[] columnPositions,
                                int[] columnIndexes)

Creates a new HideColumnPositionsEvent based on the given information.

Parameters:

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

columnPositions - The positions of the columns that have changed.

columnIndexes - The indexes of the columns that have changed.

Since:

2.0

HideColumnPositionsEvent

protected HideColumnPositionsEvent(HideColumnPositionsEvent event)

Clone constructor.

Parameters:

event - The event to clone.

Method Detail

cloneEvent

public HideColumnPositionsEvent cloneEvent()

Returns:

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

getColumnDiffs

public Collection<StructuralDiff> getColumnDiffs()

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 ColumnVisualChangeEvent

Parameters:

localLayer - layer about to receive the event

Returns:

TRUE if successfully converted, FALSE otherwise