jxl.write

Class WritableImage

Implemented Interfaces:
jxl.biff.drawing.DrawingGroupObject, Image

public class WritableImage
extends jxl.biff.drawing.Drawing

Allows an image to be created, or an existing image to be manipulated Note that co-ordinates and dimensions are given in cells, so that if for example the width or height of a cell which the image spans is altered, the image will have a correspondign distortion

Field Summary

static jxl.biff.drawing.Drawing.ImageAnchorProperties
MOVE_AND_SIZE_WITH_CELLS
Image anchor properties which will move and resize an image along with the cells
static jxl.biff.drawing.Drawing.ImageAnchorProperties
MOVE_WITH_CELLS
Image anchor properties which will move an image when cells are inserted or deleted
static jxl.biff.drawing.Drawing.ImageAnchorProperties
NO_MOVE_OR_SIZE_WITH_CELLS
Image anchor properties which will leave an image unaffected when other cells are inserted, removed or resized

Fields inherited from class jxl.biff.drawing.Drawing

MOVE_AND_SIZE_WITH_CELLS, MOVE_WITH_CELLS, NO_MOVE_OR_SIZE_WITH_CELLS

Constructor Summary

WritableImage(double x, double y, double width, double height, File image)
Constructor
WritableImage(double x, double y, double width, double height, byte[] imageData)
Constructor
WritableImage(jxl.biff.drawing.DrawingGroupObject d, jxl.biff.drawing.DrawingGroup dg)
Constructor, used when copying sheets

Method Summary

double
getColumn()
Accessor for the image position
double
getHeight()
Accessor for the image dimensions
jxl.biff.drawing.Drawing.ImageAnchorProperties
getImageAnchor()
Accessor for the anchor properties
byte[]
getImageData()
Accessor for the image data
File
getImageFile()
Accessor for the image file
double
getRow()
Accessor for the image position
double
getWidth()
Accessor for the image dimensions
void
setColumn(double c)
Accessor for the image position
void
setHeight(double c)
Accessor for the image dimensions Note that the actual size of the rendered image will depend on the height of the rows it spans
void
setImageAnchor(jxl.biff.drawing.Drawing.ImageAnchorProperties iap)
Accessor for the anchor properties
void
setRow(double c)
Accessor for the image position
void
setWidth(double c)
Accessor for the image dimensions Note that the actual size of the rendered image will depend on the width of the columns it spans

Methods inherited from class jxl.biff.drawing.Drawing

getBlipId, getColumn, getDrawingGroup, getHeight, getHeight, getHorizontalResolution, getImageBytes, getImageData, getImageFile, getImageFilePath, getImageHeight, getImageWidth, getMsoDrawingRecord, getObjectId, getOrigin, getReferenceCount, getRow, getShapeId, getSpContainer, getType, getVerticalResolution, getWidth, getWidth, getX, getY, isFirst, isFormObject, removeRow, setDrawingGroup, setHeight, setObjectId, setReferenceCount, setWidth, setX, setY, writeAdditionalRecords, writeTailRecords

Field Details

MOVE_AND_SIZE_WITH_CELLS

public static jxl.biff.drawing.Drawing.ImageAnchorProperties MOVE_AND_SIZE_WITH_CELLS
Image anchor properties which will move and resize an image along with the cells

MOVE_WITH_CELLS

public static jxl.biff.drawing.Drawing.ImageAnchorProperties MOVE_WITH_CELLS
Image anchor properties which will move an image when cells are inserted or deleted

NO_MOVE_OR_SIZE_WITH_CELLS

public static jxl.biff.drawing.Drawing.ImageAnchorProperties NO_MOVE_OR_SIZE_WITH_CELLS
Image anchor properties which will leave an image unaffected when other cells are inserted, removed or resized

Constructor Details

WritableImage

public WritableImage(double x,
                     double y,
                     double width,
                     double height,
                     File image)
Constructor
Parameters:
x - the column number at which to position the image
y - the row number at which to position the image
width - the number of columns cells which the image spans
height - the number of rows which the image spans
image - the source image file

WritableImage

public WritableImage(double x,
                     double y,
                     double width,
                     double height,
                     byte[] imageData)
Constructor
Parameters:
x - the column number at which to position the image
y - the row number at which to position the image
width - the number of columns cells which the image spans
height - the number of rows which the image spans
imageData - the image data

WritableImage

public WritableImage(jxl.biff.drawing.DrawingGroupObject d,
                     jxl.biff.drawing.DrawingGroup dg)
Constructor, used when copying sheets
Parameters:
d - the image to copy
dg - the drawing group

Method Details

getColumn

public double getColumn()
Accessor for the image position
Specified by:
getColumn in interface Image
Overrides:
getColumn in interface jxl.biff.drawing.Drawing
Returns:
the column number at which the image is positioned

getHeight

public double getHeight()
Accessor for the image dimensions
Specified by:
getHeight in interface jxl.biff.drawing.DrawingGroupObject
getHeight in interface Image
Overrides:
getHeight in interface jxl.biff.drawing.Drawing
Returns:
the number of rows which this image spans

getImageAnchor

public jxl.biff.drawing.Drawing.ImageAnchorProperties getImageAnchor()
Accessor for the anchor properties

getImageData

public byte[] getImageData()
Accessor for the image data
Specified by:
getImageData in interface jxl.biff.drawing.DrawingGroupObject
getImageData in interface Image
Overrides:
getImageData in interface jxl.biff.drawing.Drawing
Returns:
the image data

getImageFile

public File getImageFile()
Accessor for the image file
Specified by:
getImageFile in interface Image
Overrides:
getImageFile in interface jxl.biff.drawing.Drawing
Returns:
the file which the image references

getRow

public double getRow()
Accessor for the image position
Specified by:
getRow in interface Image
Overrides:
getRow in interface jxl.biff.drawing.Drawing
Returns:
the row number at which the image is positions

getWidth

public double getWidth()
Accessor for the image dimensions
Specified by:
getWidth in interface jxl.biff.drawing.DrawingGroupObject
getWidth in interface Image
Overrides:
getWidth in interface jxl.biff.drawing.Drawing
Returns:
the number of columns this image spans

setColumn

public void setColumn(double c)
Accessor for the image position
Parameters:
c - the column number at which the image should be positioned

setHeight

public void setHeight(double c)
Accessor for the image dimensions Note that the actual size of the rendered image will depend on the height of the rows it spans
Specified by:
setHeight in interface jxl.biff.drawing.DrawingGroupObject
Overrides:
setHeight in interface jxl.biff.drawing.Drawing
Parameters:
c - the number of rows which this image should span

setImageAnchor

public void setImageAnchor(jxl.biff.drawing.Drawing.ImageAnchorProperties iap)
Accessor for the anchor properties

setRow

public void setRow(double c)
Accessor for the image position
Parameters:
c - the row number at which the image should be positioned

setWidth

public void setWidth(double c)
Accessor for the image dimensions Note that the actual size of the rendered image will depend on the width of the columns it spans
Specified by:
setWidth in interface jxl.biff.drawing.DrawingGroupObject
Overrides:
setWidth in interface jxl.biff.drawing.Drawing
Parameters:
c - the number of columns which this image spans