Package org.apache.poi.ss.formula.ptg
Class AreaPtgBase
java.lang.Object
org.apache.poi.ss.formula.ptg.Ptg
org.apache.poi.ss.formula.ptg.OperandPtg
org.apache.poi.ss.formula.ptg.AreaPtgBase
- Direct Known Subclasses:
Area2DPtgBase,Area3DPtg,Area3DPxg
Specifies a rectangular area of cells A1:A4 for instance.
- Author:
- andy, Jason Height (jheight at chariot dot net dot au)
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.apache.poi.ss.formula.ptg.AreaI
AreaI.OffsetArea -
Field Summary
Fields inherited from class org.apache.poi.ss.formula.ptg.Ptg
CLASS_ARRAY, CLASS_REF, CLASS_VALUE, EMPTY_PTG_ARRAY -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedprotectedAreaPtgBase(int firstRow, int lastRow, int firstColumn, int lastColumn, boolean firstRowRelative, boolean lastRowRelative, boolean firstColRelative, boolean lastColRelative) protected -
Method Summary
Modifier and TypeMethodDescriptionprotected final Stringbytefinal intfinal shortfinal intfinal intfinal shortfinal intfinal booleanfinal booleanfinal booleanfinal booleanprotected final RuntimeExceptionTODO - (May-2008) fix subclasses of AreaPtg 'AreaN~' which are used in shared formulas.protected final voidfinal voidsetFirstColRelative(boolean rel) set whether the first column is relativefinal voidsetFirstColumn(int colIx) set the first column in the areafinal voidsetFirstColumnRaw(int column) set the first column irrespective of the bitmasksfinal voidsetFirstRow(int rowIx) sets the first rowfinal voidsetFirstRowRelative(boolean rel) sets the first row to relative or notfinal voidsetLastColRelative(boolean rel) set whether the last column should be relative or notfinal voidsetLastColumn(int colIx) set the last column in the areafinal voidsetLastColumnRaw(short column) set the last column irrespective of the bitmasksfinal voidsetLastRow(int rowIx) final voidsetLastRowRelative(boolean rel) set whether the last row is relative or notvoidSort the first and last row and columns in-place to the preferred (top left:bottom right) order Note: Sort only occurs when an instance is constructed or when this method is called.return a string representation of this token aloneprotected final voidMethods inherited from class org.apache.poi.ss.formula.ptg.OperandPtg
copy, isBaseTokenMethods inherited from class org.apache.poi.ss.formula.ptg.Ptg
createPtg, doesFormulaReferToDeletedCell, getEncodedSize, getEncodedSizeWithoutArrayData, getPtgClass, getRVAType, getSize, readTokens, serializePtgs, setClass, toString, write
-
Constructor Details
-
AreaPtgBase
protected AreaPtgBase() -
AreaPtgBase
-
AreaPtgBase
protected AreaPtgBase(int firstRow, int lastRow, int firstColumn, int lastColumn, boolean firstRowRelative, boolean lastRowRelative, boolean firstColRelative, boolean lastColRelative)
-
-
Method Details
-
notImplemented
TODO - (May-2008) fix subclasses of AreaPtg 'AreaN~' which are used in shared formulas. see similar comment in ReferencePtg -
sortTopLeftToBottomRight
public void sortTopLeftToBottomRight()Sort the first and last row and columns in-place to the preferred (top left:bottom right) order Note: Sort only occurs when an instance is constructed or when this method is called.For example,
$E5:B$10becomesB5:$E$10 -
readCoordinates
-
writeCoordinates
-
getFirstRow
public final int getFirstRow()- Specified by:
getFirstRowin interfaceAreaI- Returns:
- the first row in the area
-
setFirstRow
public final void setFirstRow(int rowIx) sets the first row- Parameters:
rowIx- number (0-based)
-
getLastRow
public final int getLastRow()- Specified by:
getLastRowin interfaceAreaI- Returns:
- last row in the range (x2 in x1,y1-x2,y2)
-
setLastRow
public final void setLastRow(int rowIx) - Parameters:
rowIx- last row number in the area
-
getFirstColumn
public final int getFirstColumn()- Specified by:
getFirstColumnin interfaceAreaI- Returns:
- the first column number in the area.
-
getFirstColumnRaw
public final short getFirstColumnRaw()- Returns:
- the first column number + the options bit settings unstripped
-
isFirstRowRelative
public final boolean isFirstRowRelative()- Returns:
- whether or not the first row is a relative reference or not.
-
setFirstRowRelative
public final void setFirstRowRelative(boolean rel) sets the first row to relative or not- Parameters:
rel- is relative or not.
-
isFirstColRelative
public final boolean isFirstColRelative()- Returns:
- isrelative first column to relative or not
-
setFirstColRelative
public final void setFirstColRelative(boolean rel) set whether the first column is relative -
setFirstColumn
public final void setFirstColumn(int colIx) set the first column in the area -
setFirstColumnRaw
public final void setFirstColumnRaw(int column) set the first column irrespective of the bitmasks -
getLastColumn
public final int getLastColumn()- Specified by:
getLastColumnin interfaceAreaI- Returns:
- lastcolumn in the area
-
getLastColumnRaw
public final short getLastColumnRaw()- Returns:
- last column and bitmask (the raw field)
-
isLastRowRelative
public final boolean isLastRowRelative()- Returns:
- last row relative or not
-
setLastRowRelative
public final void setLastRowRelative(boolean rel) set whether the last row is relative or not- Parameters:
rel-trueif the last row relative, elsefalse
-
isLastColRelative
public final boolean isLastColRelative()- Returns:
- lastcol relative or not
-
setLastColRelative
public final void setLastColRelative(boolean rel) set whether the last column should be relative or not -
setLastColumn
public final void setLastColumn(int colIx) set the last column in the area -
setLastColumnRaw
public final void setLastColumnRaw(short column) set the last column irrespective of the bitmasks -
formatReferenceAsString
-
toFormulaString
Description copied from class:Ptgreturn a string representation of this token alone- Specified by:
toFormulaStringin classPtg
-
getDefaultOperandClass
public byte getDefaultOperandClass()- Specified by:
getDefaultOperandClassin classPtg
-