org.jxls.command

Class MergeCellsCommand

java.lang.Object

org.jxls.command.AbstractCommand

org.jxls.command.MergeCellsCommand

All Implemented Interfaces:

Command

public class MergeCellsCommand
extends AbstractCommand

Merge cells

jx:mergeCells(
 lastCell="Merge cell ranges"
 [, cols="Number of columns combined"]
 [, rows="Number of rows combined"]
 [, minCols="Minimum number of columns to merge"]
 [, minRows="Minimum number of rows to merge"]
 )

Note: this command can only be used on cells that have not been merged. An exception will occur if the scope of the merged cell exists for the merged cell

Since:

2.6.0

Author:

lnk

Field Summary

Fields

Modifier and Type	Field and Description
static String	COMMAND_NAME

Fields inherited from interface org.jxls.command.Command

ADJACENT_SHIFT_MODE, INNER_SHIFT_MODE

Constructor Summary

Constructors

Constructor and Description
MergeCellsCommand()

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
String	getCols()
String	getMinCols()
String	getMinRows()
String	getName()
String	getRows()
void	setCols(String cols)
void	setMinCols(String minCols)
void	setMinRows(String minRows)
void	setRows(String rows)

Methods inherited from class org.jxls.command.AbstractCommand

getAreaList, getLockRange, getShiftMode, getTransformationConfig, getTransformer, reset, setLockRange, setLockRange, setShiftMode

Methods inherited from class java.lang.Object

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

Field Detail

COMMAND_NAME

public static final String COMMAND_NAME

See Also:

Constant Field Values

Constructor Detail

MergeCellsCommand

public MergeCellsCommand()

Method Detail

getName

public String getName()

Returns:

command name

getCols

public String getCols()

setCols

public void setCols(String cols)

getRows

public String getRows()

setRows

public void setRows(String rows)

getMinCols

public String getMinCols()

setMinCols

public void setMinCols(String minCols)

getMinRows

public String getMinRows()

setMinRows

public void setMinRows(String minRows)

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