org.apache.poi.hssf.record.formula
Class AreaPtgBase

java.lang.Object
  extended by org.apache.poi.hssf.record.formula.Ptg
      extended by org.apache.poi.hssf.record.formula.OperandPtg
          extended by org.apache.poi.hssf.record.formula.AreaPtgBase
All Implemented Interfaces:
java.lang.Cloneable, AreaI
Direct Known Subclasses:
AreaNPtg, AreaPtg

public abstract class AreaPtgBase
extends OperandPtg
implements AreaI

Specifies a rectangular area of cells A1:A4 for instance.

Author:
andy, Jason Height (jheight at chariot dot net dot au)

Field Summary
static short sid
           
 
Fields inherited from class org.apache.poi.hssf.record.formula.Ptg
CLASS_ARRAY, CLASS_REF, CLASS_VALUE
 
Constructor Summary
protected AreaPtgBase(int firstRow, int lastRow, int firstColumn, int lastColumn, boolean firstRowRelative, boolean lastRowRelative, boolean firstColRelative, boolean lastColRelative)
           
protected AreaPtgBase(RecordInputStream in)
           
protected AreaPtgBase(java.lang.String arearef)
           
 
Method Summary
 byte getDefaultOperandClass()
           
 int getFirstColumn()
           
 short getFirstColumnRaw()
           
 int getFirstRow()
           
 int getLastColumn()
           
 short getLastColumnRaw()
           
 int getLastRow()
           
protected abstract  byte getSid()
           
 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 irrespective 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
 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.OperandPtg
isBaseToken
 
Methods inherited from class org.apache.poi.hssf.record.formula.Ptg
clone, copy, createParsedExpressionTokens, createPtg, getBytes, getEncodedSize, getEncodedSize, getPtgClass, readTokens, serializePtgs, serializePtgStack, setClass, toDebugString
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

sid

public static final short sid
See Also:
Constant Field Values
Constructor Detail

AreaPtgBase

protected AreaPtgBase(java.lang.String arearef)

AreaPtgBase

protected AreaPtgBase(int firstRow,
                      int lastRow,
                      int firstColumn,
                      int lastColumn,
                      boolean firstRowRelative,
                      boolean lastRowRelative,
                      boolean firstColRelative,
                      boolean lastColRelative)

AreaPtgBase

protected AreaPtgBase(RecordInputStream in)
Method Detail

notImplemented

protected final java.lang.RuntimeException notImplemented()
TODO - (May-2008) fix subclasses of AreaPtg 'AreaN~' which are used in shared formulas. see similar comment in ReferencePtg


toString

public final java.lang.String toString()
Description copied from class: Ptg
Overridden 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

Overrides:
toString in class Ptg

getSid

protected abstract byte getSid()

writeBytes

public final void writeBytes(byte[] array,
                             int offset)
Description copied from class: Ptg
write this Ptg to a byte array

Specified by:
writeBytes in class Ptg

getSize

public final int getSize()
Specified by:
getSize in class Ptg
Returns:
the encoded length of this Ptg, including the initial Ptg type identifier byte.

getFirstRow

public final int getFirstRow()
Specified by:
getFirstRow in interface AreaI
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:
getLastRow in interface AreaI
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:
getFirstColumn in interface AreaI
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()
Specified by:
isFirstRowRelative in interface AreaI
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()
Specified by:
isFirstColRelative in interface AreaI
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:
getLastColumn in interface AreaI
Returns:
lastcolumn in the area

getLastColumnRaw

public final short getLastColumnRaw()
Returns:
last column and bitmask (the raw field)

isLastRowRelative

public final boolean isLastRowRelative()
Specified by:
isLastRowRelative in interface AreaI
Returns:
last row relative or not

setLastRowRelative

public final void setLastRowRelative(boolean rel)
set whether the last row is relative or not

Parameters:
rel - true if the last row relative, else false

isLastColRelative

public final boolean isLastColRelative()
Specified by:
isLastColRelative in interface AreaI
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


toFormulaString

public java.lang.String toFormulaString(HSSFWorkbook book)
Description copied from class: Ptg
return a string representation of this token alone

Specified by:
toFormulaString in class Ptg

getDefaultOperandClass

public byte getDefaultOperandClass()
Specified by:
getDefaultOperandClass in class Ptg


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