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

java.lang.Object
  extended by org.apache.poi.hssf.record.formula.Ptg
      extended by org.apache.poi.hssf.record.formula.ControlPtg
          extended by org.apache.poi.hssf.record.formula.AttrPtg
All Implemented Interfaces:
java.lang.Cloneable

public final class AttrPtg
extends ControlPtg

"Special Attributes" This seems to be a Misc Stuff and Junk record. One function it serves is in SUM functions (i.e. SUM(A1:A3) causes an area PTG then an ATTR with the SUM option set)

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

Nested Class Summary
static class AttrPtg.SpaceType
           
 
Field Summary
static byte sid
           
 
Fields inherited from class org.apache.poi.hssf.record.formula.Ptg
CLASS_ARRAY, CLASS_REF, CLASS_VALUE
 
Constructor Summary
AttrPtg()
           
AttrPtg(RecordInputStream in)
           
 
Method Summary
 java.lang.Object clone()
           
static AttrPtg createSpace(int type, int count)
           
 short getData()
           
 int getNumberOfOperands()
           
 byte getOptions()
           
 int getSize()
           
 int getType()
           
 boolean isBaxcel()
           
 boolean isGoto()
           
 boolean isOptimizedChoose()
           
 boolean isOptimizedIf()
           
 boolean isSemiVolatile()
           
 boolean isSpace()
           
 boolean isSum()
           
 void setData(short data)
           
 void setGoto(boolean isGoto)
          Flags this ptg as a goto/jump
 void setOptimizedIf(boolean bif)
           
 void setOptions(byte options)
           
 void setSum(boolean bsum)
           
 java.lang.String toFormulaString(HSSFWorkbook book)
          return a string representation of this token alone
 java.lang.String toFormulaString(java.lang.String[] operands)
           
 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.ControlPtg
getDefaultOperandClass, isBaseToken
 
Methods inherited from class org.apache.poi.hssf.record.formula.Ptg
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 byte sid
See Also:
Constant Field Values
Constructor Detail

AttrPtg

public AttrPtg()

AttrPtg

public AttrPtg(RecordInputStream in)
Method Detail

createSpace

public static AttrPtg createSpace(int type,
                                  int count)
Parameters:
type - a constant from SpaceType
count - the number of space characters

setOptions

public void setOptions(byte options)

getOptions

public byte getOptions()

isSemiVolatile

public boolean isSemiVolatile()

isOptimizedIf

public boolean isOptimizedIf()

isOptimizedChoose

public boolean isOptimizedChoose()

isGoto

public boolean isGoto()

isSum

public boolean isSum()

setSum

public void setSum(boolean bsum)

setOptimizedIf

public void setOptimizedIf(boolean bif)

setGoto

public void setGoto(boolean isGoto)
Flags this ptg as a goto/jump

Parameters:
isGoto -

isBaxcel

public boolean isBaxcel()

isSpace

public boolean isSpace()

setData

public void setData(short data)

getData

public short getData()

toString

public 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

writeBytes

public 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 int getSize()
Specified by:
getSize in class Ptg
Returns:
the encoded length of this Ptg, including the initial Ptg type identifier byte.

toFormulaString

public java.lang.String toFormulaString(java.lang.String[] operands)

getNumberOfOperands

public int getNumberOfOperands()

getType

public int getType()

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

clone

public java.lang.Object clone()
Overrides:
clone in class Ptg


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