Top Description Fields Constructors Methods
org.apache.poi.hssf.usermodel

public final Class HSSFIconMultiStateFormatting

extends Object
implements IconMultiStateFormatting
Class Inheritance
All Implemented Interfaces
org.apache.poi.ss.usermodel.IconMultiStateFormatting
Imports
org.apache.poi.hssf.record.CFRule12Record, org.apache.poi.hssf.record.cf.IconMultiStateFormatting, .IconMultiStateThreshold, .Threshold, org.apache.poi.ss.usermodel.ConditionalFormattingThreshold
High level representation for Icon / Multi-State Formatting component of Conditional Formatting settings

Field Summary

Modifier and TypeField and Description
private final IconMultiStateFormatting
iconFormatting

private final HSSFSheet
sheet

Constructor Summary

AccessConstructor and Description
pack-priv
HSSFIconMultiStateFormatting(CFRule12Record cfRule12Record, HSSFSheet sheet)

Method Summary

Modifier and TypeMethod and Description
public HSSFConditionalFormattingThreshold
createThreshold()

Implements org.apache.poi.ss.usermodel.IconMultiStateFormatting.createThreshold.

Creates a new, empty Threshold

public IconMultiStateFormatting.IconSet
getIconSet()

Implements org.apache.poi.ss.usermodel.IconMultiStateFormatting.getIconSet.

Get the Icon Set used

public HSSFConditionalFormattingThreshold[]
getThresholds()

Implements org.apache.poi.ss.usermodel.IconMultiStateFormatting.getThresholds.

Gets the list of thresholds

public boolean
isIconOnly()

Implements org.apache.poi.ss.usermodel.IconMultiStateFormatting.isIconOnly.

Should Icon + Value be displayed, or only the Icon?

public boolean
isReversed()

Implements org.apache.poi.ss.usermodel.IconMultiStateFormatting.isReversed.

public void
setIconOnly(boolean only)

Implements org.apache.poi.ss.usermodel.IconMultiStateFormatting.setIconOnly.

Control if only the Icon is shown, or Icon + Value

public void
setIconSet(IconMultiStateFormatting.IconSet set)

Implements org.apache.poi.ss.usermodel.IconMultiStateFormatting.setIconSet.

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)

Implements org.apache.poi.ss.usermodel.IconMultiStateFormatting.setReversed.

public void
setThresholds(ConditionalFormattingThreshold[] thresholds)

Implements org.apache.poi.ss.usermodel.IconMultiStateFormatting.setThresholds.

Sets the of thresholds.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

iconFormattingback to summary
private final IconMultiStateFormatting iconFormatting
sheetback to summary
private final HSSFSheet sheet

Constructor Detail

HSSFIconMultiStateFormattingback to summary
pack-priv HSSFIconMultiStateFormatting(CFRule12Record cfRule12Record, HSSFSheet sheet)

Method Detail

createThresholdback to summary
public HSSFConditionalFormattingThreshold createThreshold()

Implements org.apache.poi.ss.usermodel.IconMultiStateFormatting.createThreshold.

Doc from org.apache.poi.ss.usermodel.IconMultiStateFormatting.createThreshold.

Creates a new, empty Threshold

Annotations
@Override
getIconSetback to summary
public IconMultiStateFormatting.IconSet getIconSet()

Implements org.apache.poi.ss.usermodel.IconMultiStateFormatting.getIconSet.

Doc from org.apache.poi.ss.usermodel.IconMultiStateFormatting.getIconSet.

Get the Icon Set used

Annotations
@Override
getThresholdsback to summary
public HSSFConditionalFormattingThreshold[] getThresholds()

Implements org.apache.poi.ss.usermodel.IconMultiStateFormatting.getThresholds.

Doc from org.apache.poi.ss.usermodel.IconMultiStateFormatting.getThresholds.

Gets the list of thresholds

Annotations
@Override
isIconOnlyback to summary
public boolean isIconOnly()

Implements org.apache.poi.ss.usermodel.IconMultiStateFormatting.isIconOnly.

Doc from org.apache.poi.ss.usermodel.IconMultiStateFormatting.isIconOnly.

Should Icon + Value be displayed, or only the Icon?

Annotations
@Override
isReversedback to summary
public boolean isReversed()

Implements org.apache.poi.ss.usermodel.IconMultiStateFormatting.isReversed.

Annotations
@Override
setIconOnlyback to summary
public void setIconOnly(boolean only)

Implements org.apache.poi.ss.usermodel.IconMultiStateFormatting.setIconOnly.

Doc from org.apache.poi.ss.usermodel.IconMultiStateFormatting.setIconOnly.

Control if only the Icon is shown, or Icon + Value

Annotations
@Override
setIconSetback to summary
public void setIconSet(IconMultiStateFormatting.IconSet set)

Implements org.apache.poi.ss.usermodel.IconMultiStateFormatting.setIconSet.

Doc from org.apache.poi.ss.usermodel.IconMultiStateFormatting.setIconSet.

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!

Annotations
@Override
setReversedback to summary
public void setReversed(boolean reversed)

Implements org.apache.poi.ss.usermodel.IconMultiStateFormatting.setReversed.

Annotations
@Override
setThresholdsback to summary
public void setThresholds(ConditionalFormattingThreshold[] thresholds)

Implements org.apache.poi.ss.usermodel.IconMultiStateFormatting.setThresholds.

Doc from org.apache.poi.ss.usermodel.IconMultiStateFormatting.setThresholds.

Sets the of thresholds. The number must match IconSet#num for the current getIconSet()

Annotations
@Override