Modifier and Type	Class and Description
public static enum	IconMultiStateFormatting.IconSet

Modifier and Type	Method and Description
public ConditionalFormattingThreshold	createThreshold() Creates a new, empty Threshold
public IconMultiStateFormatting.IconSet	getIconSet() Get the Icon Set used
public ConditionalFormattingThreshold[]	getThresholds() Gets the list of thresholds
public boolean	isIconOnly() Should Icon + Value be displayed, or only the Icon?
public boolean	isReversed()
public void	setIconOnly(boolean only) Control if only the Icon is shown, or Icon + Value
public void	setIconSet(IconMultiStateFormatting.IconSet set) Changes the Icon Set used If the new Icon Set has a different number of icons to the old one, you must update the thresholds before saving!
public void	setReversed(boolean reversed)
public void	setThresholds(ConditionalFormattingThreshold[] thresholds) Sets the of thresholds.

createThreshold	back to summary
public ConditionalFormattingThreshold createThreshold() Creates a new, empty Threshold

getIconSet	back to summary
public IconMultiStateFormatting.IconSet getIconSet() Get the Icon Set used

getThresholds	back to summary
public ConditionalFormattingThreshold[] getThresholds() Gets the list of thresholds

isIconOnly	back to summary
public boolean isIconOnly() Should Icon + Value be displayed, or only the Icon?

isReversed	back to summary
public boolean isReversed()

setIconOnly	back to summary
public void setIconOnly(boolean only) Control if only the Icon is shown, or Icon + Value

setIconSet	back to summary
public void setIconSet(IconMultiStateFormatting.IconSet set) Changes the Icon Set used If the new Icon Set has a different number of icons to the old one, you must update the thresholds before saving!

setReversed	back to summary
public void setReversed(boolean reversed)

setThresholds	back to summary
public void setThresholds(ConditionalFormattingThreshold[] thresholds) Sets the of thresholds. The number must match `IconSet#num` for the current `getIconSet()`

org.apache.poi.ss.usermodel back to summary

public final Enum IconMultiStateFormatting.IconSet

Class Inheritance

extends Enum<IconMultiStateFormatting.IconSet>

java.lang.Object
java.lang.Enum
org.apache.poi.ss.usermodel.IconMultiStateFormatting.IconSet

Field Summary

Modifier and Type	Field and Description
public static final IconMultiStateFormatting.IconSet	GREY_3_ARROWS Grey Up / Side / Down arrows
public static final IconMultiStateFormatting.IconSet	GREY_4_ARROWS Grey Up / NE / SE / Down arrows
public static final IconMultiStateFormatting.IconSet	GREY_5_ARROWS
public static final IconMultiStateFormatting.IconSet	GYR_3_ARROW Green Up / Yellow Side / Red Down arrows
public static final IconMultiStateFormatting.IconSet	GYR_3_FLAGS Green / Yellow / Red flags
public static final IconMultiStateFormatting.IconSet	GYR_3_SHAPES Green Circle / Yellow Triangle / Red Diamond.
public static final IconMultiStateFormatting.IconSet	GYR_3_SYMBOLS Green Tick / Yellow !
public static final IconMultiStateFormatting.IconSet	GYR_3_SYMBOLS_CIRCLE Green Tick / Yellow !
public static final IconMultiStateFormatting.IconSet	GYR_3_TRAFFIC_LIGHTS Green / Yellow / Red traffic lights (no background).
public static final IconMultiStateFormatting.IconSet	GYR_3_TRAFFIC_LIGHTS_BOX Green / Yellow / Red traffic lights on a black square background.
public static final IconMultiStateFormatting.IconSet	GYR_4_ARROWS Green Up / Yellow NE / Yellow SE / Red Down arrows
public static final IconMultiStateFormatting.IconSet	GYRB_4_TRAFFIC_LIGHTS Green / Yellow / Red / Black traffic lights
public static final IconMultiStateFormatting.IconSet	GYYYR_5_ARROWS
public final int	id Numeric ID of the icon set
public final String	name Hides java.lang.Enum.name. Name (system) of the set
public final int	num How many icons in the set
public static final IconMultiStateFormatting.IconSet	QUARTERS_5
public static final IconMultiStateFormatting.IconSet	RATINGS_4
public static final IconMultiStateFormatting.IconSet	RATINGS_5
public static final IconMultiStateFormatting.IconSet	RB_4_TRAFFIC_LIGHTS Red / Light Red / Grey / Black traffic lights

Constructor Summary

Access	Constructor and Description
private	IconSet(int id, int num, String name)

Method Summary

