Modifier and Type	Class and Description
public static interface	CFRuleBase.ComparisonOperator

Field Summary

Modifier and Type	Field and Description
protected BorderFormatting	_borderFormatting
protected FontFormatting	_fontFormatting
protected PatternFormatting	_patternFormatting
pack-priv static final BitField	align
pack-priv static final BitField	alignHor
pack-priv static final BitField	alignIndent
pack-priv static final BitField	alignJustLast
pack-priv static final BitField	alignRot
pack-priv static final BitField	alignShrin
pack-priv static final BitField	alignTextDir
pack-priv static final BitField	alignVer
pack-priv static final BitField	alignWrap
pack-priv static final BitField	bord
pack-priv static final BitField	bordBlTr
pack-priv static final BitField	bordBot
pack-priv static final BitField	bordLeft
pack-priv static final BitField	bordRight
pack-priv static final BitField	bordTlBr
pack-priv static final BitField	bordTop
private byte	comparison_operator
private byte	condition_type
public static final byte	CONDITION_TYPE_CELL_VALUE_IS
public static final byte	CONDITION_TYPE_COLOR_SCALE
public static final byte	CONDITION_TYPE_DATA_BAR
public static final byte	CONDITION_TYPE_FILTER
public static final byte	CONDITION_TYPE_FORMULA
public static final byte	CONDITION_TYPE_ICON_SET
pack-priv static final BitField	fmtBlockBits
pack-priv static final BitField	font
protected short	formatting_not_used
protected int	formatting_options
private Formula	formula1
private Formula	formula2
protected static final Logger	LOG
pack-priv static final BitField	mergeCell
pack-priv static final BitField	modificationBits
pack-priv static final BitField	notUsed2
pack-priv static final BitField	patt
pack-priv static final BitField	pattBgCol
pack-priv static final BitField	pattCol
pack-priv static final BitField	pattStyle
pack-priv static final BitField	prot
pack-priv static final BitField	protHidden
pack-priv static final BitField	protLocked
public static final int	TEMPLATE_ABOVE_AVERAGE
public static final int	TEMPLATE_ABOVE_OR_EQUAL_TO_AVERAGE
public static final int	TEMPLATE_BELOW_AVERAGE
public static final int	TEMPLATE_BELOW_OR_EQUAL_TO_AVERAGE
public static final int	TEMPLATE_CELL_VALUE
public static final int	TEMPLATE_COLOR_SCALE_FORMATTING
public static final int	TEMPLATE_CONTAINS_BLANKS
public static final int	TEMPLATE_CONTAINS_ERRORS
public static final int	TEMPLATE_CONTAINS_NO_BLANKS
public static final int	TEMPLATE_CONTAINS_NO_ERRORS
public static final int	TEMPLATE_CONTAINS_TEXT
public static final int	TEMPLATE_DATA_BAR_FORMATTING
public static final int	TEMPLATE_DUPLICATE_VALUES
public static final int	TEMPLATE_FILTER
public static final int	TEMPLATE_FORMULA
public static final int	TEMPLATE_ICON_SET_FORMATTING
public static final int	TEMPLATE_LAST_7_DAYS
public static final int	TEMPLATE_LAST_MONTH
public static final int	TEMPLATE_LAST_WEEK
public static final int	TEMPLATE_NEXT_MONTH
public static final int	TEMPLATE_NEXT_WEEK
public static final int	TEMPLATE_THIS_MONTH
public static final int	TEMPLATE_THIS_WEEK
public static final int	TEMPLATE_TODAY
public static final int	TEMPLATE_TOMORROW
public static final int	TEMPLATE_UNIQUE_VALUES
public static final int	TEMPLATE_YESTERDAY
pack-priv static final BitField	undocumented

Constructor Summary

Access	Constructor and Description
protected	CFRuleBase(byte the condition type conditionType, byte the comparison operation comparisonOperation) Creates new CFRuleRecord
protected	CFRuleBase(byte conditionType, byte comparisonOperation, Ptg[] formula1, Ptg[] formula2)
protected	CFRuleBase()
protected	CFRuleBase(CFRuleBase other)

Method Summary

