Top Description Fields Constructors Methods

org.apache.poi.ss.format

public Class CellFormatResult

Class Inheritance

extends Object

java.lang.Object
org.apache.poi.ss.format.CellFormatResult

Imports

This object contains the result of applying a cell format or cell format part to a value.

See Also: CellFormatPart#apply(Object), CellFormat#apply(Object)

Field Summary

Modifier and Type	Field and Description
public final boolean	applies This is `true` if no condition was given that applied to the value, or if the condition is satisfied.
public final String	text The resulting text.
public final Color	textColor The color the format sets, or `null` if the format sets no color.

Constructor Summary

Access	Constructor and Description
public	CellFormatResult(boolean The value for `applies`. applies, String The value for `text`. text, Color The value for `textColor`. textColor) Creates a new format result object.

Method Summary

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

applies	back to summary
public final boolean applies This is `true` if no condition was given that applied to the value, or if the condition is satisfied. If a condition is relevant, and when applied the value fails the test, this is `false`.

text	back to summary
public final String text The resulting text. This will never be `null`.

textColor	back to summary
public final Color textColor The color the format sets, or `null` if the format sets no color. This will always be `null` if `applies` is `false`.

Constructor Detail

CellFormatResult back to summary

public CellFormatResult(boolean applies, String text, Color textColor) throws IllegalArgumentException

Creates a new format result object.

Parameters

applies:boolean: The value for applies.
text:String: The value for text.
textColor:Color: The value for textColor.