Package io.keikai.axyra.sheets.content

Class ConditionalFormat.Builder

java.lang.Object

io.keikai.axyra.sheets.content.ConditionalFormat.Builder

Enclosing class:

ConditionalFormat

public static final class ConditionalFormat.Builder
extends Object

A fluent builder for a ConditionalFormat. The last rule-kind call wins; style calls accumulate.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ConditionalFormat.Builder	aboveAverage(boolean below, boolean includeEqual)	An above-average (or below-average when below) rule.
ConditionalFormat.Builder	aboveAverage(boolean below, boolean includeEqual, int stdDev)	An above/below-average rule restricted to a standard-deviation band: select cells stdDev standard deviations above (or below, when below) the mean (ECMA-376 §18.3.1.1 stdDev, values 1-3).
ConditionalFormat.Builder	axisColor(Color color)	Sets the data-bar axis color.
ConditionalFormat.Builder	axisPosition(String position)	Data-bar axis position: "automatic", "middle", or "none".
ConditionalFormat.Builder	barBorderColor(Color color)	Draws a data-bar border in color.
ConditionalFormat.Builder	barDirection(String direction)	Data-bar direction: "context", "leftToRight", or "rightToLeft".
ConditionalFormat.Builder	beginsWith(String text)	A "cell text begins with text" rule.
ConditionalFormat.Builder	between(String low, String high)	A cellIs rule that matches values from low to high, both included.
ConditionalFormat.Builder	bold()	Makes matching cells bold.
ConditionalFormat.Builder	border(BorderStyle style, Color color)	Draw the same border style and color on all four edges of matching cells — the differential <border> of the rule style.
ConditionalFormat.Builder	borderSide(String side, BorderStyle borderStyle, Color color)	Draw a border on one edge ("left", "right", "top", or "bottom") of matching cells.
ConditionalFormat	build()	The immutable rule.
ConditionalFormat.Builder	cellIs(String operator, String formula)	A cellIs rule, for example cellIs("greaterThan", "100").
ConditionalFormat.Builder	colorScale(Color... colors)	A 2- or 3-color scale rule (min → [mid] → max).
ConditionalFormat.Builder	containsBlanks()	Highlight blank cells (Excel's "contains blanks").
ConditionalFormat.Builder	containsErrors()	Highlight cells whose value is an error.
ConditionalFormat.Builder	containsText(String text)	A "cell text contains text" rule.
ConditionalFormat.Builder	dataBar(Color color)	A data-bar rule drawn in color.
ConditionalFormat.Builder	dateOccurring(TimePeriod period)	A "date occurring" rule: highlight cells whose date falls in the given window (ECMA-376 §18.18.82 ST_TimePeriod).
ConditionalFormat.Builder	duplicateValues()	Highlight duplicate values in the range.
ConditionalFormat.Builder	endsWith(String text)	A "cell text ends with text" rule.
ConditionalFormat.Builder	expression(String formula)	An expression rule (a boolean formula).
ConditionalFormat.Builder	fillColor(Color color)	Fills matching cells with a solid color.
ConditionalFormat.Builder	fontColor(Color color)	Sets the font color of matching cells.
ConditionalFormat.Builder	gradient(boolean gradient)	Solid (false) vs gradient (true) data-bar fill.
ConditionalFormat.Builder	iconSet(String name)	An icon-set rule, e.g.
ConditionalFormat.Builder	italic()	Italicize matching cells.
ConditionalFormat.Builder	negativeBorderColor(Color color)	Sets the border color of negative-value data bars.
ConditionalFormat.Builder	negativeFillColor(Color color)	Sets the fill color of negative-value data bars.
ConditionalFormat.Builder	notContainsBlanks()	Highlight non-blank cells.
ConditionalFormat.Builder	notContainsErrors()	Highlight cells whose value is not an error.
ConditionalFormat.Builder	notContainsText(String text)	A "cell text does not contain text" rule.
ConditionalFormat.Builder	numberFormat(String formatCode)	Apply a number format code (e.g.
ConditionalFormat.Builder	priority(int priority)	Sets the evaluation priority: 1 is evaluated first.
ConditionalFormat.Builder	reverse(boolean reversed)	Draw the icon set in reversed order.
ConditionalFormat.Builder	showValue(boolean show)	Show / hide the cell value beside a data bar or icon set.
ConditionalFormat.Builder	stopIfTrue()	Stop evaluating lower-priority rules once this one matches.
ConditionalFormat.Builder	strikethrough()	Strike through matching cells.
ConditionalFormat.Builder	top10(int rank, boolean bottom, boolean percent)	A top-N (or bottom-N when bottom) rule; percent ranks by %.
ConditionalFormat.Builder	underline()	Single-underline matching cells.
ConditionalFormat.Builder	uniqueValues()	Highlight values that occur exactly once in the range.
ConditionalFormat.Builder	valueObject(ConditionalFormat.ValueObject vo)	Append a threshold value object (ECMA-376 §18.3.1.11 cfvo) for a color-scale / data-bar / icon-set rule.
ConditionalFormat.Builder	valueObject(String type)	Append a valueless threshold ("min" / "max").
ConditionalFormat.Builder	valueObject(String type, String value)	Append a threshold with a number or formula value.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

cellIs

public ConditionalFormat.Builder cellIs(String operator,
 String formula)

A cellIs rule, for example cellIs("greaterThan", "100"). Operators: lessThan, lessThanOrEqual, equal, notEqual, greaterThanOrEqual, greaterThan, between, notBetween. An unknown operator is read as greaterThan. formula is a formula without a leading =; text needs quotes, as in "\"Done\"". For between, use between(String, String).

between

public ConditionalFormat.Builder between(String low,
 String high)

A cellIs rule that matches values from low to high, both included. Both are formulas without a leading =.

containsText

public ConditionalFormat.Builder containsText(String text)

A "cell text contains text" rule.

beginsWith

public ConditionalFormat.Builder beginsWith(String text)

A "cell text begins with text" rule.

endsWith

public ConditionalFormat.Builder endsWith(String text)

A "cell text ends with text" rule.

top10

public ConditionalFormat.Builder top10(int rank,
 boolean bottom,
 boolean percent)

A top-N (or bottom-N when bottom) rule; percent ranks by %.

aboveAverage

public ConditionalFormat.Builder aboveAverage(boolean below,
 boolean includeEqual)

An above-average (or below-average when below) rule.

aboveAverage

public ConditionalFormat.Builder aboveAverage(boolean below,
 boolean includeEqual,
 int stdDev)

An above/below-average rule restricted to a standard-deviation band: select cells stdDev standard deviations above (or below, when below) the mean (ECMA-376 §18.3.1.1 stdDev, values 1-3). includeEqual has no effect once a band is set — it is accepted for signature symmetry. A stdDev of 0 falls back to the plain above/below-average rule.

expression

public ConditionalFormat.Builder expression(String formula)

An expression rule (a boolean formula).

duplicateValues

public ConditionalFormat.Builder duplicateValues()

Highlight duplicate values in the range.

uniqueValues

public ConditionalFormat.Builder uniqueValues()

Highlight values that occur exactly once in the range.

containsBlanks

public ConditionalFormat.Builder containsBlanks()

Highlight blank cells (Excel's "contains blanks").

notContainsBlanks

public ConditionalFormat.Builder notContainsBlanks()

Highlight non-blank cells.

containsErrors

public ConditionalFormat.Builder containsErrors()

Highlight cells whose value is an error.

notContainsErrors

public ConditionalFormat.Builder notContainsErrors()

Highlight cells whose value is not an error.

notContainsText

public ConditionalFormat.Builder notContainsText(String text)

A "cell text does not contain text" rule. The match ignores case, like Excel's SEARCH. text must not be empty; an empty or null text makes Range.addConditionalFormat throw AxyraException.

dateOccurring

public ConditionalFormat.Builder dateOccurring(TimePeriod period)

A "date occurring" rule: highlight cells whose date falls in the given window (ECMA-376 §18.18.82 ST_TimePeriod).

colorScale

public ConditionalFormat.Builder colorScale(Color... colors)

A 2- or 3-color scale rule (min → [mid] → max). Pass two or three colors; the gradient interpolates the cell values across them. Only RGB colors are accepted.

Throws:

IllegalStateException - if a color is a theme, indexed or automatic color

NullPointerException - if a color is null

dataBar

public ConditionalFormat.Builder dataBar(Color color)

A data-bar rule drawn in color. Only RGB colors are accepted.

Throws:

IllegalStateException - if color is a theme, indexed or automatic color

NullPointerException - if color is null

iconSet

public ConditionalFormat.Builder iconSet(String name)

An icon-set rule, e.g. "3TrafficLights1", "3Arrows", "4Rating", "5Quarters". Default thresholds split the range into equal percent bands (Excel's UI defaults); override with valueObject(io.keikai.axyra.sheets.content.ConditionalFormat.ValueObject).

priority

public ConditionalFormat.Builder priority(int priority)

Sets the evaluation priority: 1 is evaluated first. A negative value makes Range.addConditionalFormat throw AxyraException.

stopIfTrue

public ConditionalFormat.Builder stopIfTrue()

Stop evaluating lower-priority rules once this one matches.

valueObject

public ConditionalFormat.Builder valueObject(ConditionalFormat.ValueObject vo)

Append a threshold value object (ECMA-376 §18.3.1.11 cfvo) for a color-scale / data-bar / icon-set rule. Order matters: a data bar takes min then max; a scale or icon set takes one per color / icon. When none are supplied, Excel-matching defaults are synthesized.

valueObject

public ConditionalFormat.Builder valueObject(String type)

Append a valueless threshold ("min" / "max").

valueObject

public ConditionalFormat.Builder valueObject(String type,
 String value)

Append a threshold with a number or formula value.

showValue

public ConditionalFormat.Builder showValue(boolean show)

Show / hide the cell value beside a data bar or icon set.

reverse

public ConditionalFormat.Builder reverse(boolean reversed)

Draw the icon set in reversed order.

gradient

public ConditionalFormat.Builder gradient(boolean gradient)

Solid (false) vs gradient (true) data-bar fill.

barBorderColor

public ConditionalFormat.Builder barBorderColor(Color color)

Draws a data-bar border in color. Only RGB colors are accepted.

Throws:

IllegalStateException - if color is a theme, indexed or automatic color

NullPointerException - if color is null

negativeFillColor

public ConditionalFormat.Builder negativeFillColor(Color color)

Sets the fill color of negative-value data bars. Only RGB colors are accepted.

Throws:

IllegalStateException - if color is a theme, indexed or automatic color

NullPointerException - if color is null

negativeBorderColor

public ConditionalFormat.Builder negativeBorderColor(Color color)

Sets the border color of negative-value data bars. Only RGB colors are accepted.

Throws:

IllegalStateException - if color is a theme, indexed or automatic color

NullPointerException - if color is null

axisColor

public ConditionalFormat.Builder axisColor(Color color)

Sets the data-bar axis color. Only RGB colors are accepted.

Throws:

IllegalStateException - if color is a theme, indexed or automatic color

NullPointerException - if color is null

axisPosition

public ConditionalFormat.Builder axisPosition(String position)

Data-bar axis position: "automatic", "middle", or "none".

barDirection

public ConditionalFormat.Builder barDirection(String direction)

Data-bar direction: "context", "leftToRight", or "rightToLeft".

fillColor

public ConditionalFormat.Builder fillColor(Color color)

Fills matching cells with a solid color. Only RGB colors are accepted.

Throws:

IllegalStateException - if color is a theme, indexed or automatic color

NullPointerException - if color is null

fontColor

public ConditionalFormat.Builder fontColor(Color color)

Sets the font color of matching cells. Only RGB colors are accepted.

Throws:

IllegalStateException - if color is a theme, indexed or automatic color

NullPointerException - if color is null

bold

public ConditionalFormat.Builder bold()

Makes matching cells bold.

italic

public ConditionalFormat.Builder italic()

Italicize matching cells.

strikethrough

public ConditionalFormat.Builder strikethrough()

Strike through matching cells.

underline

public ConditionalFormat.Builder underline()

Single-underline matching cells.

numberFormat

public ConditionalFormat.Builder numberFormat(String formatCode)

Apply a number format code (e.g. "0.00%", "#,##0") to matching cells — the differential <numFmt> of the rule style.

border

public ConditionalFormat.Builder border(BorderStyle style,
 Color color)

Draw the same border style and color on all four edges of matching cells — the differential <border> of the rule style. Only RGB colors are accepted; a null color leaves the edge color automatic.

Throws:

IllegalStateException - if color is a theme, indexed or automatic color

NullPointerException - if style is null

borderSide

public ConditionalFormat.Builder borderSide(String side,
 BorderStyle borderStyle,
 Color color)

Draw a border on one edge ("left", "right", "top", or "bottom") of matching cells. Only RGB colors are accepted; a null color leaves the edge color automatic.

Throws:

IllegalStateException - if color is a theme, indexed or automatic color

NullPointerException - if borderStyle is null

build

public ConditionalFormat build()

The immutable rule. Rule kinds and operators are checked only when the rule is added with Range.addConditionalFormat.