|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.poi.hssf.record.formula.Ptg
org.apache.poi.hssf.record.formula.AreaPtg
public class AreaPtg
Specifies a rectangular area of cells A1:A4 for instance.
Field Summary | |
---|---|
static short |
sid
|
Fields inherited from class org.apache.poi.hssf.record.formula.Ptg |
---|
CLASS_ARRAY, CLASS_REF, CLASS_VALUE, ptgClass |
Constructor Summary | |
---|---|
protected |
AreaPtg()
|
|
AreaPtg(int firstRow,
int lastRow,
int firstColumn,
int lastColumn,
boolean firstRowRelative,
boolean lastRowRelative,
boolean firstColRelative,
boolean lastColRelative)
|
|
AreaPtg(RecordInputStream in)
|
|
AreaPtg(java.lang.String arearef)
|
Method Summary | |
---|---|
java.lang.Object |
clone()
|
java.lang.String |
getAreaPtgName()
|
byte |
getDefaultOperandClass()
|
int |
getFirstColumn()
|
short |
getFirstColumnRaw()
|
int |
getFirstRow()
|
int |
getLastColumn()
|
short |
getLastColumnRaw()
|
int |
getLastRow()
|
int |
getSize()
|
boolean |
isFirstColRelative()
|
boolean |
isFirstRowRelative()
|
boolean |
isLastColRelative()
|
boolean |
isLastRowRelative()
|
protected java.lang.RuntimeException |
notImplemented()
TODO - (May-2008) fix subclasses of AreaPtg 'AreaN~' which are used in shared formulas. |
void |
setFirstColRelative(boolean rel)
set whether the first column is relative |
void |
setFirstColumn(int colIx)
set the first column in the area |
void |
setFirstColumnRaw(int column)
set the first column irespective of the bitmasks |
void |
setFirstRow(int rowIx)
sets the first row |
void |
setFirstRowRelative(boolean rel)
sets the first row to relative or not |
void |
setLastColRelative(boolean rel)
set whether the last column should be relative or not |
void |
setLastColumn(int colIx)
set the last column in the area |
void |
setLastColumnRaw(short column)
set the last column irrespective of the bitmasks |
void |
setLastRow(int rowIx)
|
void |
setLastRowRelative(boolean rel)
set whether the last row is relative or not |
protected static java.lang.String |
toFormulaString(AreaI area,
HSSFWorkbook book)
|
java.lang.String |
toFormulaString(HSSFWorkbook book)
return a string representation of this token alone |
java.lang.String |
toString()
Overridden toString method to ensure object hash is not printed. |
void |
writeBytes(byte[] array,
int offset)
write this Ptg to a byte array |
Methods inherited from class org.apache.poi.hssf.record.formula.Ptg |
---|
createParsedExpressionTokens, createPtg, getBytes, getPtgClass, serializePtgStack, setClass, toDebugString |
Methods inherited from class java.lang.Object |
---|
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final short sid
Constructor Detail |
---|
protected AreaPtg()
public AreaPtg(java.lang.String arearef)
public AreaPtg(int firstRow, int lastRow, int firstColumn, int lastColumn, boolean firstRowRelative, boolean lastRowRelative, boolean firstColRelative, boolean lastColRelative)
public AreaPtg(RecordInputStream in)
Method Detail |
---|
protected final java.lang.RuntimeException notImplemented()
public java.lang.String getAreaPtgName()
public java.lang.String toString()
Ptg
toString
in class Ptg
public void writeBytes(byte[] array, int offset)
Ptg
writeBytes
in class Ptg
public int getSize()
getSize
in class Ptg
public int getFirstRow()
getFirstRow
in interface AreaI
public void setFirstRow(int rowIx)
rowIx
- number (0-based)public int getLastRow()
getLastRow
in interface AreaI
public void setLastRow(int rowIx)
rowIx
- last row number in the areapublic int getFirstColumn()
getFirstColumn
in interface AreaI
public short getFirstColumnRaw()
public boolean isFirstRowRelative()
isFirstRowRelative
in interface AreaI
public void setFirstRowRelative(boolean rel)
rel
- is relative or not.public boolean isFirstColRelative()
isFirstColRelative
in interface AreaI
public void setFirstColRelative(boolean rel)
public void setFirstColumn(int colIx)
public void setFirstColumnRaw(int column)
public int getLastColumn()
getLastColumn
in interface AreaI
public short getLastColumnRaw()
public boolean isLastRowRelative()
isLastRowRelative
in interface AreaI
public void setLastRowRelative(boolean rel)
rel
- true
if the last row relative, else
false
public boolean isLastColRelative()
isLastColRelative
in interface AreaI
public void setLastColRelative(boolean rel)
public void setLastColumn(int colIx)
public void setLastColumnRaw(short column)
public java.lang.String toFormulaString(HSSFWorkbook book)
Ptg
toFormulaString
in class Ptg
protected static java.lang.String toFormulaString(AreaI area, HSSFWorkbook book)
public byte getDefaultOperandClass()
getDefaultOperandClass
in class Ptg
public java.lang.Object clone()
clone
in class Ptg
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |