org.zkoss.poi.ss.util

Class AreaReference

java.lang.Object

org.zkoss.poi.ss.util.AreaReference

Direct Known Subclasses:

AreaReference

public class AreaReference
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
protected SpreadsheetVersion	version

Constructor Summary

Constructors

Constructor and Description
AreaReference(CellReference topLeft, CellReference botRight) Creates an area ref from a pair of Cell References.
AreaReference(String reference) Create an area ref from a string representation.
AreaReference(String reference, SpreadsheetVersion version)

Method Summary

Modifier and Type

Method and Description

String

formatAsString() Example return values: Result Comment A1:A1Single cell area reference without sheet A1:$C$1Multi-cell area reference without sheet Sheet1!A$1:B4Standard sheet name 'O''Brien''s Sales'!B5:C6' Sheet name with special characters static AreaReference[] generateContiguous(String reference) Takes a non-contiguous area reference, and returns an array of contiguous area references. CellReference[] getAllReferencedCells() Returns a reference to every cell covered by this area CellReference getFirstCell() CellReference getLastCell() Note - if this area reference refers to a single cell, the return value of this method will be identical to that of getFirstCell() static AreaReference getWholeColumn(SpreadsheetVersion version, String start, String end) static AreaReference getWholeRow(SpreadsheetVersion version, String start, String end) static boolean isContiguous(String reference) Is the reference for a contiguous (i.e. boolean isSingleCell() boolean isWholeColumnReference() static boolean isWholeColumnReference(SpreadsheetVersion version, CellReference topLeft, CellReference botRight) Is the reference for a whole-column reference, such as C:C or D:G ? boolean isWholeRowReference() e.g. static boolean isWholeRowReference(SpreadsheetVersion version, CellReference topLeft, CellReference botRight) String toString() Methods inherited from class java.lang.Object clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait Field Detail version protected SpreadsheetVersion version Constructor Detail AreaReference public AreaReference(String reference) Create an area ref from a string representation. Sheet names containing special characters should be delimited and escaped as per normal syntax rules for formulas. The area reference must be contiguous (i.e. represent a single rectangle, not a union of rectangles) AreaReference public AreaReference(String reference, SpreadsheetVersion version) AreaReference public AreaReference(CellReference topLeft, CellReference botRight) Creates an area ref from a pair of Cell References. Method Detail isContiguous public static boolean isContiguous(String reference) Is the reference for a contiguous (i.e. unbroken) area, or is it made up of several different parts? (If it is, you will need to call generateContiguous(String)) getWholeRow public static AreaReference getWholeRow(SpreadsheetVersion version, String start, String end) getWholeColumn public static AreaReference getWholeColumn(SpreadsheetVersion version, String start, String end) isWholeColumnReference public static boolean isWholeColumnReference(SpreadsheetVersion version, CellReference topLeft, CellReference botRight) Is the reference for a whole-column reference, such as C:C or D:G ? isWholeColumnReference public boolean isWholeColumnReference() isWholeRowReference public static boolean isWholeRowReference(SpreadsheetVersion version, CellReference topLeft, CellReference botRight) isWholeRowReference public boolean isWholeRowReference() e.g. 1:1 or 3:6 Returns: generateContiguous public static AreaReference[] generateContiguous(String reference) Takes a non-contiguous area reference, and returns an array of contiguous area references. isSingleCell public boolean isSingleCell() Returns: false if this area reference involves more than one cell getFirstCell public CellReference getFirstCell() Returns: the first cell reference which defines this area. Usually this cell is in the upper left corner of the area (but this is not a requirement). getLastCell public CellReference getLastCell() Note - if this area reference refers to a single cell, the return value of this method will be identical to that of getFirstCell() Returns: the second cell reference which defines this area. For multi-cell areas, this is cell diagonally opposite the 'first cell'. Usually this cell is in the lower right corner of the area (but this is not a requirement). getAllReferencedCells public CellReference[] getAllReferencedCells() Returns a reference to every cell covered by this area formatAsString public String formatAsString() Example return values: Result Comment A1:A1 Single cell area reference without sheet A1:$C$1 Multi-cell area reference without sheet Sheet1!A$1:B4 Standard sheet name 'O''Brien''s Sales'!B5:C6' Sheet name with special characters Returns: the text representation of this area reference as it would appear in a formula. toString public String toString() Overrides: toString in class Object Skip navigation links Overview Package Class Use Tree Deprecated Index Help Prev Class Next Class Frames No Frames All Classes Summary: Nested | Field | Constr | Method Detail: Field | Constr | Method Copyright © 2020. All rights reserved.