ActiveXLS
Class ExcelImage

System.Object
  ActiveXLS.ExcelImage

public class ExcelImage

extends System.Object

This class stores image information like image path and position in worksheet.

Constructor Summary

ExcelImage()
Defines an instance of the image.

ExcelImage(System.String path)
Defines an instance of the image having the specified path.

ExcelImage(System.String path, int row, int column)
Defines an instance of the image having the specified path and location
This constructor is applicable only to adding images to ExcelWorksheet objects

ExcelImage(System.String path, int row, int column, int width, int height)
Defines an instance of the image having the specified path, location and size
This constructor is applicable only to adding images to ExcelWorksheet objects

ExcelImage(System.String path, System.String position)
Defines an instance of the image having the specified path and location
This constructor is applicable only to adding images to ExcelWorksheet objects

ExcelImage(System.String path, System.String position, int width, int height)
Defines an instance of the image having the specified path, location and size
This constructor is applicable only to adding images to ExcelWorksheet objects

Method Summary

ExcelImage	Clone() Creates and returns a copy of this object.
ActiveXLS.BIFF_Records.Drawing_Records.BSE	getBSEImage() Internal use only.
int	getHeight() Returns the image height.
int	getHorizontalOffset() Returns the image horizontal offset
System.String	getImagePath() Returns the file path to image file.
int	getLeftUpperCornerColumn() Returns the column number where the left upper corner of the image is anchored This method is applicable only to adding images to ExcelWorksheet objects
int	getLeftUpperCornerRow() Returns the row number where the left upper corner of the image is anchored This method is applicable only to adding images to ExcelWorksheet objects
int	getVerticalOffset() Returns the image vertical offset
int	getWidth() Returns the image width.
void	setBSEImage(ActiveXLS.BIFF_Records.Drawing_Records.BSE image) Internal use only Sets the BSE record.
void	setImagePath(System.String path) Sets the file path to image file.
void	setLeftUpperCorner(int row, int column) Sets the left upper corner of the image This method is applicable only to adding images to ExcelWorksheet objects
void	setLeftUpperCorner(System.String cellReference) Sets the left upper corner of the image This method is applicable only to adding images to ExcelWorksheet objects
void	setLeftUpperOffset(int horizontalOffset, int verticalOffset) Sets the left upper corner offsets of the image.
void	setSize(int imageWidth, int imageHeight) Sets the image size.

Constructor Detail

ExcelImage

public ExcelImage()

Defines an instance of the image.

ExcelImage

public ExcelImage(System.String path)

Defines an instance of the image having the specified path.

Parameters:

path - the file path to image file

ExcelImage

public ExcelImage(System.String path,
                  int row,
                  int column)

Defines an instance of the image having the specified path and location
This constructor is applicable only to adding images to ExcelWorksheet objects

Parameters:

path - the file path to image file

row - the row number where the left upper corner of the image is anchored

column - the column number where the left upper corner of the image is anchored

ExcelImage

public ExcelImage(System.String path,
                  int row,
                  int column,
                  int width,
                  int height)

Defines an instance of the image having the specified path, location and size
This constructor is applicable only to adding images to ExcelWorksheet objects

Parameters:

path - the file path to image file

row - the row number where the left upper corner of the image is anchored

column - the column number where the left upper corner of the image is anchored

width - the image width

height - the image height

ExcelImage

public ExcelImage(System.String path,
                  System.String position)

Defines an instance of the image having the specified path and location
This constructor is applicable only to adding images to ExcelWorksheet objects

Parameters:

path - the file path to image file

position - the cell reference where the left upper corner of the image is anchored

ExcelImage

public ExcelImage(System.String path,
                  System.String position,
                  int width,
                  int height)

Defines an instance of the image having the specified path, location and size
This constructor is applicable only to adding images to ExcelWorksheet objects

Parameters:

path - the file path to image file

position - the cell reference where the left upper corner of the image is anchored

width - the image width

height - the image height

Method Detail

getBSEImage

public ActiveXLS.BIFF_Records.Drawing_Records.BSE getBSEImage()

Internal use only. Returns the BSE record.

Returns:

the BSE record

See Also:

setBSEImage(ActiveXLS.BIFF_Records.Drawing_Records.BSE)

setBSEImage

public void setBSEImage(ActiveXLS.BIFF_Records.Drawing_Records.BSE image)