Modifier and Type	Method and Description
private static BitField	bf(int i)
public boolean	containsAlignFormattingBlock()
public boolean	containsBorderFormattingBlock()
public boolean	containsFontFormattingBlock()
public boolean	containsPatternFormattingBlock()
public boolean	containsProtectionFormattingBlock()
public abstract CFRuleBase	copy() Redeclares org.apache.poi.common.Duplicatable.copy. Implements abstract org.apache.poi.hssf.record.StandardRecord.copy.
public BorderFormatting	getBorderFormatting()
public byte	getComparisonOperation()
public byte	getConditionType()
public FontFormatting	getFontFormatting()
protected int	getFormattingBlockSize()
protected Formula	getFormula1()
protected Formula	getFormula2()
protected static int	Returns: encoded size of the formula tokens (does not include 2 bytes for ushort length) getFormulaSize(Formula must not be `null` formula)
public Map<String, Supplier<?>>	getGenericProperties() Implements org.apache.poi.common.usermodel.GenericRecord.getGenericProperties.
private boolean	getOptionFlag(BitField field)
public int	Returns: bit mask getOptions() get the option flags
public Ptg[]	Returns: list of tokens (casts stack to a list and returns it!) this method can return null is we are unable to create Ptgs from existing excel file callers should check for null! getParsedExpression1() get the stack of the 1st expression as a list
public Ptg[]	Returns: array of `Ptg`s, possibly `null` getParsedExpression2() get the stack of the 2nd expression as a list
public PatternFormatting	getPatternFormatting()
public boolean	isBottomBorderModified()
public boolean	isBottomLeftTopRightBorderModified()
public boolean	isLeftBorderModified()
private boolean	isModified(BitField field)
public boolean	isPatternBackgroundColorModified()
public boolean	isPatternColorModified()
public boolean	isPatternStyleModified()
public boolean	isRightBorderModified()
public boolean	isTopBorderModified()
public boolean	isTopLeftBottomRightBorderModified()
public static Ptg[]	Returns: `null` if `formula` was null. parseFormula(String The formula to parse, excluding the leading equals sign. formula, HSSFSheet The sheet that the formula is on. sheet) TODO - parse conditional format formulas properly i.e. produce tRefN and tAreaN instead of tRef and tArea this call will produce the wrong results if the formula contains any cell references One approach might be to apply the inverse of SharedFormulaRecord.convertSharedFormulas(Stack, int, int) Note - two extra parameters (rowIx & colIx) will be required.
protected int	readFormatOptions(RecordInputStream in)
protected void	serializeFormattingBlock(LittleEndianOutput out)
public void	setAlignFormattingUnchanged()
public void	setBorderFormatting(BorderFormatting borderFormatting)
public void	setBottomBorderModified(boolean modified)
public void	setBottomLeftTopRightBorderModified(boolean modified)
public void	setComparisonOperation(byte operation)
protected void	setConditionType(byte condition_type)
public void	setFontFormatting(FontFormatting fontFormatting)
protected void	setFormula1(Formula formula1)
protected void	setFormula2(Formula formula2)
public void	setLeftBorderModified(boolean modified)
private void	setModified(boolean modified, BitField field)
private void	setOptionFlag(boolean flag, BitField field)
public void	setParsedExpression1(Ptg[] ptgs)
public void	setParsedExpression2(Ptg[] ptgs)
public void	setPatternBackgroundColorModified(boolean modified)
public void	setPatternColorModified(boolean modified)
public void	setPatternFormatting(PatternFormatting patternFormatting)
public void	setPatternStyleModified(boolean modified)
public void	setProtectionFormattingUnchanged()
public void	setRightBorderModified(boolean modified)
public void	setTopBorderModified(boolean modified)
public void	setTopLeftBottomRightBorderModified(boolean modified)

Inherited from org.apache.poi.hssf.record.StandardRecord:: getDataSize getRecordSize serialize serialize

Field Detail

_borderFormatting	back to summary
protected BorderFormatting _borderFormatting

_fontFormatting	back to summary
protected FontFormatting _fontFormatting

_patternFormatting	back to summary
protected PatternFormatting _patternFormatting

align	back to summary
pack-priv static final BitField align

alignHor	back to summary
pack-priv static final BitField alignHor

alignIndent	back to summary
pack-priv static final BitField alignIndent

alignJustLast	back to summary
pack-priv static final BitField alignJustLast

alignRot	back to summary
pack-priv static final BitField alignRot

alignShrin	back to summary
pack-priv static final BitField alignShrin

alignTextDir	back to summary
pack-priv static final BitField alignTextDir

alignVer	back to summary
pack-priv static final BitField alignVer

alignWrap	back to summary
pack-priv static final BitField alignWrap

