Package org.eclipse.nebula.widgets.nattable.resize.command

Class AutoResizeRowsCommand

java.lang.Object

org.eclipse.nebula.widgets.nattable.command.AbstractMultiRowCommand

org.eclipse.nebula.widgets.nattable.resize.command.AutoResizeRowsCommand

All Implemented Interfaces:

ILayerCommand

public class AutoResizeRowsCommand
extends AbstractMultiRowCommand

Command to trigger auto resizing of rows in a grid.

See Also:

• AutoResizeRowCommandHandler
• InitializeAutoResizeRowsCommand
• InitializeAutoResizeRowsCommandHandler

Constructor Summary

Constructors

Modifier	Constructor	Description
	AutoResizeRowsCommand(NatTable natTable, boolean transformPositions, int... rowPositions)	Create a AutoResizeRowsCommand for programmatic execution.
	AutoResizeRowsCommand(NatTable natTable, int... rowPositions)	Create a AutoResizeRowsCommand for programmatic execution.
protected	AutoResizeRowsCommand(AutoResizeRowsCommand command)	Create a AutoResizeRowsCommand as a clone of the given command instance.
	AutoResizeRowsCommand(InitializeAutoResizeRowsCommand initCommand)	Create a AutoResizeRowsCommand from the given InitializeAutoResizeRowsCommand.

Method Summary

Modifier and Type	Method	Description
ILayerCommand	cloneCommand()	Same semantics as Object.clone() Used to make a copies of the command if has to passed to different layer stacks.
boolean	doPositionTransformation()	Return whether the command handler should transform the row positions or not.
IConfigRegistry	getConfigRegistry()
GCFactory	getGCFactory()

Methods inherited from class org.eclipse.nebula.widgets.nattable.command.AbstractMultiRowCommand

convertToTargetLayer, getRowPositions, getRowPositionsArray, setRowPositions

Methods inherited from class java.lang.Object

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

Constructor Details

AutoResizeRowsCommand

public AutoResizeRowsCommand(InitializeAutoResizeRowsCommand initCommand)

Create a AutoResizeRowsCommand from the given InitializeAutoResizeRowsCommand.

Parameters:

initCommand - The InitializeAutoResizeRowsCommand from which this command should be created.

AutoResizeRowsCommand

public AutoResizeRowsCommand(NatTable natTable,
 int... rowPositions)

Create a AutoResizeRowsCommand for programmatic execution.

Parameters:

natTable - The NatTable instance in which the resize should be performed.

rowPositions - The row positions that should be auto resized, based on the NatTable position.

Since:

1.6

AutoResizeRowsCommand

public AutoResizeRowsCommand(NatTable natTable,
 boolean transformPositions,
 int... rowPositions)

Create a AutoResizeRowsCommand for programmatic execution.

Parameters:

natTable - The NatTable instance in which the resize should be performed.

transformPositions - true if the row positions should be back transformed (e.g. in case the positions are collected via SelectionLayer and therefore need to be back transformed to the GridLayer coordinates), false if the row positions should be treated based on the NatTable.

rowPositions - The row positions that should be auto resized, based on the NatTable position.

Since:

1.6

AutoResizeRowsCommand

protected AutoResizeRowsCommand(AutoResizeRowsCommand command)

Create a AutoResizeRowsCommand as a clone of the given command instance.

Parameters:

command - The AutoResizeRowsCommand that should be cloned.

Method Details

cloneCommand

public ILayerCommand cloneCommand()

Description copied from interface: ILayerCommand

Same semantics as Object.clone() Used to make a copies of the command if has to passed to different layer stacks.

Returns:

a cloned instance of the command

See Also:

• GridLayer.doCommand(ILayerCommand)

getGCFactory

public GCFactory getGCFactory()

Returns:

The GCFactory needed to create a temporary GC for row height calculation.

getConfigRegistry

public IConfigRegistry getConfigRegistry()

Returns:

The IConfigRegistry needed for retrieval of style configurations.

doPositionTransformation

public boolean doPositionTransformation()

Return whether the command handler should transform the row positions or not. If this command is created via InitializeAutoResizeRowsCommand the row positions need to be transformed as by default the command handler is registered to the GridLayer but the row positions are set based on the SelectionLayer. A back transformation is therefore needed. If this command was not created with the other constructor, a back transformation in the command handler is not necessary.

Returns:

true if the command handler should transform the row positions, false if not.

Since:

1.6