public class CellFormatPart
extends java.lang.Object
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.
Modifier and Type | Field and Description |
---|---|
static int |
COLOR_GROUP
Within
FORMAT_PAT , the group number for the matched color. |
static java.util.regex.Pattern |
COLOR_PAT
Pattern for the color part of a cell format part.
|
static int |
CONDITION_OPERATOR_GROUP
Within
FORMAT_PAT , the group number for the operator in the
condition. |
static java.util.regex.Pattern |
CONDITION_PAT
Pattern for the condition part of a cell format part.
|
static int |
CONDITION_VALUE_GROUP
Within
FORMAT_PAT , the group number for the value in the
condition. |
static java.util.regex.Pattern |
CURRENCY_PAT
Pattern for the currency symbol part of a cell format part
|
static java.util.regex.Pattern |
FORMAT_PAT
Pattern for an entire cell single part.
|
static int |
SPECIFICATION_GROUP
Within
FORMAT_PAT , the group number for the format
specification. |
static java.util.regex.Pattern |
SPECIFICATION_PAT
Pattern for the format specification part of a cell format part.
|
Constructor and Description |
---|
CellFormatPart(java.util.Locale locale,
java.lang.String desc)
Create an object to represent a format part.
|
CellFormatPart(java.lang.String desc)
Create an object to represent a format part.
|
Modifier and Type | Method and Description |
---|---|
boolean |
applies(java.lang.Object valueObject)
Returns true if this format part applies to the given value.
|
CellFormatResult |
apply(javax.swing.JLabel label,
java.lang.Object value)
Apply this format part to the given value, applying the result to the
given label.
|
CellFormatResult |
apply(java.lang.Object value)
Apply this format part to the given value.
|
static java.lang.String |
group(java.util.regex.Matcher m,
int g)
Returns the string from the group, or "" if the group is
null.
|
static java.lang.StringBuffer |
parseFormat(java.lang.String fdesc,
CellFormatType type,
org.apache.poi.ss.format.CellFormatPart.PartHandler partHandler) |
java.lang.String |
toString() |
public static final java.util.regex.Pattern COLOR_PAT
public static final java.util.regex.Pattern CONDITION_PAT
public static final java.util.regex.Pattern SPECIFICATION_PAT
public static final java.util.regex.Pattern CURRENCY_PAT
public static final java.util.regex.Pattern FORMAT_PAT
public static final int COLOR_GROUP
FORMAT_PAT
, the group number for the matched color.public static final int CONDITION_OPERATOR_GROUP
FORMAT_PAT
, the group number for the operator in the
condition.public static final int CONDITION_VALUE_GROUP
FORMAT_PAT
, the group number for the value in the
condition.public static final int SPECIFICATION_GROUP
FORMAT_PAT
, the group number for the format
specification.public CellFormatPart(java.lang.String desc)
desc
- The string to parse.public CellFormatPart(java.util.Locale locale, java.lang.String desc)
locale
- The locale to use.desc
- The string to parse.public boolean applies(java.lang.Object valueObject)
valueObject
- The value to evaluate.public CellFormatResult apply(java.lang.Object value)
CellFormatResult
object with the results.value
- The value to apply this format part to.CellFormatResult
object containing the results of
applying the format to the value.public CellFormatResult apply(javax.swing.JLabel label, java.lang.Object value)
label
- The labelvalue
- The value to apply this format part to.public static java.lang.StringBuffer parseFormat(java.lang.String fdesc, CellFormatType type, org.apache.poi.ss.format.CellFormatPart.PartHandler partHandler)
public static java.lang.String group(java.util.regex.Matcher m, int g)
m
- The matcher.g
- The group number.public java.lang.String toString()
toString
in class java.lang.Object
Copyright 2020 The Apache Software Foundation or its licensors, as applicable.