org.eclipse.nebula.widgets.nattable.sort

Class SortHeaderLayer<T>

java.lang.Object

org.eclipse.nebula.widgets.nattable.layer.AbstractLayer

org.eclipse.nebula.widgets.nattable.layer.AbstractLayerTransform

org.eclipse.nebula.widgets.nattable.sort.SortHeaderLayer<T>

Type Parameters:

T - Type of the Beans in the backing data source.

All Implemented Interfaces:

ILayer, ILayerListener, IPersistable

public class SortHeaderLayer<T>
extends AbstractLayerTransform
implements IPersistable

Enables sorting of the data. Uses an ISortModel to do/track the sorting.

See Also:

DefaultSortConfiguration, SortStatePersistor

Field Summary

Fields inherited from class org.eclipse.nebula.widgets.nattable.layer.AbstractLayerTransform

underlyingLayer

Fields inherited from class org.eclipse.nebula.widgets.nattable.layer.AbstractLayer

layerPainter

Fields inherited from interface org.eclipse.nebula.widgets.nattable.persistence.IPersistable

DOT, VALUE_SEPARATOR

Constructor Summary

Constructors

Constructor and Description
SortHeaderLayer(ILayer underlyingLayer, ISortModel sortModel)
SortHeaderLayer(ILayer underlyingLayer, ISortModel sortModel, boolean useDefaultConfiguration)

Method Summary

Methods

Modifier and Type	Method and Description
LabelStack	getConfigLabelsByPosition(int columnPosition, int rowPosition)
protected ISortModel	getSortModel()

Methods inherited from class org.eclipse.nebula.widgets.nattable.layer.AbstractLayerTransform

configure, dispose, doCommand, getCellByPosition, getCellPainter, getColumnCount, getColumnIndexByPosition, getColumnPositionByX, getColumnWidthByPosition, getDataValueByPosition, getDisplayModeByPosition, getHeight, getLayerPainter, getPreferredColumnCount, getPreferredHeight, getPreferredRowCount, getPreferredWidth, getRegionLabelsByXY, getRowCount, getRowHeightByPosition, getRowIndexByPosition, getRowPositionByY, getStartXOfColumnPosition, getStartYOfRowPosition, getUnderlyingLayer, getUnderlyingLayerByPosition, getUnderlyingLayersByColumnPosition, getUnderlyingLayersByRowPosition, getWidth, isColumnPositionResizable, isRowPositionResizable, loadState, localToUnderlyingColumnPosition, localToUnderlyingRowPosition, saveState, setClientAreaProvider, setUnderlyingLayer, underlyingToLocalColumnPosition, underlyingToLocalColumnPositions, underlyingToLocalRowPosition, underlyingToLocalRowPositions

Methods inherited from class org.eclipse.nebula.widgets.nattable.layer.AbstractLayer

addConfiguration, addLayerListener, clearConfiguration, fireLayerEvent, getBoundsByPosition, getClientAreaProvider, getConfigLabelAccumulator, getRegionName, handleLayerEvent, hasLayerListener, registerCommandHandler, registerCommandHandlers, registerEventHandler, registerPersistable, removeLayerListener, setConfigLabelAccumulator, setLayerPainter, setRegionName, toString, unregisterCommandHandler, unregisterPersistable

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.persistence.IPersistable

loadState, saveState

Constructor Detail

SortHeaderLayer

public SortHeaderLayer(ILayer underlyingLayer,
               ISortModel sortModel)

SortHeaderLayer

public SortHeaderLayer(ILayer underlyingLayer,
               ISortModel sortModel,
               boolean useDefaultConfiguration)

Method Detail

getConfigLabelsByPosition

public LabelStack getConfigLabelsByPosition(int columnPosition,
                                   int rowPosition)

Specified by:

getConfigLabelsByPosition in interface ILayer

Overrides:

getConfigLabelsByPosition in class AbstractLayerTransform

Returns:

adds a special configuration label to the stack taking into account the following:

1. Is the column sorted ?
2. What is the sort order of the column

A special painter is registered against the above labels to render the sort arrows

getSortModel

protected ISortModel getSortModel()