public final class CFRule12Record extends CFRuleBase implements FutureRecord
This is for newer-style Excel conditional formattings, from Excel 2007 onwards.
CFRuleRecord
is used where the condition type is
CFRuleBase.CONDITION_TYPE_CELL_VALUE_IS
or CFRuleBase.CONDITION_TYPE_FORMULA
,
this is only used for the other types
CFRuleBase.ComparisonOperator
Modifier and Type | Field and Description |
---|---|
static short |
sid |
_borderFormatting, _fontFormatting, _patternFormatting, CONDITION_TYPE_CELL_VALUE_IS, CONDITION_TYPE_COLOR_SCALE, CONDITION_TYPE_DATA_BAR, CONDITION_TYPE_FILTER, CONDITION_TYPE_FORMULA, CONDITION_TYPE_ICON_SET, formatting_not_used, formatting_options, logger, TEMPLATE_ABOVE_AVERAGE, TEMPLATE_ABOVE_OR_EQUAL_TO_AVERAGE, TEMPLATE_BELOW_AVERAGE, TEMPLATE_BELOW_OR_EQUAL_TO_AVERAGE, TEMPLATE_CELL_VALUE, TEMPLATE_COLOR_SCALE_FORMATTING, TEMPLATE_CONTAINS_BLANKS, TEMPLATE_CONTAINS_ERRORS, TEMPLATE_CONTAINS_NO_BLANKS, TEMPLATE_CONTAINS_NO_ERRORS, TEMPLATE_CONTAINS_TEXT, TEMPLATE_DATA_BAR_FORMATTING, TEMPLATE_DUPLICATE_VALUES, TEMPLATE_FILTER, TEMPLATE_FORMULA, TEMPLATE_ICON_SET_FORMATTING, TEMPLATE_LAST_7_DAYS, TEMPLATE_LAST_MONTH, TEMPLATE_LAST_WEEK, TEMPLATE_NEXT_MONTH, TEMPLATE_NEXT_WEEK, TEMPLATE_THIS_MONTH, TEMPLATE_THIS_WEEK, TEMPLATE_TODAY, TEMPLATE_TOMORROW, TEMPLATE_UNIQUE_VALUES, TEMPLATE_YESTERDAY
Constructor and Description |
---|
CFRule12Record(CFRule12Record other) |
CFRule12Record(RecordInputStream in) |
Modifier and Type | Method and Description |
---|---|
boolean |
containsColorGradientBlock() |
boolean |
containsDataBarBlock() |
boolean |
containsMultiStateBlock() |
CFRule12Record |
copy() |
static CFRule12Record |
create(HSSFSheet sheet,
byte comparisonOperation,
java.lang.String formulaText1,
java.lang.String formulaText2)
Creates a new comparison operation rule
|
static CFRule12Record |
create(HSSFSheet sheet,
byte comparisonOperation,
java.lang.String formulaText1,
java.lang.String formulaText2,
java.lang.String formulaTextScale)
Creates a new comparison operation rule
|
static CFRule12Record |
create(HSSFSheet sheet,
ExtendedColor color)
Creates a new Data Bar formatting
|
static CFRule12Record |
create(HSSFSheet sheet,
IconMultiStateFormatting.IconSet iconSet)
Creates a new Icon Set / Multi-State formatting
|
static CFRule12Record |
create(HSSFSheet sheet,
java.lang.String formulaText)
Creates a new comparison operation rule
|
ColorGradientFormatting |
createColorGradientFormatting() |
static CFRule12Record |
createColorScale(HSSFSheet sheet)
Creates a new Color Scale / Color Gradient formatting
|
DataBarFormatting |
createDataBarFormatting() |
IconMultiStateFormatting |
createMultiStateFormatting() |
CellRangeAddress |
getAssociatedRange() |
ColorGradientFormatting |
getColorGradientFormatting() |
DataBarFormatting |
getDataBarFormatting() |
protected int |
getDataSize() |
FtrHeader |
getFutureHeader() |
short |
getFutureRecordType() |
java.util.Map<java.lang.String,java.util.function.Supplier<?>> |
getGenericProperties() |
HSSFRecordTypes |
getGenericRecordType() |
IconMultiStateFormatting |
getMultiStateFormatting() |
Ptg[] |
getParsedExpressionScale()
get the stack of the scale expression as a list
|
int |
getPriority() |
short |
getSid()
return the non static version of the id for this record.
|
void |
serialize(LittleEndianOutput out)
called by the class that is responsible for writing this sucker.
|
void |
setParsedExpressionScale(Ptg[] ptgs) |
void |
setPriority(int priority) |
containsAlignFormattingBlock, containsBorderFormattingBlock, containsFontFormattingBlock, containsPatternFormattingBlock, containsProtectionFormattingBlock, getBorderFormatting, getComparisonOperation, getConditionType, getFontFormatting, getFormattingBlockSize, getFormula1, getFormula2, getFormulaSize, getOptions, getParsedExpression1, getParsedExpression2, getPatternFormatting, isBottomBorderModified, isBottomLeftTopRightBorderModified, isLeftBorderModified, isPatternBackgroundColorModified, isPatternColorModified, isPatternStyleModified, isRightBorderModified, isTopBorderModified, isTopLeftBottomRightBorderModified, parseFormula, readFormatOptions, serializeFormattingBlock, setAlignFormattingUnchanged, setBorderFormatting, setBottomBorderModified, setBottomLeftTopRightBorderModified, setComparisonOperation, setConditionType, setFontFormatting, setFormula1, setFormula2, setLeftBorderModified, setParsedExpression1, setParsedExpression2, setPatternBackgroundColorModified, setPatternColorModified, setPatternFormatting, setPatternStyleModified, setProtectionFormattingUnchanged, setRightBorderModified, setTopBorderModified, setTopLeftBottomRightBorderModified
getRecordSize, serialize
cloneViaReserialise, serialize, toString
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
getGenericChildren
public static final short sid
public CFRule12Record(CFRule12Record other)
public CFRule12Record(RecordInputStream in)
public static CFRule12Record create(HSSFSheet sheet, java.lang.String formulaText)
sheet
- the sheetformulaText
- the first formula textpublic static CFRule12Record create(HSSFSheet sheet, byte comparisonOperation, java.lang.String formulaText1, java.lang.String formulaText2)
sheet
- the sheetcomparisonOperation
- the comparison operationformulaText1
- the first formula textformulaText2
- the second formula textpublic static CFRule12Record create(HSSFSheet sheet, byte comparisonOperation, java.lang.String formulaText1, java.lang.String formulaText2, java.lang.String formulaTextScale)
sheet
- the sheetcomparisonOperation
- the comparison operationformulaText1
- the first formula textformulaText2
- the second formula textformulaTextScale
- the scale to apply for the comparisonpublic static CFRule12Record create(HSSFSheet sheet, ExtendedColor color)
sheet
- the sheetcolor
- the data bar colorpublic static CFRule12Record create(HSSFSheet sheet, IconMultiStateFormatting.IconSet iconSet)
sheet
- the sheeticonSet
- the icon setpublic static CFRule12Record createColorScale(HSSFSheet sheet)
sheet
- the sheetpublic boolean containsDataBarBlock()
public DataBarFormatting getDataBarFormatting()
public DataBarFormatting createDataBarFormatting()
public boolean containsMultiStateBlock()
public IconMultiStateFormatting getMultiStateFormatting()
public IconMultiStateFormatting createMultiStateFormatting()
public boolean containsColorGradientBlock()
public ColorGradientFormatting getColorGradientFormatting()
public ColorGradientFormatting createColorGradientFormatting()
public Ptg[] getParsedExpressionScale()
public void setParsedExpressionScale(Ptg[] ptgs)
public int getPriority()
public void setPriority(int priority)
public short getSid()
Record
public void serialize(LittleEndianOutput out)
serialize
in class StandardRecord
out
- the stream to write toprotected int getDataSize()
getDataSize
in class StandardRecord
public CFRule12Record copy()
copy
in interface Duplicatable
copy
in class CFRuleBase
public short getFutureRecordType()
getFutureRecordType
in interface FutureRecord
public FtrHeader getFutureHeader()
getFutureHeader
in interface FutureRecord
public CellRangeAddress getAssociatedRange()
getAssociatedRange
in interface FutureRecord
public HSSFRecordTypes getGenericRecordType()
getGenericRecordType
in interface GenericRecord
getGenericRecordType
in class Record
public java.util.Map<java.lang.String,java.util.function.Supplier<?>> getGenericProperties()
getGenericProperties
in interface GenericRecord
getGenericProperties
in class CFRuleBase
Copyright 2021 The Apache Software Foundation or its licensors, as applicable.