public final class IconSetCondition extends FormatCondition
Modifier and Type | Method and Description |
---|---|
FormatConditionType |
getConditionType()
Gets the
FormatConditionType.ICON_SET value. |
ConditionalIconCollection |
getIcons()
Gets the icons.
|
SpreadsheetIconStyle |
getIconStyle()
Gets the icon style for all icons contained in the
icons collection. |
boolean |
isReverseIconOrder()
Gets a value indicating whether the order of icons should be reversed.
|
boolean |
isShowIconOnly()
Gets a value indicating whether to show icon only.
|
void |
setIconStyle(SpreadsheetIconStyle iconStyle)
Sets the icon style for all icons contained in the
icons collection. |
void |
setReverseIconOrder(boolean reverseIconOrder)
Sets a value indicating whether the order of icons should be reversed.
|
void |
setShowIconOnly(boolean showIconOnly)
Sets a value indicating whether to show icon only.
|
String |
toString()
Returns a
String that represents this IconSetCondition instance. |
getRule
public FormatConditionType getConditionType()
FormatConditionType.ICON_SET
value.getConditionType
in class FormatCondition
FormatConditionType.ICON_SET
value.public ConditionalIconCollection getIcons()
public SpreadsheetIconStyle getIconStyle()
Gets the icon style for all icons contained in the icons
collection.
If icons are of different SpreadsheetIconStyle
or are not ordered, then SpreadsheetIconStyle.CUSTOM
is returned.
icons
collection.public boolean isReverseIconOrder()
Gets a value indicating whether the order of icons should be reversed.
Default value is false
.
true
if the order of icons should be reversed; otherwise, false
.public boolean isShowIconOnly()
Gets a value indicating whether to show icon only.
Default value is false
(cell value is shown together with icon).
true
to show icon only; otherwise, false
.public void setIconStyle(SpreadsheetIconStyle iconStyle)
Sets the icon style for all icons contained in the icons
collection.
iconStyle
- The icon style for all icons contained in the icons
collection.IllegalArgumentException
- Icon style is set to SpreadsheetIconStyle.NONE
or SpreadsheetIconStyle.CUSTOM
.public void setReverseIconOrder(boolean reverseIconOrder)
Sets a value indicating whether the order of icons should be reversed.
Default value is false
.
reverseIconOrder
- true
if the order of icons should be reversed; otherwise, false
.public void setShowIconOnly(boolean showIconOnly)
Sets a value indicating whether to show icon only.
Default value is false
(cell value is shown together with icon).
showIconOnly
- true
to show icon only; otherwise, false
.public String toString()
String
that represents this IconSetCondition
instance.
This method should be used primarily for debugging purposes and should be considered volatile (format of its return value might change in future versions).
toString
in class FormatCondition
String
that represents this IconSetCondition
instance.© GemBox Ltd. — All rights reserved.