Package loci.poi.hssf.record.formula
Class AreaPtg
java.lang.Object
loci.poi.hssf.record.formula.Ptg
loci.poi.hssf.record.formula.AreaPtg
Specifies a rectangular area of cells A1:A4 for instance.
- Author:
- andy, Jason Height (jheight at chariot dot net dot au)
-
Field Summary
FieldsFields inherited from class loci.poi.hssf.record.formula.Ptg
CLASS_ARRAY, CLASS_REF, CLASS_VALUE, ptgClass -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()byteshortshortshortshortshortshortintgetSize()booleanbooleanbooleanbooleanvoidsetFirstColRelative(boolean rel) set whether the first column is relativevoidsetFirstColumn(short column) set the first column in the areavoidsetFirstColumnRaw(short column) set the first column irespective of the bitmasksvoidsetFirstRow(short row) sets the first rowvoidsetFirstRowRelative(boolean rel) sets the first row to relative or notvoidsetLastColRelative(boolean rel) set whether the last column should be relative or notvoidsetLastColumn(short column) set the last column in the areavoidsetLastColumnRaw(short column) set the last column irrespective of the bitmasksvoidsetLastRow(short row) voidsetLastRowRelative(boolean rel) set whether the last row is relative or nottoFormulaString(Workbook book) return a string representation of this token alonetoString()Overridden toString method to ensure object hash is not printed.voidwriteBytes(byte[] array, int offset) write this Ptg to a byte arrayMethods inherited from class loci.poi.hssf.record.formula.Ptg
createParsedExpressionTokens, createPtg, getBytes, getPtgClass, serializePtgStack, setClass, toDebugString
-
Field Details
-
sid
public static final short sid- See Also:
-
-
Constructor Details
-
AreaPtg
protected AreaPtg() -
AreaPtg
-
AreaPtg
public AreaPtg(short firstRow, short lastRow, short firstColumn, short lastColumn, boolean firstRowRelative, boolean lastRowRelative, boolean firstColRelative, boolean lastColRelative) -
AreaPtg
-
-
Method Details
-
getAreaPtgName
-
toString
Description copied from class:PtgOverridden toString method to ensure object hash is not printed. This helps get rid of gratuitous diffs when comparing two dumps Subclasses may output more relevant information by overriding this method -
writeBytes
public void writeBytes(byte[] array, int offset) Description copied from class:Ptgwrite this Ptg to a byte array- Specified by:
writeBytesin classPtg
-
getSize
public int getSize() -
getFirstRow
public short getFirstRow()- Returns:
- the first row in the area
-
setFirstRow
public void setFirstRow(short row) sets the first row- Parameters:
row- number (0-based)
-
getLastRow
public short getLastRow()- Returns:
- last row in the range (x2 in x1,y1-x2,y2)
-
setLastRow
public void setLastRow(short row) - Parameters:
row- last row number in the area
-
getFirstColumn
public short getFirstColumn()- Returns:
- the first column number in the area.
-
getFirstColumnRaw
public short getFirstColumnRaw()- Returns:
- the first column number + the options bit settings unstripped
-
isFirstRowRelative
public boolean isFirstRowRelative()- Returns:
- whether or not the first row is a relative reference or not.
-
setFirstRowRelative
public void setFirstRowRelative(boolean rel) sets the first row to relative or not- Parameters:
rel- is relative or not.
-
isFirstColRelative
public boolean isFirstColRelative()- Returns:
- isrelative first column to relative or not
-
setFirstColRelative
public void setFirstColRelative(boolean rel) set whether the first column is relative -
setFirstColumn
public void setFirstColumn(short column) set the first column in the area -
setFirstColumnRaw
public void setFirstColumnRaw(short column) set the first column irespective of the bitmasks -
getLastColumn
public short getLastColumn()- Returns:
- lastcolumn in the area
-
getLastColumnRaw
public short getLastColumnRaw()- Returns:
- last column and bitmask (the raw field)
-
isLastRowRelative
public boolean isLastRowRelative()- Returns:
- last row relative or not
-
setLastRowRelative
public void setLastRowRelative(boolean rel) set whether the last row is relative or not- Parameters:
rel-trueif the last row relative, elsefalse
-
isLastColRelative
public boolean isLastColRelative()- Returns:
- lastcol relative or not
-
setLastColRelative
public void setLastColRelative(boolean rel) set whether the last column should be relative or not -
setLastColumn
public void setLastColumn(short column) set the last column in the area -
setLastColumnRaw
public void setLastColumnRaw(short column) set the last column irrespective of the bitmasks -
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
-
clone
-