Package org.apache.poi.ss.formula.ptg

Class AttrPtg

java.lang.Object
org.apache.poi.ss.formula.ptg.Ptg
org.apache.poi.ss.formula.ptg.ControlPtg
org.apache.poi.ss.formula.ptg.AttrPtg
All Implemented Interfaces:
org.apache.poi.common.Duplicatable, GenericRecord
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)

  • Field Details

  • Constructor Details

  • Method Details

    • createSpace

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

    • createIf

      public static AttrPtg createIf(int dist)
      Parameters:
      dist - distance (in bytes) to start of either
      • false parameter
      • tFuncVar(IF) token (when false parameter is not present)

    • createSkip

      public static AttrPtg createSkip(int dist)
      Parameters:
      dist - distance (in bytes) to position behind tFuncVar(IF) token (minus 1)

    • getSumSingle

      public static AttrPtg getSumSingle()

    • isSemiVolatile

      public boolean isSemiVolatile()

    • isOptimizedIf

      public boolean isOptimizedIf()

    • isOptimizedChoose

      public boolean isOptimizedChoose()

    • isSum

      public boolean isSum()

    • isSkip

      public boolean isSkip()

    • isSpace

      public boolean isSpace()

    • getData

      public short getData()

    • getJumpTable

      public int[] getJumpTable()

    • getChooseFuncOffset

      public int getChooseFuncOffset()

    • write

      public void write(LittleEndianOutput out)
      Specified by:
      write in class Ptg

    • getSid

      public byte getSid()
      Specified by:
      getSid in class Ptg
      Returns:
      structure id of the parsed thing, or -1 if the record has no sid

    • 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 String toFormulaString(String[] operands)

    • getNumberOfOperands

      public int getNumberOfOperands()

    • getType

      public int getType()

    • toFormulaString

      public String toFormulaString()
      Description copied from class: Ptg
      return a string representation of this token alone
      Specified by:
      toFormulaString in class Ptg

    • copy

      public AttrPtg copy()
      Specified by:
      copy in interface org.apache.poi.common.Duplicatable
      Specified by:
      copy in class Ptg

    • getGenericProperties

      public Map<String,Supplier<?>> getGenericProperties()