bord	back to summary
pack-priv static final BitField bord

bordBlTr	back to summary
pack-priv static final BitField bordBlTr

bordBot	back to summary
pack-priv static final BitField bordBot

bordLeft	back to summary
pack-priv static final BitField bordLeft

bordRight	back to summary
pack-priv static final BitField bordRight

bordTlBr	back to summary
pack-priv static final BitField bordTlBr

bordTop	back to summary
pack-priv static final BitField bordTop

comparison_operator	back to summary
private byte comparison_operator

condition_type	back to summary
private byte condition_type

CONDITION_TYPE_CELL_VALUE_IS	back to summary
public static final byte CONDITION_TYPE_CELL_VALUE_IS

CONDITION_TYPE_COLOR_SCALE	back to summary
public static final byte CONDITION_TYPE_COLOR_SCALE

CONDITION_TYPE_DATA_BAR	back to summary
public static final byte CONDITION_TYPE_DATA_BAR

CONDITION_TYPE_FILTER	back to summary
public static final byte CONDITION_TYPE_FILTER

CONDITION_TYPE_FORMULA	back to summary
public static final byte CONDITION_TYPE_FORMULA

CONDITION_TYPE_ICON_SET	back to summary
public static final byte CONDITION_TYPE_ICON_SET

fmtBlockBits	back to summary
pack-priv static final BitField fmtBlockBits

font	back to summary
pack-priv static final BitField font

formatting_not_used	back to summary
protected short formatting_not_used

formatting_options	back to summary
protected int formatting_options

formula1	back to summary
private Formula formula1

formula2	back to summary
private Formula formula2

LOG	back to summary
protected static final Logger LOG

mergeCell	back to summary
pack-priv static final BitField mergeCell

modificationBits	back to summary
pack-priv static final BitField modificationBits

notUsed2	back to summary
pack-priv static final BitField notUsed2

patt	back to summary
pack-priv static final BitField patt

pattBgCol	back to summary
pack-priv static final BitField pattBgCol

pattCol	back to summary
pack-priv static final BitField pattCol

pattStyle	back to summary
pack-priv static final BitField pattStyle

prot	back to summary
pack-priv static final BitField prot

protHidden	back to summary
pack-priv static final BitField protHidden

protLocked	back to summary
pack-priv static final BitField protLocked

TEMPLATE_ABOVE_AVERAGE	back to summary
public static final int TEMPLATE_ABOVE_AVERAGE

TEMPLATE_ABOVE_OR_EQUAL_TO_AVERAGE	back to summary
public static final int TEMPLATE_ABOVE_OR_EQUAL_TO_AVERAGE

TEMPLATE_BELOW_AVERAGE	back to summary
public static final int TEMPLATE_BELOW_AVERAGE

TEMPLATE_BELOW_OR_EQUAL_TO_AVERAGE	back to summary
public static final int TEMPLATE_BELOW_OR_EQUAL_TO_AVERAGE

TEMPLATE_CELL_VALUE	back to summary
public static final int TEMPLATE_CELL_VALUE

TEMPLATE_COLOR_SCALE_FORMATTING	back to summary
public static final int TEMPLATE_COLOR_SCALE_FORMATTING

TEMPLATE_CONTAINS_BLANKS	back to summary
public static final int TEMPLATE_CONTAINS_BLANKS

TEMPLATE_CONTAINS_ERRORS	back to summary
public static final int TEMPLATE_CONTAINS_ERRORS

TEMPLATE_CONTAINS_NO_BLANKS	back to summary
public static final int TEMPLATE_CONTAINS_NO_BLANKS

TEMPLATE_CONTAINS_NO_ERRORS	back to summary
public static final int TEMPLATE_CONTAINS_NO_ERRORS

TEMPLATE_CONTAINS_TEXT	back to summary
public static final int TEMPLATE_CONTAINS_TEXT

TEMPLATE_DATA_BAR_FORMATTING	back to summary
public static final int TEMPLATE_DATA_BAR_FORMATTING

TEMPLATE_DUPLICATE_VALUES	back to summary
public static final int TEMPLATE_DUPLICATE_VALUES

TEMPLATE_FILTER	back to summary
public static final int TEMPLATE_FILTER

TEMPLATE_FORMULA	back to summary
public static final int TEMPLATE_FORMULA

TEMPLATE_ICON_SET_FORMATTING	back to summary
public static final int TEMPLATE_ICON_SET_FORMATTING

