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

Class RowSizeConfigurationCommand

java.lang.Object

org.eclipse.nebula.widgets.nattable.command.AbstractContextFreeCommand

org.eclipse.nebula.widgets.nattable.command.AbstractRegionCommand

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

All Implemented Interfaces:

ILayerCommand

public class RowSizeConfigurationCommand
extends AbstractRegionCommand

Command to configure row heights. Instead of knowing the row indexes to resize, it can be used to search for rows that have a special label applied.

Since:

1.4

Field Summary

Fields

Modifier and Type	Field	Description
Integer	newRowHeight	The height to set.
boolean	percentageSizing	Boolean flag to specify whether the height should be set as percentage or as pixel value.

Fields inherited from class org.eclipse.nebula.widgets.nattable.command.AbstractRegionCommand

label

Constructor Summary

Constructors

Constructor	Description
RowSizeConfigurationCommand(String label, Integer newRowHeight, boolean percentageSizing)

Method Summary

Modifier and Type	Method	Description
AbstractRegionCommand	cloneForRegion()	Creates and returns a clone of this instance with necessary modifications for further processing.

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

cloneCommand, convertToTargetLayer

Methods inherited from class java.lang.Object

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

Field Detail

newRowHeight

public final Integer newRowHeight

The height to set. Can be null in combination with percentageSizing == true to enable percentage sizing with equal row heights.

percentageSizing

public final boolean percentageSizing

Boolean flag to specify whether the height should be set as percentage or as pixel value.

Constructor Detail

RowSizeConfigurationCommand

public RowSizeConfigurationCommand(String label,
                                   Integer newRowHeight,
                                   boolean percentageSizing)

Parameters:

label - The label that needs to be applied to a row in order to process the resize command. Is used to determine the row index. If null the default size will be set.

newRowHeight - The height to set. Can be null in combination with percentageSizing == true to enable percentage sizing with equal row heights.

percentageSizing - Boolean flag to specify whether the height should be set as percentage or as pixel value.

Method Detail

cloneForRegion

public AbstractRegionCommand cloneForRegion()

Description copied from class: AbstractRegionCommand

Creates and returns a clone of this instance with necessary modifications for further processing. Typically the label information is removed or adjusted for processing further down the region layer stack.

Specified by:

cloneForRegion in class AbstractRegionCommand

Returns:

A clone of this command prepared for further processing down the region layer stack.