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

Interface ILayerCommand

All Known Subinterfaces:

IColumnGroupCommand, IFreezeCommand, IRowGroupCommand

All Known Implementing Classes:

AbstractColumnCommand, AbstractContextFreeCommand, AbstractMultiColumnCommand, AbstractMultiRowCommand, AbstractPositionCommand, AbstractRegionCommand, AbstractRowCommand, AbstractSelectionCommand, AutoResizeColumnCommandFixture, AutoResizeColumnsCommand, AutoResizeRowCommandFixture, AutoResizeRowsCommand, BlinkTimerEnableCommand, CalculateSummaryRowValuesCommand, ChooseColumnsFromCategoriesCommand, ClearAllFiltersCommand, ClearAllSelectionsCommand, ClearFilterCommand, ClearHoverStylingCommand, ClientAreaResizeCommand, ColumnGroupCollapseCommand, ColumnGroupExpandCollapseCommand, ColumnGroupExpandCommand, ColumnGroupReorderCommand, ColumnGroupReorderEndCommand, ColumnGroupReorderStartCommand, ColumnHideCommand, ColumnReorderCommand, ColumnReorderEndCommand, ColumnReorderStartCommand, ColumnResizeCommand, ColumnShowCommand, ColumnSizeConfigurationCommand, ColumnWidthResetCommand, ConfigureScalingCommand, CopyDataToClipboardCommand, CreateColumnGroupCommand, CreateRowGroupCommand, DeleteSelectionCommand, DisableFormulaCachingCommand, DisableFormulaEvaluationCommand, DiscardDataChangesCommand, DisplayColumnChooserCommand, DisplayColumnGroupRenameDialogCommand, DisplayColumnRenameDialogCommand, DisplayColumnStyleEditorCommand, DisplayPersistenceDialogCommand, DisplayRowGroupRenameDialogCommand, DisposeResourcesCommand, EditCellCommand, EditSelectionCommand, EnableFormulaCachingCommand, EnableFormulaEvaluationCommand, ExportCommand, ExportTableCommand, FillHandlePasteCommand, FreezeColumnCommand, FreezePositionCommand, FreezeRowCommand, FreezeSelectionCommand, GroupByColumnIndexCommand, GroupMultiColumnReorderCommand, GroupMultiRowReorderCommand, HideColumnByIndexCommand, HideRowByIndexCommand, HierarchicalTreeExpandCollapseCommand, HoverStylingCommand, InitializeAutoResizeColumnsCommand, InitializeAutoResizeRowsCommand, InitializeClientAreaCommandFixture, InitializeClientAreaCommandFixture, InitializeGridCommand, LayerCommandFixture, MoveSelectionCommand, MultiColumnHideCommand, MultiColumnReorderCommand, MultiColumnResizeCommand, MultiColumnShowCommand, MultiRowHideCommand, MultiRowReorderCommand, MultiRowResizeCommand, MultiRowShowCommand, OpenCreateColumnGroupDialog, PasteDataCommand, PrintCommand, PrintEntireGridCommand, RecalculateScrollBarsCommand, RemoveColumnGroupCommand, RemoveRowGroupCommand, RenameColumnHeaderCommand, ReorderColumnGroupCommand, ReorderColumnGroupEndCommand, ReorderColumnGroupStartCommand, ReorderColumnsAndGroupsCommand, ResetColumnReorderCommand, ResetRowReorderCommand, RowDeleteCommand, RowGroupCollapseCommand, RowGroupExpandCollapseCommand, RowGroupExpandCommand, RowGroupReorderCommand, RowGroupReorderEndCommand, RowGroupReorderStartCommand, RowHeightResetCommand, RowHideCommand, RowInsertCommand, RowObjectDeleteCommand, RowPositionHideCommand, RowReorderCommand, RowReorderEndCommand, RowReorderStartCommand, RowResizeCommand, RowShowCommand, RowSizeConfigurationCommand, SaveDataChangesCommand, ScrollSelectionCommand, ScrollSelectionCommandFixture, SearchCommand, SelectAllCommand, SelectCellCommand, SelectColumnCommand, SelectRegionCommand, SelectRowGroupsCommand, SelectRowsCommand, ShowAllColumnsCommand, ShowAllRowsCommand, ShowCellInViewportCommand, ShowColumnInViewportCommand, ShowRowInViewportCommand, SortColumnCommand, StructuralRefreshCommand, TickUpdateCommand, ToggleFilterRowCommand, TreeCollapseAllCommand, TreeExpandAllCommand, TreeExpandCollapseCommand, TreeExpandToLevelCommand, TurnViewportOffCommand, TurnViewportOnCommand, UnFreezeGridCommand, UngroupByColumnIndexCommand, UngroupColumnCommand, UngroupRowCommand, UpdateColumnGroupCollapseCommand, UpdateDataCommand, UpdateRowGroupCollapseCommand, ViewportDragCommand, ViewportSelectColumnCommand, ViewportSelectColumnGroupCommand, ViewportSelectRowCommand, ViewportSelectRowGroupCommand, VisualRefreshCommand

public interface ILayerCommand

Commands are fired by NatTable in response to user actions. Commands flow down the layer stack until they are processed by an ILayer or an associated ILayerCommandHandler. Commands can be fired from code by invoking NatTable.doCommand(ILayerCommand)

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	convertToTargetLayer(ILayer targetLayer)	Convert the row/column coordinates the command might be carrying from the source layer to the destination (target) layer.

Method Detail

convertToTargetLayer

boolean convertToTargetLayer(ILayer targetLayer)

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.

Parameters:

targetLayer - the target layer

Returns:

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

cloneCommand

ILayerCommand cloneCommand()

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)