org.jxls.command

Class IfCommand

java.lang.Object

org.jxls.command.AbstractCommand

org.jxls.command.IfCommand

All Implemented Interfaces:

Command

public class IfCommand
extends AbstractCommand

Implements if-else logic

Since:

Sep 11, 2009

Author:

Leonid Vysochyn

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
IfCommand()
IfCommand(String condition)
IfCommand(String condition, Area ifArea, Area elseArea)
IfCommand(String condition, XlsArea ifArea)

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	getCondition() Gets test condition as JEXL expression string
Area	getElseArea() Gets an area to render when the condition is evaluated to 'false'
Area	getIfArea() Gets an area to render when the condition is evaluated to 'true'
String	getName()
void	setCondition(String condition) Sets test condition as JEXL expression string

Methods inherited from class org.jxls.command.AbstractCommand

getAreaList, getShiftMode, getTransformationConfig, getTransformer, reset, 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

IfCommand

public IfCommand()

IfCommand

public IfCommand(String condition)

Parameters:

condition - JEXL expression for boolean condition to evaluate

IfCommand

public IfCommand(String condition,
                 XlsArea ifArea)

IfCommand

public IfCommand(String condition,
                 Area ifArea,
                 Area elseArea)

Method Detail

getName

public String getName()

Returns:

command name

getCondition

public String getCondition()

Gets test condition as JEXL expression string

Returns:

test condition

setCondition

public void setCondition(String condition)

Sets test condition as JEXL expression string

Parameters:

condition - condition to test

getIfArea

public Area getIfArea()

Gets an area to render when the condition is evaluated to 'true'

Returns:

if Area

getElseArea

public Area getElseArea()

Gets an area to render when the condition is evaluated to 'false'

Returns:

else Area

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