Package org.jxls.command

Class GridCommand

java.lang.Object

org.jxls.command.AbstractCommand

org.jxls.command.GridCommand

All Implemented Interfaces:

Command

public class GridCommand
extends AbstractCommand

The command implements a grid with dynamic columns and rows

Author:

Leonid Vysochyn

Field Summary

Fields

Modifier and Type	Field	Description
static final String	COMMAND_NAME
static final String	DATA_VAR
static final String	HEADER_VAR

Fields inherited from class org.jxls.command.AbstractCommand

areaList

Fields inherited from interface org.jxls.command.Command

ADJACENT_SHIFT_MODE, INNER_SHIFT_MODE

Constructor Summary

Constructors

Constructor	Description
GridCommand()
GridCommand(String headers, String data)
GridCommand(String headers, String data, String props, Area headerArea, Area bodyArea)
GridCommand(String headers, String data, Area headerArea, Area bodyArea)

Method Summary

Modifier and Type	Method	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
String	getData()
String	getFormatCells()
String	getHeaders()
String	getName()
String	getProps()
void	setData(String data)
void	setFormatCells(String formatCells)
void	setHeaders(String headers)
void	setProps(String props)

Methods inherited from class org.jxls.command.AbstractCommand

getAreaList, getLockRange, getLogger, getShiftMode, getTransformer, reset, setLockRange, setLockRange, setShiftMode, transformToIterableObject

Methods inherited from class java.lang.Object

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

Field Details

COMMAND_NAME

public static final String COMMAND_NAME

See Also:

• Constant Field Values

HEADER_VAR

public static final String HEADER_VAR

See Also:

• Constant Field Values

DATA_VAR

public static final String DATA_VAR

See Also:

• Constant Field Values

Constructor Details

GridCommand

public GridCommand()

GridCommand

public GridCommand(String headers,
 String data)

GridCommand

public GridCommand(String headers,
 String data,
 String props,
 Area headerArea,
 Area bodyArea)

GridCommand

public GridCommand(String headers,
 String data,
 Area headerArea,
 Area bodyArea)

Method Details

getName

public String getName()

Returns:

command name

getHeaders

public String getHeaders()

setHeaders

public void setHeaders(String headers)

getData

public String getData()

setData

public void setData(String data)

getProps

public String getProps()

setProps

public void setProps(String props)

getFormatCells

public String getFormatCells()

setFormatCells

public void setFormatCells(String formatCells)

Parameters:

formatCells - Comma-separated list of format type cells, e.g. formatCells="Double:E1, Date:F1"

addArea

public Command addArea(Area area)

Description copied from interface: Command

Adds an area to this command

Specified by:

addArea in interface Command

Overrides:

addArea in class AbstractCommand

Parameters:

area - to be added area

Returns:

this command instance

applyAt

public Size applyAt(CellRef cellRef,
 Context context)

Description copied from interface: Command

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