org.eclipse.nebula.widgets.nattable.summaryrow.command
Class CalculateSummaryRowValuesCommand

java.lang.Object
  org.eclipse.nebula.widgets.nattable.summaryrow.command.CalculateSummaryRowValuesCommand

All Implemented Interfaces:

ILayerCommand

public class CalculateSummaryRowValuesCommand
extends Object
implements ILayerCommand

Command to trigger the calculation of the summary row values manually.

Usually the calculation will be triggered when the summary row moves into the viewport. For large tables that should be printed or exported the calculation is too late. This is because the calculation happens in a seperate thread to avoid freezing of the table on calculation.

There is no special handler for this event, as it is tight coupled to the summary row. Therefore the handling of this command is implemented directly in the SummaryRowLayer.

Note: This is only intended for internal usage and could cause a performance leak. If you want to use it for your use cases you should be careful about performance issues.

Author:

Dirk Fauth

See Also:

SummaryRowLayer

Constructor Summary

CalculateSummaryRowValuesCommand()

Method Summary

ILayerCommand	cloneCommand() Same semantics as Object.clone() Used to make a copies of the command if has to passed to different layer stacks.
boolean	convertToTargetLayer(ILayer targetLayer) Convert the row/column coordinates the command might be carrying from the source layer to the destination (target) layer.

Methods inherited from class java.lang.Object

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

Constructor Detail

CalculateSummaryRowValuesCommand

public CalculateSummaryRowValuesCommand()

Method Detail

convertToTargetLayer

public boolean convertToTargetLayer(ILayer targetLayer)

Description copied from interface: ILayerCommand

Convert the row/column coordinates the command might be carrying from the source layer to the destination (target) layer. If it is not possible to convert the command to the target layer, then this method will return false and the state of this command object will remain unchanged. Note: Commands should not be processed if they fail conversion.

Specified by:

convertToTargetLayer in interface ILayerCommand

Parameters:

targetLayer - the target layer

Returns:

true if the command is valid after conversion, false if the command is no longer valid.

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.

Specified by:

cloneCommand in interface ILayerCommand

Returns:

a cloned instance of the command

See Also:

GridLayer.doCommand(ILayerCommand)