org.jxls.command

Class ImageCommand

java.lang.Object

org.jxls.command.AbstractCommand

org.jxls.command.ImageCommand

All Implemented Interfaces:

Command

public class ImageCommand
extends AbstractCommand

Implements image rendering

Image is specified by providing image bytes and type.

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
ImageCommand()
ImageCommand(byte[] imageBytes, ImageType imageType) Creates the command from the image bytes
ImageCommand(String image, ImageType imageType) Creates the command from an image in the context

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
ImageType	getImageType()
Boolean	getLockRange() Whether the command area is locked Other commands will no longer execute in this area after locking
String	getName()
Double	getScaleX()
Double	getScaleY()
String	getSrc()
void	setImageType(ImageType imageType)
void	setImageType(String strType)
void	setScaleX(String scaleX)
void	setScaleY(String scaleY)
void	setSrc(String src)

Methods inherited from class org.jxls.command.AbstractCommand

getAreaList, 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

ImageCommand

public ImageCommand()

ImageCommand

public ImageCommand(String image,
                    ImageType imageType)

Creates the command from an image in the context

Parameters:

image - name of the context attribute with the image bytes

imageType - type of the image

ImageCommand

public ImageCommand(byte[] imageBytes,
                    ImageType imageType)

Creates the command from the image bytes

Parameters:

imageBytes - the image byte array

imageType - the type of the image to render (e.g. PNG, JPEG etc)

Method Detail

getSrc

public String getSrc()

Returns:

src expression producing image byte array

setSrc

public void setSrc(String src)

Parameters:

src - expression resulting in image byte array

getImageType

public ImageType getImageType()

setImageType

public void setImageType(ImageType imageType)

setImageType

public void setImageType(String strType)

Parameters:

strType - "PNG", "JPEG" (not "JPG"), ...

getScaleX

public Double getScaleX()

setScaleX

public void setScaleX(String scaleX)

getScaleY

public Double getScaleY()

setScaleY

public void setScaleY(String scaleY)

getLockRange

public Boolean getLockRange()

Description copied from interface: Command

Whether the command area is locked Other commands will no longer execute in this area after locking

Specified by:

getLockRange in interface Command

Overrides:

getLockRange in class AbstractCommand

Returns:

true or false (default true)

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

getName

public String getName()

Returns:

command name

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