Internal use only Sets the BSE record.

Parameters:

image - the BSE record

See Also:

getBSEImage()

getImagePath

public System.String getImagePath()

Returns the file path to image file.

Returns:

the file path to image file

See Also:

setImagePath(System.String)

setImagePath

public void setImagePath(System.String path)

Sets the file path to image file.

Parameters:

path - the file path to image file

See Also:

getImagePath()

setLeftUpperCorner

public void setLeftUpperCorner(int row,
                               int column)

Sets the left upper corner of the image
This method is applicable only to adding images to ExcelWorksheet objects

Parameters:

row - the row number where the left upper corner of the image is anchored

column - the column number where the left upper corner of the image is anchored

See Also:

setLeftUpperCorner(String), setLeftUpperOffset(int, int), setSize(int, int), getLeftUpperCornerRow(), getLeftUpperCornerColumn()

setLeftUpperCorner

public void setLeftUpperCorner(System.String cellReference)

Sets the left upper corner of the image
This method is applicable only to adding images to ExcelWorksheet objects

Parameters:

cellReference - the cell reference where the left upper corner of the image is anchored

See Also:

setLeftUpperCorner(int,int), setLeftUpperOffset(int, int), setSize(int, int), getLeftUpperCornerRow(), getLeftUpperCornerColumn()

getLeftUpperCornerRow

public int getLeftUpperCornerRow()

Returns the row number where the left upper corner of the image is anchored
This method is applicable only to adding images to ExcelWorksheet objects

Returns:

the row number where the left upper corner of the image is anchored

See Also:

setLeftUpperOffset(int, int), setSize(int, int), getLeftUpperCornerColumn()

getLeftUpperCornerColumn

public int getLeftUpperCornerColumn()

Returns the column number where the left upper corner of the image is anchored
This method is applicable only to adding images to ExcelWorksheet objects

Returns:

the column number where the left upper corner of the image is anchored

See Also:

setLeftUpperOffset(int, int), setSize(int, int), getLeftUpperCornerRow()

setLeftUpperOffset

public void setLeftUpperOffset(int horizontalOffset,
                               int verticalOffset)

Sets the left upper corner offsets of the image.

Parameters:

horizontalOffset - represents the distance from the left border of the cell to the left border of the image if ExcelImage is added to an ExcelWorksheet;if it is added to an ExcelChartSheet object, it will be the distance from the left margin of the chart to the left border of the image

verticalOffset - represents the distance from the top border of the cell to the top border of the image if ExcelImage is added to an ExcelWorksheet; if it is added to an ExcelChartSheet object, it will be the distance from the left margin of the chart to the top border of the image

See Also:

setLeftUpperCorner(String), setLeftUpperCorner(int,int), setSize(int, int)

setSize

public void setSize(int imageWidth,
                    int imageHeight)

Sets the image size.

Parameters:

imageWidth - the image width

imageHeight - the image height

See Also:

setLeftUpperCorner(String), setLeftUpperCorner(int,int), setLeftUpperOffset(int, int)

getHeight

public int getHeight()

Returns the image height.

Returns:

the image height.

See Also:

setSize(int, int), setLeftUpperCorner(String), setLeftUpperCorner(int,int), getWidth()

getWidth

public int getWidth()

Returns the image width.

Returns:

the image width.

See Also:

setSize(int, int), setLeftUpperCorner(String), setLeftUpperCorner(int,int), getHeight()

getHorizontalOffset

public int getHorizontalOffset()

Returns the image horizontal offset

Returns:

the distance from the left border of the cell to the left border of the image if ExcelImage is added to an ExcelWorksheet;if it is added to an ExcelChartSheet object, it returns the distance from the left margin of the chart to the left border of the image

See Also:

setLeftUpperOffset(int, int), setSize(int, int), getVerticalOffset()

getVerticalOffset

public int getVerticalOffset()

Returns the image vertical offset

Returns:

the distance from the top border of the cell to the top border of the image if ExcelImage is added to an ExcelWorksheet; if is added to an ExcelChartSheet object, it returns the distance from the left margin of the chart to the top border of the image

See Also:

setLeftUpperOffset(int, int), setSize(int, int), getHorizontalOffset()

Clone

public ExcelImage Clone()

Creates and returns a copy of this object.

Returns:

a clone of this instance.