Top Description Fields Constructors Methods
org.apache.poi.hssf.record.cf

public final Class DataBarFormatting

extends Object
implements Duplicatable, GenericRecord
Class Inheritance
All Implemented Interfaces
org.apache.poi.common.usermodel.GenericRecord, org.apache.poi.common.Duplicatable
Static Imports
org.apache.logging.log4j.util.Unbox.box, org.apache.poi.util.GenericRecordUtil.getBitsAsString
Data Bar Conditional Formatting Rule Record.

Field Summary

Modifier and TypeField and Description
private ExtendedColor
color

private static final BitField
ICON_ONLY

private static final Logger
LOG

private byte
options

private byte
percentMax

private byte
percentMin

private static final BitField
REVERSED

private DataBarThreshold
thresholdMax

private DataBarThreshold
thresholdMin

Constructor Summary

AccessConstructor and Description
public
DataBarFormatting()

public
DataBarFormatting(DataBarFormatting other)

public
DataBarFormatting(LittleEndianInput in)

Method Summary

Modifier and TypeMethod and Description
public DataBarFormatting
copy()

Implements org.apache.poi.common.Duplicatable.copy.

public ExtendedColor
getColor()

public int
getDataLength()

public Map<String, Supplier<?>>
getGenericProperties()

Implements org.apache.poi.common.usermodel.GenericRecord.getGenericProperties.

private boolean
getOptionFlag(BitField field)

public byte
getPercentMax()

public byte
getPercentMin()

public DataBarThreshold
getThresholdMax()

public DataBarThreshold
getThresholdMin()

public boolean
isIconOnly()

public boolean
isReversed()

public void
serialize(LittleEndianOutput out)

public void
setColor(ExtendedColor color)

public void
setIconOnly(boolean only)

private void
setOptionFlag(boolean option, BitField field)

public void
setPercentMax(byte percentMax)

public void
setPercentMin(byte percentMin)

public void
setReversed(boolean rev)

public void
setThresholdMax(DataBarThreshold thresholdMax)

public void
setThresholdMin(DataBarThreshold thresholdMin)

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAllwaitwaitwait

Field Detail

colorback to summary
private ExtendedColor color
ICON_ONLYback to summary
private static final BitField ICON_ONLY
LOGback to summary
private static final Logger LOG
optionsback to summary
private byte options
percentMaxback to summary
private byte percentMax
percentMinback to summary
private byte percentMin
REVERSEDback to summary
private static final BitField REVERSED
thresholdMaxback to summary
private DataBarThreshold thresholdMax
thresholdMinback to summary
private DataBarThreshold thresholdMin

Constructor Detail

DataBarFormattingback to summary
public DataBarFormatting()
DataBarFormattingback to summary
public DataBarFormatting(DataBarFormatting other)
DataBarFormattingback to summary
public DataBarFormatting(LittleEndianInput in)

Method Detail

copyback to summary
public DataBarFormatting copy()

Implements org.apache.poi.common.Duplicatable.copy.

Returns:DataBarFormatting

Doc from org.apache.poi.common.Duplicatable.copy.

a deep copy of the implementing class / instance

getColorback to summary
public ExtendedColor getColor()
getDataLengthback to summary
public int getDataLength()
getGenericPropertiesback to summary
public Map<String, Supplier<?>> getGenericProperties()

Implements org.apache.poi.common.usermodel.GenericRecord.getGenericProperties.

Annotations
@Override
getOptionFlagback to summary
private boolean getOptionFlag(BitField field)
getPercentMaxback to summary
public byte getPercentMax()
getPercentMinback to summary
public byte getPercentMin()
getThresholdMaxback to summary
public DataBarThreshold getThresholdMax()
getThresholdMinback to summary
public DataBarThreshold getThresholdMin()
isIconOnlyback to summary
public boolean isIconOnly()
isReversedback to summary
public boolean isReversed()
serializeback to summary
public void serialize(LittleEndianOutput out)
setColorback to summary
public void setColor(ExtendedColor color)
setIconOnlyback to summary
public void setIconOnly(boolean only)
setOptionFlagback to summary
private void setOptionFlag(boolean option, BitField field)
setPercentMaxback to summary
public void setPercentMax(byte percentMax)
setPercentMinback to summary
public void setPercentMin(byte percentMin)
setReversedback to summary
public void setReversed(boolean rev)
setThresholdMaxback to summary
public void setThresholdMax(DataBarThreshold thresholdMax)
setThresholdMinback to summary
public void setThresholdMin(DataBarThreshold thresholdMin)
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object