Apache POI - Common 5.3.0 · org.apache.poi.ss.usermodel.CellRange

Method Summary

Modifier and Type	Method and Description
public C	Returns: the cell at the specified coordinates. Never `null`. getCell(int must be between `0` and `height-1` relativeRowIndex, int must be between `0` and `width-1` relativeColumnIndex)
public C[][]	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`) getCells()
public C[]	Returns: a flattened array of all the cells in this CellRange getFlattenedCells()
public int	getHeight()
public String	Returns: the text format of this range. Single cell ranges are formatted like single cell references (e.g. 'A1' instead of 'A1:A1'). getReferenceText()
public C	Returns: the cell at relative coordinates (0,0). Never `null`. getTopLeftCell()
public int	getWidth()
public Iterator<C>	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. iterator() Redeclares java.lang.Iterable.iterator. Returns an iterator over elements of type `T`.
public int	Returns: `height * width` size() Gets the number of cells in this range.

getCell	back to summary
public C getCell(int relativeRowIndex, int relativeColumnIndex) Parameters relativeRowIndex:int must be between `0` and `height-1` relativeColumnIndex:int must be between `0` and `width-1` Returns:C the cell at the specified coordinates. Never `null`.

getCells	back to summary
public C[][] getCells() Returns:C[][] 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`)

getFlattenedCells	back to summary
public C[] getFlattenedCells() Returns:C[] a flattened array of all the cells in this CellRange

getHeight	back to summary
public int getHeight()

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

getTopLeftCell	back to summary
public C getTopLeftCell() Returns:C the cell at relative coordinates (0,0). Never `null`.

getWidth	back to summary
public int getWidth()

iterator back to summary

iterator	back to summary
public Iterator<C> iterator() Redeclares java.lang.Iterable.iterator. Doc from java.lang.Iterable.iterator. Returns an iterator over elements of type `T`. Returns:Iterator<C> 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. Annotations @Override

public Iterator<C> iterator()

Returns an iterator over elements of type T.

Returns:Iterator<C>

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.

Annotations

size back to summary

size	back to summary
public int size() Gets the number of cells in this range. Returns:int `height * width`

public int size()

Gets the number of cells in this range.