Package org.patternfly.style

Class Variable

java.lang.Object

org.patternfly.style.Variable

public class Variable
extends Object

Provides methods to build and apply PatternFly global and component variables.

See Also:

• https://www.patternfly.org/developer-resources/global-css-variables

Field Summary

Fields

Modifier and Type	Field	Description
final String	name
final VariableScope	scope

Method Summary

Modifier and Type	Method	Description
VariableAssignments.HTMLElement	applyTo(HTMLElement element)
<E extends HTMLElement, B extends TypedBuilder<E, B>> VariableAssignments.HTMLBuilder<E,B>	applyTo(HasHTMLElement<E,B> element)
<E extends SVGElement, B extends TypedBuilder<E, B>> VariableAssignments.SVGBuilder<E,B>	applyTo(HasSVGElement<E,B> element)
String	asVar()
static Variable	componentVar(String component, String... elements)	Constructs a component variable with the given component and elements.
static Variable	globalVar(String firstElement, String... otherElements)	Constructs a global variable with the given elements.
static Variable	utilVar(String firstElement, String... otherElements)	Constructs a utility variable with the given elements.

Methods inherited from class java.lang.Object

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

Field Details

scope

public final VariableScope scope

name

public final String name

Method Details

globalVar

public static Variable globalVar(String firstElement,
 String... otherElements)

Constructs a global variable with the given elements.

Parameters:

firstElement - the first element to include in the variable name

otherElements - additional elements to append to the variable name

Returns:

a new Variable object with the constructed variable name

utilVar

public static Variable utilVar(String firstElement,
 String... otherElements)

Constructs a utility variable with the given elements.

Parameters:

firstElement - the first element to include in the variable name

otherElements - additional elements to append to the variable name

Returns:

a new Variable object with the constructed variable name

componentVar

public static Variable componentVar(String component,
 String... elements)

Constructs a component variable with the given component and elements.

Parameters:

component - the fully qualified component name built with Classes.component(String, String...)

elements - optional elements to append to the component name

Returns:

a new Variable object

asVar

public String asVar()

applyTo

public <E extends HTMLElement,
B extends TypedBuilder<E,
B>>
VariableAssignments.HTMLBuilder<E,B> applyTo(HasHTMLElement<E,B> element)

applyTo

public <E extends SVGElement,
B extends TypedBuilder<E,
B>>
VariableAssignments.SVGBuilder<E,B> applyTo(HasSVGElement<E,B> element)

applyTo

public VariableAssignments.HTMLElement applyTo(HTMLElement element)