org.jxls.command

Interface Command

All Known Implementing Classes:

AbstractCommand, AreaCommand, EachCommand, GridCommand, IfCommand, ImageCommand, UpdateCellCommand

public interface Command

A command interface defines a transformation of a list of areas at a specified cell Date: Mar 13, 2009

Author:

Leonid Vysochyn

Field Summary

Fields

Modifier and Type	Field and Description
static String	ADJACENT_SHIFT_MODE
static String	INNER_SHIFT_MODE

Method Summary

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()
String	getName()
String	getShiftMode()
void	reset() Resets command data for repeatable command usage
void	setShiftMode(String mode)

Field Detail

INNER_SHIFT_MODE

static final String INNER_SHIFT_MODE

See Also:

Constant Field Values

ADJACENT_SHIFT_MODE

static final String ADJACENT_SHIFT_MODE

See Also:

Constant Field Values

Method Detail

getName

String getName()

Returns:

command name

getAreaList

List<Area> getAreaList()

Returns:

a list of areas for this command

addArea

Command addArea(Area area)

Adds an area to this command

Parameters:

area - -

Returns:

this command instance

applyAt

Size applyAt(CellRef cellRef,
             Context context)

Applies a command at the given cell reference

Parameters:

cellRef - cell reference where the command must be applied

context - bean context to use

Returns:

size of enclosing command area after transformation

reset

void reset()

Resets command data for repeatable command usage

setShiftMode

void setShiftMode(String mode)

getShiftMode

String getShiftMode()