CellRange (POI API Documentation)

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

org.apache.poi.ss.usermodel
Interface CellRange<C extends Cell>

Represents a rectangular region of a Sheet

Method Summary
`C`	`getCell(int relativeRowIndex, int relativeColumnIndex)`
`C[][]`	`getCells()`
`C[]`	`getFlattenedCells()`
`int`	`getHeight()`
`java.lang.String`	`getReferenceText()`
`C`	`getTopLeftCell()`
`int`	`getWidth()`
`java.util.Iterator<C>`	`iterator()`
`int`	`size()` Gets the number of cells in this range.

Method Detail

int getWidth()

int getHeight()

int size()

Gets the number of cells in this range.

java.lang.String getReferenceText()

Returns:: the text format of this range. Single cell ranges are formatted like single cell references (e.g. 'A1' instead of 'A1:A1').

C getTopLeftCell()

C getCell(int relativeRowIndex,          int relativeColumnIndex)

Parameters:: relativeRowIndex - must be between 0 and height-1; relativeColumnIndex - must be between 0 and width-1
Returns:: the cell at the specified coordinates. Never null.

C[] getFlattenedCells()

C[][] getCells()

Returns:: a 2-D array of all the cells in this CellRange. The first array dimension is the row index (values 0...height-1) and the second dimension is the column index (values 0...width-1)

java.util.Iterator<C> iterator()

Returns:: an Iterator over all cells in this range. Iteration starts with all cells in the first row followed by all cells in the next row, etc.

PREV CLASS NEXT CLASS

FRAMES NO FRAMES