Top Description Inners Fields Constructors Methods
org.apache.poi.ss.formula.ptg

public final Class AttrPtg

extends ControlPtg
Class Inheritance
Static Imports
org.apache.poi.util.GenericRecordUtil.getBitsAsString, .GenericRecordUtil.getEnumBitsAsString
"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)

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
AttrPtg.SpaceType

Field Summary

Modifier and TypeField and Description
private final int
_chooseFuncOffset

only used for tAttrChoose: offset to the tFuncVar for CHOOSE()

private final short
_data

private final int[]
_jumpTable

only used for tAttrChoose: table of offsets to starts of args

private final byte
_options

private static final BitField
baxcel

private static final BitField
optiChoose

private static final BitField
optiIf

private static final BitField
optiSkip

private static final BitField
optiSum

private static final BitField
semiVolatile

public static final byte
sid

private static final int
SIZE

private static final BitField
space

public static final AttrPtg
SUM

Constructor Summary

AccessConstructor and Description
public
AttrPtg(LittleEndianInput in)

private
AttrPtg(int options, int data, int[] jt, int chooseFuncOffset)

Method Summary

Modifier and TypeMethod and Description
public AttrPtg
copy()

Implements abstract org.apache.poi.ss.formula.ptg.Ptg.copy.

Implements org.apache.poi.common.Duplicatable.copy.

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

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

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

public int
getChooseFuncOffset()

public short
getData()

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

Implements org.apache.poi.common.usermodel.GenericRecord.getGenericProperties.

public int[]
getJumpTable()

public int
getNumberOfOperands()

public byte
getSid()

Implements abstract org.apache.poi.ss.formula.ptg.Ptg.getSid.

public int
getSize()

Implements abstract org.apache.poi.ss.formula.ptg.Ptg.getSize.

public static AttrPtg
getSumSingle()

public int
getType()

private boolean
isBaxcel()

public boolean
isOptimizedChoose()

public boolean
isOptimizedIf()

public boolean
isSemiVolatile()

public boolean
isSkip()

public boolean
isSpace()

public boolean
isSum()

public String
toFormulaString(String[] operands)

public String
toFormulaString()

Implements abstract org.apache.poi.ss.formula.ptg.Ptg.toFormulaString.

return a string representation of this token alone

public void
write(LittleEndianOutput out)

Implements abstract org.apache.poi.ss.formula.ptg.Ptg.write.

Inherited from org.apache.poi.ss.formula.ptg.ControlPtg:
getDefaultOperandClassisBaseToken

Field Detail

_chooseFuncOffsetback to summary
private final int _chooseFuncOffset

only used for tAttrChoose: offset to the tFuncVar for CHOOSE()

_databack to summary
private final short _data
_jumpTableback to summary
private final int[] _jumpTable

only used for tAttrChoose: table of offsets to starts of args

_optionsback to summary
private final byte _options
baxcelback to summary
private static final BitField baxcel
optiChooseback to summary
private static final BitField optiChoose
optiIfback to summary
private static final BitField optiIf
optiSkipback to summary
private static final BitField optiSkip
optiSumback to summary
private static final BitField optiSum
semiVolatileback to summary
private static final BitField semiVolatile
sidback to summary
public static final byte sid
SIZEback to summary
private static final int SIZE
spaceback to summary
private static final BitField space
SUMback to summary
public static final AttrPtg SUM

Constructor Detail

AttrPtgback to summary
public AttrPtg(LittleEndianInput in)
AttrPtgback to summary
private AttrPtg(int options, int data, int[] jt, int chooseFuncOffset)

Method Detail

copyback to summary
public AttrPtg copy()

Implements abstract org.apache.poi.ss.formula.ptg.Ptg.copy.

Implements org.apache.poi.common.Duplicatable.copy.

Returns:AttrPtg

Doc from org.apache.poi.common.Duplicatable.copy.

a deep copy of the implementing class / instance

Annotations
@Override
createIfback to summary
public static AttrPtg createIf(int dist)
Parameters
dist:int

distance (in bytes) to start of either

  • false parameter
  • tFuncVar(IF) token (when false parameter is not present)
createSkipback to summary
public static AttrPtg createSkip(int dist)
Parameters
dist:int

distance (in bytes) to position behind tFuncVar(IF) token (minus 1)

createSpaceback to summary
public static AttrPtg createSpace(int type, int count)
Parameters
type:int

a constant from SpaceType

count:int

the number of space characters

