org.apache.poi.examples.ss

Class AddDimensionedImage.ClientAnchorDetail

java.lang.Object

org.apache.poi.examples.ss.AddDimensionedImage.ClientAnchorDetail

Enclosing class:

AddDimensionedImage

public static class AddDimensionedImage.ClientAnchorDetail
extends Object

The HSSFClientAnchor class accepts eight arguments. In order, these are;

* How far the left hand edge of the image is inset from the left hand edge of the cell * How far the top edge of the image is inset from the top of the cell * How far the right hand edge of the image is inset from the left hand edge of the cell * How far the bottom edge of the image is inset from the top of the cell. * Together, arguments five and six determine the column and row coordinates of the cell whose top left hand corner will be aligned with the images top left hand corner. * Together, arguments seven and eight determine the column and row coordinates of the cell whose top left hand corner will be aligned with the images bottom right hand corner.

An instance of the ClientAnchorDetail class provides three of the eight parameters, one of the coordinates for the images top left hand corner, one of the coordinates for the images bottom right hand corner and either how far the image should be inset from the top or the left hand edge of the cell.

Constructor Summary

Constructors

Constructor and Description
ClientAnchorDetail(int fromIndex, int toIndex, int inset) Create a new instance of the ClientAnchorDetail class using the following parameters.

Method Summary

Modifier and Type	Method and Description
int	getFromIndex() Get one of the number of the column or row that contains the cell whose top left hand corner will be aligned with the top left hand corner of the image.
int	getInset() Get the images offset from the edge of a cell.
int	getToIndex() Get one of the number of the column or row that contains the cell whose top left hand corner will be aligned with the bottom right hand corner of the image.

Methods inherited from class java.lang.Object

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

Constructor Detail

ClientAnchorDetail

public ClientAnchorDetail(int fromIndex,
                          int toIndex,
                          int inset)

Create a new instance of the ClientAnchorDetail class using the following parameters.

Parameters:

fromIndex - A primitive int that contains one of the coordinates (row or column index) for the top left hand corner of the image.

toIndex - A primitive int that contains one of the coordinates (row or column index) for the bottom right hand corner of the image.

inset - A primitive int that contains a value which indicates how far the image should be inset from the top or the left hand edge of a cell.

Method Detail

getFromIndex

public int getFromIndex()

Get one of the number of the column or row that contains the cell whose top left hand corner will be aligned with the top left hand corner of the image.

Returns:

The value - row or column index - for one of the coordinates of the top left hand corner of the image.

getToIndex

public int getToIndex()

Get one of the number of the column or row that contains the cell whose top left hand corner will be aligned with the bottom right hand corner of the image.

Returns:

The value - row or column index - for one of the coordinates of the bottom right hand corner of the image.

getInset

public int getInset()

Get the images offset from the edge of a cell.

Returns:

How far either the right hand or bottom edge of the image is inset from the left hand or top edge of a cell.