Package org.apache.poi.ss.format
Class CellFormatPart
java.lang.Object
org.apache.poi.ss.format.CellFormatPart
Objects of this class represent a single part of a cell format expression.
Each cell can have up to four of these for positive, zero, negative, and text
values.
Each format part can contain a color, a condition, and will always contain a format specification. For example "[Red][>=10]#" has a color ([Red]), a condition (>=10) and a format specification (#).
This class also contains patterns for matching the subparts of format specification. These are used internally, but are made public in case other code has use for them.
- Author:
- Ken Arnold, Industrious Media LLC
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final int
WithinFORMAT_PAT
, the group number for the matched color.static final Pattern
Pattern for the color part of a cell format part.static final int
WithinFORMAT_PAT
, the group number for the operator in the condition.static final Pattern
Pattern for the condition part of a cell format part.static final int
WithinFORMAT_PAT
, the group number for the value in the condition.static final Pattern
Pattern for the currency symbol part of a cell format partstatic final Pattern
Pattern for an entire cell single part.static final int
WithinFORMAT_PAT
, the group number for the format specification.static final Pattern
Pattern for the format specification part of a cell format part. -
Constructor Summary
ConstructorsConstructorDescriptionCellFormatPart
(String desc) Create an object to represent a format part.CellFormatPart
(Locale locale, String desc) Create an object to represent a format part. -
Method Summary
Modifier and TypeMethodDescriptionboolean
Returns true if this format part applies to the given value.Apply this format part to the given value.Apply this format part to the given value, applying the result to the given label.static String
Returns the string from the group, or "" if the group is null.static StringBuffer
parseFormat
(String fdesc, CellFormatType type, org.apache.poi.ss.format.CellFormatPart.PartHandler partHandler) toString()
-
Field Details
-
COLOR_PAT
Pattern for the color part of a cell format part. -
CONDITION_PAT
Pattern for the condition part of a cell format part. -
SPECIFICATION_PAT
Pattern for the format specification part of a cell format part. -
CURRENCY_PAT
Pattern for the currency symbol part of a cell format part -
FORMAT_PAT
Pattern for an entire cell single part. -
COLOR_GROUP
public static final int COLOR_GROUPWithinFORMAT_PAT
, the group number for the matched color. -
CONDITION_OPERATOR_GROUP
public static final int CONDITION_OPERATOR_GROUPWithinFORMAT_PAT
, the group number for the operator in the condition. -
CONDITION_VALUE_GROUP
public static final int CONDITION_VALUE_GROUPWithinFORMAT_PAT
, the group number for the value in the condition. -
SPECIFICATION_GROUP
public static final int SPECIFICATION_GROUPWithinFORMAT_PAT
, the group number for the format specification.
-
-
Constructor Details
-
CellFormatPart
Create an object to represent a format part.- Parameters:
desc
- The string to parse.
-
CellFormatPart
Create an object to represent a format part.- Parameters:
locale
- The locale to use.desc
- The string to parse.
-
-
Method Details
-
applies
Returns true if this format part applies to the given value. If the value is a number and this is part has a condition, returns true only if the number passes the condition. Otherwise, this always return true.- Parameters:
valueObject
- The value to evaluate.- Returns:
- true if this format part applies to the given value.
-
apply
Apply this format part to the given value. This returns aCellFormatResult
object with the results.- Parameters:
value
- The value to apply this format part to.- Returns:
- A
CellFormatResult
object containing the results of applying the format to the value.
-
apply
Apply this format part to the given value, applying the result to the given label.- Parameters:
label
- The labelvalue
- The value to apply this format part to.- Returns:
- true if the
-
parseFormat
public static StringBuffer parseFormat(String fdesc, CellFormatType type, org.apache.poi.ss.format.CellFormatPart.PartHandler partHandler) -
group
Returns the string from the group, or "" if the group is null.- Parameters:
m
- The matcher.g
- The group number.- Returns:
- The group or "".
-
toString
-