getChooseFuncOffsetback to summary
public int getChooseFuncOffset()
getDataback to summary
public short getData()
getGenericPropertiesback to summary
public Map<String, Supplier<?>> getGenericProperties()

Implements org.apache.poi.common.usermodel.GenericRecord.getGenericProperties.

Annotations
@Override
getJumpTableback to summary
public int[] getJumpTable()
getNumberOfOperandsback to summary
public int getNumberOfOperands()
getSidback to summary
public byte getSid()

Implements abstract org.apache.poi.ss.formula.ptg.Ptg.getSid.

Returns:byte

Doc from org.apache.poi.ss.formula.ptg.Ptg.getSid.

structure id of the parsed thing, or -1 if the record has no sid

Annotations
@Override
getSizeback to summary
public int getSize()

Implements abstract org.apache.poi.ss.formula.ptg.Ptg.getSize.

Returns:int

Doc from org.apache.poi.ss.formula.ptg.Ptg.getSize.

the encoded length of this Ptg, including the initial Ptg type identifier byte.

Annotations
@Override
getSumSingleback to summary
public static AttrPtg getSumSingle()
getTypeback to summary
public int getType()
isBaxcelback to summary
private boolean isBaxcel()
isOptimizedChooseback to summary
public boolean isOptimizedChoose()
isOptimizedIfback to summary
public boolean isOptimizedIf()
isSemiVolatileback to summary
public boolean isSemiVolatile()
isSkipback to summary
public boolean isSkip()
isSpaceback to summary
public boolean isSpace()
isSumback to summary
public boolean isSum()
toFormulaStringback to summary
public String toFormulaString(String[] operands)
toFormulaStringback to summary
public String toFormulaString()

Implements abstract org.apache.poi.ss.formula.ptg.Ptg.toFormulaString.

Doc from org.apache.poi.ss.formula.ptg.Ptg.toFormulaString.

return a string representation of this token alone

Annotations
@Override
writeback to summary
public void write(LittleEndianOutput out)

Implements abstract org.apache.poi.ss.formula.ptg.Ptg.write.

Annotations
@Override
org.apache.poi.ss.formula.ptg back to summary

public final Class AttrPtg.SpaceType

extends Object
Class Inheritance

Field Summary

Modifier and TypeField and Description
public static final int
CR_BEFORE

01H = Carriage returns before the next token (not allowed before tParen token)

public static final int
CR_BEFORE_CLOSE_PAREN

05H = Carriage returns before closing parenthesis (only allowed before tParen, tFunc, and tFuncVar tokens)

public static final int
CR_BEFORE_OPEN_PAREN

03H = Carriage returns before opening parenthesis (only allowed before tParen token)

public static final int
SPACE_AFTER_EQUALITY

06H = Spaces following the equality sign (only in macro sheets)

public static final int
SPACE_BEFORE

00H = Spaces before the next token (not allowed before tParen token)

public static final int
SPACE_BEFORE_CLOSE_PAREN

04H = Spaces before closing parenthesis (only allowed before tParen, tFunc, and tFuncVar tokens)

public static final int
SPACE_BEFORE_OPEN_PAREN

02H = Spaces before opening parenthesis (only allowed before tParen token)

Constructor Summary

AccessConstructor and Description
private
SpaceType()

Method Summary

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

CR_BEFOREback to summary
public static final int CR_BEFORE

01H = Carriage returns before the next token (not allowed before tParen token)

CR_BEFORE_CLOSE_PARENback to summary
public static final int CR_BEFORE_CLOSE_PAREN

05H = Carriage returns before closing parenthesis (only allowed before tParen, tFunc, and tFuncVar tokens)

CR_BEFORE_OPEN_PARENback to summary
public static final int CR_BEFORE_OPEN_PAREN

03H = Carriage returns before opening parenthesis (only allowed before tParen token)

SPACE_AFTER_EQUALITYback to summary
public static final int SPACE_AFTER_EQUALITY

06H = Spaces following the equality sign (only in macro sheets)

SPACE_BEFOREback to summary
public static final int SPACE_BEFORE

00H = Spaces before the next token (not allowed before tParen token)

SPACE_BEFORE_CLOSE_PARENback to summary
public static final int SPACE_BEFORE_CLOSE_PAREN

04H = Spaces before closing parenthesis (only allowed before tParen, tFunc, and tFuncVar tokens)

SPACE_BEFORE_OPEN_PARENback to summary
public static final int SPACE_BEFORE_OPEN_PAREN

02H = Spaces before opening parenthesis (only allowed before tParen token)

Constructor Detail

SpaceTypeback to summary
private SpaceType()