Package org.eclipse.nebula.widgets.nattable.hierarchical

Class HierarchicalTreeAlternatingRowConfigLabelAccumulator

java.lang.Object

org.eclipse.nebula.widgets.nattable.grid.cell.AlternatingRowConfigLabelAccumulator

org.eclipse.nebula.widgets.nattable.hierarchical.HierarchicalTreeAlternatingRowConfigLabelAccumulator

All Implemented Interfaces:

ILayerCommandHandler<DisposeResourcesCommand>, IConfigLabelAccumulator, IConfigLabelProvider, ILayerListener

public class HierarchicalTreeAlternatingRowConfigLabelAccumulator
extends AlternatingRowConfigLabelAccumulator
implements ILayerListener, ILayerCommandHandler<DisposeResourcesCommand>

Specialization of the AlternatingRowConfigLabelAccumulator that calculates the even/odd row labels in a hierarchical tree by inspecting the row spanning of the first level node. For better performance the calculation results are cached. As the cache needs to be cleared on structural changes, this class also implements the ILayerListener to clear the cache automatically on RowStructuralChangeEvents if registered on the given layer via ILayer.addLayerListener(ILayerListener).

Since:

1.6

Field Summary

Fields inherited from class org.eclipse.nebula.widgets.nattable.grid.cell.AlternatingRowConfigLabelAccumulator

EVEN_ROW_CONFIG_TYPE, layer, ODD_ROW_CONFIG_TYPE

Constructor Summary

Constructors

Constructor	Description
HierarchicalTreeAlternatingRowConfigLabelAccumulator(ILayer layer)

Method Summary

Modifier and Type	Method	Description
void	accumulateConfigLabels(LabelStack configLabels, int columnPosition, int rowPosition)	Add labels applicable to this cell position
void	calculateLabels()	Triggers a new background thread for calculation of the row label cache.
void	clearCache()	Clears the local cache of calculated row position to label mappings.
boolean	doCommand(ILayer targetLayer, DisposeResourcesCommand command)
Class<DisposeResourcesCommand>	getCommandClass()
void	handleLayerEvent(ILayerEvent event)	Handle an event notification from an ILayer

Methods inherited from class org.eclipse.nebula.widgets.nattable.grid.cell.AlternatingRowConfigLabelAccumulator

getProvidedLabels

Methods inherited from class java.lang.Object

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

Constructor Detail

HierarchicalTreeAlternatingRowConfigLabelAccumulator

public HierarchicalTreeAlternatingRowConfigLabelAccumulator(ILayer layer)

Parameters:

layer - The ILayer that is used to determine the row spanning in the first column. Should be the HierarchicalTreeLayer.

Method Detail

accumulateConfigLabels

public void accumulateConfigLabels(LabelStack configLabels,
                                   int columnPosition,
                                   int rowPosition)

Description copied from interface: IConfigLabelAccumulator

Add labels applicable to this cell position

Specified by:

accumulateConfigLabels in interface IConfigLabelAccumulator

Overrides:

accumulateConfigLabels in class AlternatingRowConfigLabelAccumulator

Parameters:

configLabels - the labels currently applied to the cell. The labels contributed by this provider must be added to this stack

columnPosition - of the cell for which labels are being gathered

rowPosition - of the cell for which labels are being gathered

calculateLabels

public void calculateLabels()

Triggers a new background thread for calculation of the row label cache.

clearCache

public void clearCache()

Clears the local cache of calculated row position to label mappings.

handleLayerEvent

public void handleLayerEvent(ILayerEvent event)

Description copied from interface: ILayerListener

Handle an event notification from an ILayer

Specified by:

handleLayerEvent in interface ILayerListener

Parameters:

event - the event

doCommand

public boolean doCommand(ILayer targetLayer,
                         DisposeResourcesCommand command)

Specified by:

doCommand in interface ILayerCommandHandler<DisposeResourcesCommand>

Parameters:

targetLayer - the target layer

command - the command

Returns:

true if the command has been handled, false otherwise

getCommandClass

public Class<DisposeResourcesCommand> getCommandClass()

Specified by:

getCommandClass in interface ILayerCommandHandler<DisposeResourcesCommand>