Package org.apache.poi.xssf.usermodel
Class XSSFIconMultiStateFormatting
- java.lang.Object
-
- org.apache.poi.xssf.usermodel.XSSFIconMultiStateFormatting
-
- All Implemented Interfaces:
IconMultiStateFormatting
public class XSSFIconMultiStateFormatting extends java.lang.Object implements IconMultiStateFormatting
High level representation for Icon / Multi-State Formatting component of Conditional Formatting settings
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface org.apache.poi.ss.usermodel.IconMultiStateFormatting
IconMultiStateFormatting.IconSet
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description XSSFConditionalFormattingThreshold
createThreshold()
Creates a new, empty ThresholdIconMultiStateFormatting.IconSet
getIconSet()
Get the Icon Set usedXSSFConditionalFormattingThreshold[]
getThresholds()
Gets the list of thresholdsboolean
isIconOnly()
Should Icon + Value be displayed, or only the Icon?boolean
isReversed()
void
setIconOnly(boolean only)
Control if only the Icon is shown, or Icon + Valuevoid
setIconSet(IconMultiStateFormatting.IconSet set)
Changes the Icon Set usedvoid
setReversed(boolean reversed)
void
setThresholds(ConditionalFormattingThreshold[] thresholds)
Sets the of thresholds.
-
-
-
Method Detail
-
getIconSet
public IconMultiStateFormatting.IconSet getIconSet()
Description copied from interface:IconMultiStateFormatting
Get the Icon Set used- Specified by:
getIconSet
in interfaceIconMultiStateFormatting
-
setIconSet
public void setIconSet(IconMultiStateFormatting.IconSet set)
Description copied from interface:IconMultiStateFormatting
Changes the Icon Set usedIf the new Icon Set has a different number of icons to the old one, you must update the thresholds before saving!
- Specified by:
setIconSet
in interfaceIconMultiStateFormatting
-
isIconOnly
public boolean isIconOnly()
Description copied from interface:IconMultiStateFormatting
Should Icon + Value be displayed, or only the Icon?- Specified by:
isIconOnly
in interfaceIconMultiStateFormatting
-
setIconOnly
public void setIconOnly(boolean only)
Description copied from interface:IconMultiStateFormatting
Control if only the Icon is shown, or Icon + Value- Specified by:
setIconOnly
in interfaceIconMultiStateFormatting
-
isReversed
public boolean isReversed()
- Specified by:
isReversed
in interfaceIconMultiStateFormatting
-
setReversed
public void setReversed(boolean reversed)
- Specified by:
setReversed
in interfaceIconMultiStateFormatting
-
getThresholds
public XSSFConditionalFormattingThreshold[] getThresholds()
Description copied from interface:IconMultiStateFormatting
Gets the list of thresholds- Specified by:
getThresholds
in interfaceIconMultiStateFormatting
-
setThresholds
public void setThresholds(ConditionalFormattingThreshold[] thresholds)
Description copied from interface:IconMultiStateFormatting
Sets the of thresholds. The number must matchIconMultiStateFormatting.IconSet.num
for the currentIconMultiStateFormatting.getIconSet()
- Specified by:
setThresholds
in interfaceIconMultiStateFormatting
-
createThreshold
public XSSFConditionalFormattingThreshold createThreshold()
Description copied from interface:IconMultiStateFormatting
Creates a new, empty Threshold- Specified by:
createThreshold
in interfaceIconMultiStateFormatting
-
-