Package org.apache.poi.ss.usermodel
Interface CellRange<C extends Cell>
- All Superinterfaces:
Iterable<C>
- All Known Implementing Classes:
SSCellRange
Represents a rectangular region of a
Sheet
-
Method Summary
Methods inherited from interface java.lang.Iterable
forEach, spliterator
-
Method Details
-
getWidth
int getWidth() -
getHeight
int getHeight() -
size
int size()Gets the number of cells in this range.- Returns:
- height * width
-
getReferenceText
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').
-
getTopLeftCell
C getTopLeftCell()- Returns:
- the cell at relative coordinates (0,0). Never
null
.
-
getCell
- Parameters:
relativeRowIndex
- must be between 0 and height-1relativeColumnIndex
- must be between 0 and width-1- Returns:
- the cell at the specified coordinates. Never
null
.
-
getFlattenedCells
C[] getFlattenedCells()- Returns:
- a flattened array of all the cells in this
CellRange
-
getCells
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)
-
iterator
-