Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.apache.poi.ss.util
Class CellRangeAddress

    java.lang.Object
      org.apache.poi.ss.util.CellRangeAddressBase
          org.apache.poi.ss.util.CellRangeAddress

    public class CellRangeAddress

extends CellRangeAddressBase

See OOO documentation: excelfileformat.pdf sec 2.5.14 - 'Cell Range Address'

In the Microsoft documentation, this is also known as a Ref8U - see page 831 of version 1.0 of the documentation. Note - `SelectionRecord` uses the BIFF5 version of this structure

Author:
  Dragos Buleandra (dragos.buleandra@trade2b.ro)

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.poi.ss.util.CellRangeAddressBase
`CellRangeAddressBase.CellPosition`

Field Summary
`static int` | `ENCODED_SIZE`

Constructor Summary
`CellRangeAddress(int firstRow, int lastRow, int firstCol, int lastCol)` Creates new cell range.
`CellRangeAddress(RecordInputStream in)`

Method Summary
`CellRangeAddress` | `copy()`
`java.lang.String` | `formatAsString()`
`java.lang.String` | `formatAsString(java.lang.String sheetName, boolean useAbsoluteAddress)`
`static int` | `getEncodedSize(int numberOfItems)`
`void` | `serialize(LittleEndianOutput out)`
`static CellRangeAddress` | `valueOf(java.lang.String ref)` Creates a CellRangeAddress from a cell range reference string.

Methods inherited from class org.apache.poi.ss.util.CellRangeAddressBase
`containsColumn, containsRow, equals, getFirstColumn, getFirstRow, getLastColumn, getLastRow, getMaxColumn, getMaxRow, getMinColumn, getMinRow, getNumberOfCells, getPosition, hashCode, intersects, isFullColumnRange, isFullRowRange, isInRange, isInRange, isInRange, setFirstColumn, setFirstRow, setLastColumn, setLastRow, toString, validate`

Methods inherited from class java.lang.Object
`clone, finalize, getClass, notify, notifyAll, wait, wait, wait`

Field Detail

### ENCODED_SIZE

    public static final int ENCODED_SIZE

See Also:
  Constant Field Values

Constructor Detail

### CellRangeAddress

    public CellRangeAddress(int firstRow,
                            int lastRow,
                            int firstCol,
                            int lastCol)

  Creates new cell range. Indexes are zero-based.

  Parameters:
    `firstRow` - Index of first row
    `lastRow` - Index of last row (inclusive), must be equal to or larger than `firstRow`
    `firstCol` - Index of first column
    `lastCol` - Index of last column (inclusive), must be equal to or larger than `firstCol`

### CellRangeAddress

    public CellRangeAddress(RecordInputStream in)

Method Detail

### serialize

    public void serialize(LittleEndianOutput out)

### copy

    public CellRangeAddress copy()

### getEncodedSize

    public static int getEncodedSize(int numberOfItems)

### formatAsString

    public java.lang.String formatAsString()

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

### formatAsString

    public java.lang.String formatAsString(java.lang.String sheetName,
                                           boolean useAbsoluteAddress)

  Returns:
    the text format of this range using specified sheet name.

### valueOf

    public static CellRangeAddress valueOf(java.lang.String ref)

  Creates a CellRangeAddress from a cell range reference string.

  Parameters:
    `ref` - usually a standard area ref (e.g. "B1:D8"). May be a single cell ref (e.g. "B5") in which case the result is a 1 x 1 cell range. May also be a whole row range (e.g. "3:5"), or a whole column range (e.g. "C:F")

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright 2017 The Apache Software Foundation or its licensors, as applicable.