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

Class ColumnSizeConfigurationCommand

java.lang.Object

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

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

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

All Implemented Interfaces:

ILayerCommand

public class ColumnSizeConfigurationCommand
extends AbstractRegionCommand

Command to configure column widths. Instead of knowing the column indexes to resize, it can be used to search for columns that have a special label applied.

Since:

1.4

Field Summary

Fields

Modifier and Type	Field	Description
Integer	newColumnWidth	The width to set.
boolean	percentageSizing	Boolean flag to specify whether the width 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
ColumnSizeConfigurationCommand(String label, Integer newColumnWidth, 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

newColumnWidth

public final Integer newColumnWidth

The width to set. Can be null in combination with percentageSizing == true to enable percentage sizing with equal column widths.

percentageSizing

public final boolean percentageSizing

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

Constructor Detail

ColumnSizeConfigurationCommand

public ColumnSizeConfigurationCommand(String label,
                                      Integer newColumnWidth,
                                      boolean percentageSizing)

Parameters:

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

newColumnWidth - The width to set. Can be null in combination with percentageSizing == true to enable percentage sizing with equal column widths.

percentageSizing - Boolean flag to specify whether the width 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.