Package org.apache.poi.ss.usermodel
Interface IconMultiStateFormatting
- All Known Implementing Classes:
HSSFIconMultiStateFormatting
,XSSFIconMultiStateFormatting
public interface IconMultiStateFormatting
High level representation for the Icon / Multi-State Formatting
component of Conditional Formatting settings
-
Nested Class Summary
Nested Classes -
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
IconMultiStateFormatting.IconSet getIconSet()Get the Icon Set used -
setIconSet
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!
-
isIconOnly
boolean isIconOnly()Should Icon + Value be displayed, or only the Icon? -
setIconOnly
void setIconOnly(boolean only) Control if only the Icon is shown, or Icon + Value -
isReversed
boolean isReversed() -
setReversed
void setReversed(boolean reversed) -
getThresholds
ConditionalFormattingThreshold[] getThresholds()Gets the list of thresholds -
setThresholds
Sets the of thresholds. The number must matchIconMultiStateFormatting.IconSet.num
for the currentgetIconSet()
-
createThreshold
ConditionalFormattingThreshold createThreshold()Creates a new, empty Threshold
-