Package org.apache.poi.xssf.usermodel
Class XSSFIconMultiStateFormatting
java.lang.Object
org.apache.poi.xssf.usermodel.XSSFIconMultiStateFormatting
- All Implemented Interfaces:
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
Modifier and TypeMethodDescriptionCreates a new, empty ThresholdGet the Icon Set usedGets the list of thresholdsboolean
Should Icon + Value be displayed, or only the Icon?boolean
void
setIconOnly
(boolean only) Control if only the Icon is shown, or Icon + Valuevoid
Changes the Icon Set usedvoid
setReversed
(boolean reversed) void
setThresholds
(ConditionalFormattingThreshold[] thresholds) Sets the of thresholds.
-
Method Details
-
getIconSet
Description copied from interface:IconMultiStateFormatting
Get the Icon Set used- Specified by:
getIconSet
in interfaceIconMultiStateFormatting
-
setIconSet
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
Description copied from interface:IconMultiStateFormatting
Gets the list of thresholds- Specified by:
getThresholds
in interfaceIconMultiStateFormatting
-
setThresholds
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
Description copied from interface:IconMultiStateFormatting
Creates a new, empty Threshold- Specified by:
createThreshold
in interfaceIconMultiStateFormatting
-