TEMPLATE_LAST_7_DAYS	back to summary
public static final int TEMPLATE_LAST_7_DAYS

TEMPLATE_LAST_MONTH	back to summary
public static final int TEMPLATE_LAST_MONTH

TEMPLATE_LAST_WEEK	back to summary
public static final int TEMPLATE_LAST_WEEK

TEMPLATE_NEXT_MONTH	back to summary
public static final int TEMPLATE_NEXT_MONTH

TEMPLATE_NEXT_WEEK	back to summary
public static final int TEMPLATE_NEXT_WEEK

TEMPLATE_THIS_MONTH	back to summary
public static final int TEMPLATE_THIS_MONTH

TEMPLATE_THIS_WEEK	back to summary
public static final int TEMPLATE_THIS_WEEK

TEMPLATE_TODAY	back to summary
public static final int TEMPLATE_TODAY

TEMPLATE_TOMORROW	back to summary
public static final int TEMPLATE_TOMORROW

TEMPLATE_UNIQUE_VALUES	back to summary
public static final int TEMPLATE_UNIQUE_VALUES

TEMPLATE_YESTERDAY	back to summary
public static final int TEMPLATE_YESTERDAY

undocumented	back to summary
pack-priv static final BitField undocumented

Constructor Detail

CFRuleBase

back to summary

protected CFRuleBase(byte conditionType, byte comparisonOperation)

Creates new CFRuleRecord

Parameters

conditionType:byte: the condition type
comparisonOperation:byte: the comparison operation

CFRuleBase	back to summary
protected CFRuleBase(byte conditionType, byte comparisonOperation, Ptg[] formula1, Ptg[] formula2)

CFRuleBase	back to summary
protected CFRuleBase()

CFRuleBase	back to summary
protected CFRuleBase(CFRuleBase other)

Method Detail

bf	back to summary
private static BitField bf(int i)

containsAlignFormattingBlock	back to summary
public boolean containsAlignFormattingBlock()

containsBorderFormattingBlock	back to summary
public boolean containsBorderFormattingBlock()

containsFontFormattingBlock	back to summary
public boolean containsFontFormattingBlock()

containsPatternFormattingBlock	back to summary
public boolean containsPatternFormattingBlock()

containsProtectionFormattingBlock	back to summary
public boolean containsProtectionFormattingBlock()

copy

back to summary

public abstract CFRuleBase copy()

Redeclares org.apache.poi.common.Duplicatable.copy.

Implements abstract org.apache.poi.hssf.record.StandardRecord.copy.

Returns:CFRuleBase

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

a deep copy of the implementing class / instance

Annotations

@Override

getBorderFormatting	back to summary
public BorderFormatting getBorderFormatting()

getComparisonOperation	back to summary
public byte getComparisonOperation()

getConditionType	back to summary
public byte getConditionType()

getFontFormatting	back to summary
public FontFormatting getFontFormatting()

getFormattingBlockSize	back to summary
protected int getFormattingBlockSize()

getFormula1	back to summary
protected Formula getFormula1()

getFormula2	back to summary
protected Formula getFormula2()

getFormulaSize	back to summary
protected static int getFormulaSize(Formula formula) Parameters formula:Formula must not be `null` Returns:int encoded size of the formula tokens (does not include 2 bytes for ushort length)

getGenericProperties

back to summary

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

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

Annotations

@Override

getOptionFlag	back to summary
private boolean getOptionFlag(BitField field)

getOptions

back to summary

public int getOptions()

get the option flags

Returns:int: bit mask

getParsedExpression1

back to summary

public Ptg[] getParsedExpression1()

get the stack of the 1st expression as a list

Returns:Ptg[]: list of tokens (casts stack to a list and returns it!) this method can return null is we are unable to create Ptgs from existing excel file callers should check for null!

getParsedExpression2 back to summary

public Ptg[] getParsedExpression2()

get the stack of the 2nd expression as a list

Returns:Ptg[]: array of Ptgs, possibly null

getPatternFormatting	back to summary
public PatternFormatting getPatternFormatting()

isBottomBorderModified	back to summary
public boolean isBottomBorderModified()

isBottomLeftTopRightBorderModified	back to summary
public boolean isBottomLeftTopRightBorderModified()

isLeftBorderModified	back to summary
public boolean isLeftBorderModified()

isModified	back to summary
private boolean isModified(BitField field)