Modifier and Type	Method and Description
public static IconMultiStateFormatting.IconSet	byId(int id)
public static IconMultiStateFormatting.IconSet	byName(String name)
public String	toString() Overrides java.lang.Enum.toString. Returns the name of this enum constant, as contained in the declaration.
public static IconMultiStateFormatting.IconSet	valueOf(String name)
public static IconMultiStateFormatting.IconSet[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal valueOf

Field Detail

GREY_3_ARROWS	back to summary
public static final IconMultiStateFormatting.IconSet GREY_3_ARROWS Grey Up / Side / Down arrows

GREY_4_ARROWS	back to summary
public static final IconMultiStateFormatting.IconSet GREY_4_ARROWS Grey Up / NE / SE / Down arrows

GREY_5_ARROWS	back to summary
public static final IconMultiStateFormatting.IconSet GREY_5_ARROWS

GYR_3_ARROW	back to summary
public static final IconMultiStateFormatting.IconSet GYR_3_ARROW Green Up / Yellow Side / Red Down arrows

GYR_3_FLAGS	back to summary
public static final IconMultiStateFormatting.IconSet GYR_3_FLAGS Green / Yellow / Red flags

GYR_3_SHAPES	back to summary
public static final IconMultiStateFormatting.IconSet GYR_3_SHAPES Green Circle / Yellow Triangle / Red Diamond. Note, MS-XLS docs v20141018 say this is id=4 but seems to be id=5

GYR_3_SYMBOLS	back to summary
public static final IconMultiStateFormatting.IconSet GYR_3_SYMBOLS Green Tick / Yellow ! / Red Cross (no background)

GYR_3_SYMBOLS_CIRCLE	back to summary
public static final IconMultiStateFormatting.IconSet GYR_3_SYMBOLS_CIRCLE Green Tick / Yellow ! / Red Cross on a circle background

GYR_3_TRAFFIC_LIGHTS	back to summary
public static final IconMultiStateFormatting.IconSet GYR_3_TRAFFIC_LIGHTS Green / Yellow / Red traffic lights (no background). Default

GYR_3_TRAFFIC_LIGHTS_BOX	back to summary
public static final IconMultiStateFormatting.IconSet GYR_3_TRAFFIC_LIGHTS_BOX Green / Yellow / Red traffic lights on a black square background. Note, MS-XLS docs v20141018 say this is id=5 but seems to be id=4

GYR_4_ARROWS	back to summary
public static final IconMultiStateFormatting.IconSet GYR_4_ARROWS Green Up / Yellow NE / Yellow SE / Red Down arrows

GYRB_4_TRAFFIC_LIGHTS	back to summary
public static final IconMultiStateFormatting.IconSet GYRB_4_TRAFFIC_LIGHTS Green / Yellow / Red / Black traffic lights

GYYYR_5_ARROWS	back to summary
public static final IconMultiStateFormatting.IconSet GYYYR_5_ARROWS

id	back to summary
public final int id Numeric ID of the icon set

name	back to summary
public final String name Hides java.lang.Enum.name. Name (system) of the set

name

back to summary

public final String name

Hides java.lang.Enum.name.

Name (system) of the set

num	back to summary
public final int num How many icons in the set

QUARTERS_5	back to summary
public static final IconMultiStateFormatting.IconSet QUARTERS_5

RATINGS_4	back to summary
public static final IconMultiStateFormatting.IconSet RATINGS_4

RATINGS_5	back to summary
public static final IconMultiStateFormatting.IconSet RATINGS_5

RB_4_TRAFFIC_LIGHTS	back to summary
public static final IconMultiStateFormatting.IconSet RB_4_TRAFFIC_LIGHTS Red / Light Red / Grey / Black traffic lights

Constructor Detail

IconSet	back to summary
private IconSet(int id, int num, String name)

Method Detail

byId	back to summary
public static IconMultiStateFormatting.IconSet byId(int id)

byName	back to summary
public static IconMultiStateFormatting.IconSet byName(String name)

toString	back to summary
public String toString() Overrides java.lang.Enum.toString. Doc from java.lang.Enum.toString. Returns the name of this enum constant, as contained in the declaration. This method may be overridden, though it typically isn't necessary or desirable. An enum class should override this method when a more "programmer-friendly" string form exists. Returns:String the name of this enum constant

toString

back to summary

public String toString()

Overrides java.lang.Enum.toString.

Doc from java.lang.Enum.toString.

Returns the name of this enum constant, as contained in the declaration. This method may be overridden, though it typically isn't necessary or desirable. An enum class should override this method when a more "programmer-friendly" string form exists.

Returns:String: the name of this enum constant

valueOf	back to summary
public static IconMultiStateFormatting.IconSet valueOf(String name)

values	back to summary
public static IconMultiStateFormatting.IconSet[] values()

public Interface IconMultiStateFormatting

Nested and Inner Type Summary

Method Summary

Method Detail

public final Enum IconMultiStateFormatting.IconSet

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail