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

Class FilterAppliedEvent

java.lang.Object

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

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

org.eclipse.nebula.widgets.nattable.filterrow.event.FilterAppliedEvent

All Implemented Interfaces:

ILayerEvent, IStructuralChangeEvent, IVisualChangeEvent

public class FilterAppliedEvent
extends RowStructuralRefreshEvent

Special RowStructuralRefreshEvent that is fired in case the filter changes via FilterRowDataProvider. This includes clearing a filter.

Constructor Summary

Constructors

Constructor	Description
FilterAppliedEvent(ILayer layer)
FilterAppliedEvent(ILayer layer, boolean cleared)
FilterAppliedEvent(ILayer layer, int columnIndex, Object oldValue, Object newValue, boolean cleared)

Method Summary

Modifier and Type	Method	Description
int	getColumnIndex()
Object	getNewValue()
Object	getOldValue()
boolean	isCleared()
boolean	isFilterComboEditor()
void	setCleared(boolean cleared)
void	setFilterComboEditor(boolean filterComboEditor)

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

isHorizontalStructureChanged, isVerticalStructureChanged

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

cloneEvent, convertToLocal, getChangedPositionRectangles, getColumnDiffs, getLayer, getRowDiffs

Methods inherited from class java.lang.Object

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

Constructor Details

FilterAppliedEvent

public FilterAppliedEvent(ILayer layer)

Parameters:

layer - The ILayer from which this event was fired.

FilterAppliedEvent

public FilterAppliedEvent(ILayer layer,
 boolean cleared)

Parameters:

layer - The ILayer from which this event was fired.

cleared - true if the filter was cleared, false if a filter was applied.

Since:

2.1

FilterAppliedEvent

public FilterAppliedEvent(ILayer layer,
 int columnIndex,
 Object oldValue,
 Object newValue,
 boolean cleared)

Parameters:

layer - The ILayer from which this event was fired.

columnIndex - The index of the column on which a filter was set or cleared. -1 if a general filter operation like clear all or loadState was executed.

oldValue - The old value that was set previously as filter.

newValue - The new value that was set as filter.

cleared - true if the filter was cleared, false if a filter was applied.

Since:

2.1

Method Details

getColumnIndex

public int getColumnIndex()

Returns:

The index of the column on which a filter was set or cleared. -1 if a general filter operation like clear all or loadState was executed.

Since:

2.1

getOldValue

public Object getOldValue()

Returns:

The old value that was set previously as filter.

Since:

2.1

getNewValue

public Object getNewValue()

Returns:

The new value that was set as filter.

Since:

2.1

isFilterComboEditor

public boolean isFilterComboEditor()

Returns:

true if the filter editor was a filter combobox editor, false if it was any other editor.

Since:

2.1

setFilterComboEditor

public void setFilterComboEditor(boolean filterComboEditor)

Parameters:

filterComboEditor - true if the filter editor was a filter combobox editor, false if it was any other editor.

Since:

2.1

isCleared

public boolean isCleared()

Returns:

true if the filter was cleared, false if a filter was applied.

Since:

2.1

setCleared

public void setCleared(boolean cleared)

Parameters:

cleared - true if the filter was cleared, false if a filter was applied.

Since:

2.1