isPatternBackgroundColorModified	back to summary
public boolean isPatternBackgroundColorModified()

isPatternColorModified	back to summary
public boolean isPatternColorModified()

isPatternStyleModified	back to summary
public boolean isPatternStyleModified()

isRightBorderModified	back to summary
public boolean isRightBorderModified()

isTopBorderModified	back to summary
public boolean isTopBorderModified()

isTopLeftBottomRightBorderModified	back to summary
public boolean isTopLeftBottomRightBorderModified()

parseFormula back to summary

public static Ptg[] parseFormula(String formula, HSSFSheet sheet)

TODO - parse conditional format formulas properly i.e. produce tRefN and tAreaN instead of tRef and tArea this call will produce the wrong results if the formula contains any cell references One approach might be to apply the inverse of SharedFormulaRecord.convertSharedFormulas(Stack, int, int) Note - two extra parameters (rowIx & colIx) will be required. They probably come from one of the Region objects.

Parameters

formula:String: The formula to parse, excluding the leading equals sign.
sheet:HSSFSheet: The sheet that the formula is on.

Returns:Ptg[]

null if formula was null.

readFormatOptions	back to summary
protected int readFormatOptions(RecordInputStream in)

serializeFormattingBlock	back to summary
protected void serializeFormattingBlock(LittleEndianOutput out)

setAlignFormattingUnchanged	back to summary
public void setAlignFormattingUnchanged()

setBorderFormatting	back to summary
public void setBorderFormatting(BorderFormatting borderFormatting)

setBottomBorderModified	back to summary
public void setBottomBorderModified(boolean modified)

setBottomLeftTopRightBorderModified	back to summary
public void setBottomLeftTopRightBorderModified(boolean modified)

setComparisonOperation	back to summary
public void setComparisonOperation(byte operation)

setConditionType	back to summary
protected void setConditionType(byte condition_type)

setFontFormatting	back to summary
public void setFontFormatting(FontFormatting fontFormatting)

setFormula1	back to summary
protected void setFormula1(Formula formula1)

setFormula2	back to summary
protected void setFormula2(Formula formula2)

setLeftBorderModified	back to summary
public void setLeftBorderModified(boolean modified)

setModified	back to summary
private void setModified(boolean modified, BitField field)

setOptionFlag	back to summary
private void setOptionFlag(boolean flag, BitField field)

setParsedExpression1	back to summary
public void setParsedExpression1(Ptg[] ptgs)

setParsedExpression2	back to summary
public void setParsedExpression2(Ptg[] ptgs)

setPatternBackgroundColorModified	back to summary
public void setPatternBackgroundColorModified(boolean modified)

setPatternColorModified	back to summary
public void setPatternColorModified(boolean modified)

setPatternFormatting	back to summary
public void setPatternFormatting(PatternFormatting patternFormatting)

setPatternStyleModified	back to summary
public void setPatternStyleModified(boolean modified)

setProtectionFormattingUnchanged	back to summary
public void setProtectionFormattingUnchanged()

setRightBorderModified	back to summary
public void setRightBorderModified(boolean modified)

setTopBorderModified	back to summary
public void setTopBorderModified(boolean modified)

setTopLeftBottomRightBorderModified	back to summary
public void setTopLeftBottomRightBorderModified(boolean modified)

org.apache.poi.hssf.record back to summary

public Interface CFRuleBase.ComparisonOperator

Field Summary

Modifier and Type	Field and Description
public static final byte	BETWEEN
public static final byte	EQUAL
public static final byte	GE
public static final byte	GT
public static final byte	LE
public static final byte	LT
public static final byte	max_operator
public static final byte	NO_COMPARISON
public static final byte	NOT_BETWEEN
public static final byte	NOT_EQUAL

Field Detail

BETWEEN	back to summary
public static final byte BETWEEN

EQUAL	back to summary
public static final byte EQUAL

GE	back to summary
public static final byte GE

GT	back to summary
public static final byte GT

LE	back to summary
public static final byte LE

LT	back to summary
public static final byte LT

max_operator	back to summary
public static final byte max_operator

NO_COMPARISON	back to summary
public static final byte NO_COMPARISON

NOT_BETWEEN	back to summary
public static final byte NOT_BETWEEN

NOT_EQUAL	back to summary
public static final byte NOT_EQUAL

public abstract Class CFRuleBase

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Interface CFRuleBase.ComparisonOperator

Field Summary

Field Detail