public interface Command
Modifier and Type | Field and Description |
---|---|
static String |
ADJACENT_SHIFT_MODE |
static String |
INNER_SHIFT_MODE |
Modifier and Type | Method and Description |
---|---|
Command |
addArea(Area area)
Adds an area to this command
|
Size |
applyAt(CellRef cellRef,
Context context)
Applies a command at the given cell reference
|
List<Area> |
getAreaList() |
Boolean |
getLockRange()
Whether the command area is locked
Other commands will no longer execute in this area after locking
|
String |
getName() |
String |
getShiftMode()
Returns the cell shifting mode defining
the
CellShiftStrategy to use for the command
Possible values are
"inner" defining the InnerCellShiftStrategy to use
"adjacent" defining the AdjacentCellShiftStrategy to use
null value means the default strategy will be used (InnerCellShiftStrategy ) |
void |
reset()
Resets command data for repeatable command usage
|
void |
setLockRange(String isLock)
Other commands will no longer execute in this area after locking
|
void |
setShiftMode(String mode)
Defines the
CellShiftStrategy to use
when shifting the cells for the command while transforming an area
The mode value "inner" sets the InnerCellShiftStrategy (default)
The mode value "adjacent" sets the AdjacentCellShiftStrategy |
static final String INNER_SHIFT_MODE
static final String ADJACENT_SHIFT_MODE
String getName()
Command addArea(Area area)
area
- to be added areaSize applyAt(CellRef cellRef, Context context)
cellRef
- cell reference where the command must be appliedcontext
- bean context to usevoid reset()
void setShiftMode(String mode)
CellShiftStrategy
to use
when shifting the cells for the command while transforming an area
The mode value "inner" sets the InnerCellShiftStrategy
(default)
The mode value "adjacent" sets the AdjacentCellShiftStrategy
mode
- cell shifting mode with possible values "inner" or "adjacent"String getShiftMode()
CellShiftStrategy
to use for the command
Possible values are
"inner" defining the InnerCellShiftStrategy
to use
"adjacent" defining the AdjacentCellShiftStrategy
to use
null value means the default strategy will be used (InnerCellShiftStrategy
)void setLockRange(String isLock)
isLock
- Whether the command area is locked, value should be "true","false",nullBoolean getLockRange()
Copyright © 2023. All rights reserved.