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

Class HierarchicalTraversalStrategy

java.lang.Object

org.eclipse.nebula.widgets.nattable.hierarchical.HierarchicalTraversalStrategy

All Implemented Interfaces:

ITraversalStrategy

public class HierarchicalTraversalStrategy
extends Object
implements ITraversalStrategy

Wrapper for basic ITraversalStrategy implementations that add target checks. Requests for traversal scope, cycle and step count will be delegated to the wrapped ITraversalStrategy. isValidTarget(ILayerCell, ILayerCell) will check whether the ILayerCell from which the movement should be performed is part of a collapsed parent node and therefore the ILayerCell to move the selection to would be in a hidden area.

Since:

1.6

Nested Class Summary

Nested classes/interfaces inherited from interface org.eclipse.nebula.widgets.nattable.selection.ITraversalStrategy

ITraversalStrategy.TraversalScope

Field Summary

Fields

Modifier and Type	Field	Description
protected ITraversalStrategy	baseStrategy	The ITraversalStrategy that is wrapped by this HierarchicalTraversalStrategy.
protected HierarchicalTreeLayer	layer	The HierarchicalTreeLayer on which this ITraversalStrategy is applied.

Fields inherited from interface org.eclipse.nebula.widgets.nattable.selection.ITraversalStrategy

AXIS_CYCLE_TRAVERSAL_STRATEGY, AXIS_TRAVERSAL_STRATEGY, TABLE_CYCLE_TRAVERSAL_STRATEGY, TABLE_TRAVERSAL_STRATEGY

Constructor Summary

Constructors

Constructor	Description
HierarchicalTraversalStrategy(ITraversalStrategy baseStrategy, HierarchicalTreeLayer layer)

Method Summary

Modifier and Type	Method	Description
int	getStepCount()
ITraversalStrategy.TraversalScope	getTraversalScope()
boolean	isCycle()
boolean	isValidTarget(ILayerCell from, ILayerCell to)	Checks whether the ILayerCell that would be selected after the selection movement is valid or not.

Methods inherited from class java.lang.Object

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

Field Detail

baseStrategy

protected ITraversalStrategy baseStrategy

The ITraversalStrategy that is wrapped by this HierarchicalTraversalStrategy.

layer

protected HierarchicalTreeLayer layer

The HierarchicalTreeLayer on which this ITraversalStrategy is applied.

Constructor Detail

HierarchicalTraversalStrategy

public HierarchicalTraversalStrategy(ITraversalStrategy baseStrategy,
                                     HierarchicalTreeLayer layer)

Parameters:

baseStrategy - The ITraversalStrategy that should be wrapped by this HierarchicalTraversalStrategy.

layer - The HierarchicalTreeLayer on which this ITraversalStrategy is applied.

Method Detail

getTraversalScope

public ITraversalStrategy.TraversalScope getTraversalScope()

Specified by:

getTraversalScope in interface ITraversalStrategy

Returns:

The ITraversalStrategy.TraversalScope this traversal strategy specifies.

isCycle

public boolean isCycle()

Specified by:

isCycle in interface ITraversalStrategy

Returns:

true if on traversal the selection should cycle, false if the selection should stay at the last/first position without cycling.

getStepCount

public int getStepCount()

Specified by:

getStepCount in interface ITraversalStrategy

Returns:

The number of steps to jump on traversal.

isValidTarget

public boolean isValidTarget(ILayerCell from,
                             ILayerCell to)

Description copied from interface: ITraversalStrategy

Checks whether the ILayerCell that would be selected after the selection movement is valid or not. In case the target is invalid, the responsible command handler is able to react accordingly, e.g. move the next valid cell.

This is for example useful for editing traversal. If the selection movement is triggered on committing a value in an editor, the next editable cell should be selected and the editor opened immediately.

Specified by:

isValidTarget in interface ITraversalStrategy

Parameters:

from - The ILayerCell from which the selection movement is started.

to - The ILayerCell to which the selection movement should be performed.

Returns:

true if the target is a valid target for selection movement, false if not