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

public final Class HSSFDataBarFormatting

extends Object
implements DataBarFormatting
Class Inheritance
All Implemented Interfaces
org.apache.poi.ss.usermodel.DataBarFormatting
Imports
org.apache.poi.hssf.record.CFRule12Record, org.apache.poi.hssf.record.cf.DataBarFormatting, .DataBarThreshold, org.apache.poi.ss.usermodel.Color
High level representation for DataBar / Data-Bar Formatting component of Conditional Formatting settings

Field Summary

Modifier and TypeField and Description
private final CFRule12Record
cfRule12Record

private final DataBarFormatting
databarFormatting

private final HSSFSheet
sheet

Constructor Summary

AccessConstructor and Description
protected
HSSFDataBarFormatting(CFRule12Record cfRule12Record, HSSFSheet sheet)

Method Summary

Modifier and TypeMethod and Description
public HSSFConditionalFormattingThreshold
createThreshold()

public HSSFExtendedColor
getColor()

Implements org.apache.poi.ss.usermodel.DataBarFormatting.getColor.

public HSSFConditionalFormattingThreshold
getMaxThreshold()

Implements org.apache.poi.ss.usermodel.DataBarFormatting.getMaxThreshold.

The threshold that defines "everything from here up is maximum"

public HSSFConditionalFormattingThreshold
getMinThreshold()

Implements org.apache.poi.ss.usermodel.DataBarFormatting.getMinThreshold.

The threshold that defines "everything from here down is minimum"

public int
getWidthMax()

Implements org.apache.poi.ss.usermodel.DataBarFormatting.getWidthMax.

How much of the cell width, in %, should be given to the max value?

public int
getWidthMin()

Implements org.apache.poi.ss.usermodel.DataBarFormatting.getWidthMin.

How much of the cell width, in %, should be given to the min value?

public boolean
isIconOnly()

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

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

public boolean
isLeftToRight()

Implements org.apache.poi.ss.usermodel.DataBarFormatting.isLeftToRight.

Is the bar drawn from Left-to-Right, or from Right-to-Left

public void
setColor(Color color)

Implements org.apache.poi.ss.usermodel.DataBarFormatting.setColor.

public void
setIconOnly(boolean only)

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

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

public void
setLeftToRight(boolean ltr)

Implements org.apache.poi.ss.usermodel.DataBarFormatting.setLeftToRight.

Control if the bar is drawn from Left-to-Right, or from Right-to-Left

public void
setWidthMax(int width)

Implements org.apache.poi.ss.usermodel.DataBarFormatting.setWidthMax.

public void
setWidthMin(int width)

Implements org.apache.poi.ss.usermodel.DataBarFormatting.setWidthMin.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

cfRule12Recordback to summary
private final CFRule12Record cfRule12Record
databarFormattingback to summary
private final DataBarFormatting databarFormatting
sheetback to summary
private final HSSFSheet sheet

Constructor Detail

HSSFDataBarFormattingback to summary
protected HSSFDataBarFormatting(CFRule12Record cfRule12Record, HSSFSheet sheet)

Method Detail

createThresholdback to summary
public HSSFConditionalFormattingThreshold createThreshold()
getColorback to summary
public HSSFExtendedColor getColor()

Implements org.apache.poi.ss.usermodel.DataBarFormatting.getColor.

getMaxThresholdback to summary
public HSSFConditionalFormattingThreshold getMaxThreshold()

Implements org.apache.poi.ss.usermodel.DataBarFormatting.getMaxThreshold.

Doc from org.apache.poi.ss.usermodel.DataBarFormatting.getMaxThreshold.

The threshold that defines "everything from here up is maximum"

getMinThresholdback to summary
public HSSFConditionalFormattingThreshold getMinThreshold()

Implements org.apache.poi.ss.usermodel.DataBarFormatting.getMinThreshold.

Doc from org.apache.poi.ss.usermodel.DataBarFormatting.getMinThreshold.

The threshold that defines "everything from here down is minimum"

getWidthMaxback to summary
public int getWidthMax()

Implements org.apache.poi.ss.usermodel.DataBarFormatting.getWidthMax.

Doc from org.apache.poi.ss.usermodel.DataBarFormatting.getWidthMax.

How much of the cell width, in %, should be given to the max value?

getWidthMinback to summary
public int getWidthMin()

Implements org.apache.poi.ss.usermodel.DataBarFormatting.getWidthMin.

Doc from org.apache.poi.ss.usermodel.DataBarFormatting.getWidthMin.

How much of the cell width, in %, should be given to the min value?

isIconOnlyback to summary
public boolean isIconOnly()

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

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

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

isLeftToRightback to summary
public boolean isLeftToRight()

Implements org.apache.poi.ss.usermodel.DataBarFormatting.isLeftToRight.

Doc from org.apache.poi.ss.usermodel.DataBarFormatting.isLeftToRight.

Is the bar drawn from Left-to-Right, or from Right-to-Left

setColorback to summary
public void setColor(Color color)

Implements org.apache.poi.ss.usermodel.DataBarFormatting.setColor.

setIconOnlyback to summary
public void setIconOnly(boolean only)

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

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

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

setLeftToRightback to summary
public void setLeftToRight(boolean ltr)

Implements org.apache.poi.ss.usermodel.DataBarFormatting.setLeftToRight.

Doc from org.apache.poi.ss.usermodel.DataBarFormatting.setLeftToRight.

Control if the bar is drawn from Left-to-Right, or from Right-to-Left

setWidthMaxback to summary
public void setWidthMax(int width)

Implements org.apache.poi.ss.usermodel.DataBarFormatting.setWidthMax.

setWidthMinback to summary
public void setWidthMin(int width)

Implements org.apache.poi.ss.usermodel.DataBarFormatting.setWidthMin.