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
String	name
VariableScope	scope

Method Summary

Modifier and Type	Method	Description
void	applyTo(HTMLElement element, int value)
void	applyTo(HTMLElement element, String value)
<V> void	applyTo(HTMLElement element, Breakpoints<V> breakpoints)
<V> void	applyTo(HTMLElement element, Breakpoints<V> breakpoints, Function<V,String> stringValue)
<E extends HTMLElement,B extends TypedBuilder<E,B>> B	applyTo(HasHTMLElement<E,B> element, int value)
<E extends HTMLElement,B extends TypedBuilder<E,B>> B	applyTo(HasHTMLElement<E,B> element, String value)
<E extends HTMLElement,B extends TypedBuilder<E,B>,V> B	applyTo(HasHTMLElement<E,B> element, Breakpoints<V> breakpoints)
<E extends HTMLElement,B extends TypedBuilder<E,B>,V> B	applyTo(HasHTMLElement<E,B> element, Breakpoints<V> breakpoints, Function<V,String> stringValue)
<E extends SVGElement,B extends TypedBuilder<E,B>> B	applyTo(HasSVGElement<E,B> element, int value)
<E extends SVGElement,B extends TypedBuilder<E,B>> B	applyTo(HasSVGElement<E,B> element, String value)
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.

Methods inherited from class java.lang.Object

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

Field Detail

scope

public final VariableScope scope

name

public final String name

Method Detail

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

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

applyTo

public <E extends HTMLElement,B extends TypedBuilder<E,B>> B applyTo(HasHTMLElement<E,B> element,
                                                                                 int value)

applyTo

public <E extends HTMLElement,B extends TypedBuilder<E,B>> B applyTo(HasHTMLElement<E,B> element,
                                                                                 String value)

applyTo

public <E extends HTMLElement,B extends TypedBuilder<E,B>,V> B applyTo(HasHTMLElement<E,B> element,
                                                                                         Breakpoints<V> breakpoints)

applyTo

public <E extends HTMLElement,B extends TypedBuilder<E,B>,V> B applyTo(HasHTMLElement<E,B> element,
                                                                                         Breakpoints<V> breakpoints,
                                                                                         Function<V,String> stringValue)

applyTo

public <E extends SVGElement,B extends TypedBuilder<E,B>> B applyTo(HasSVGElement<E,B> element,
                                                                                int value)

applyTo

public <E extends SVGElement,B extends TypedBuilder<E,B>> B applyTo(HasSVGElement<E,B> element,
                                                                                String value)

applyTo

public void applyTo(HTMLElement element,
                    int value)

applyTo

public void applyTo(HTMLElement element,
                    String value)

applyTo

public <V> void applyTo(HTMLElement element,
                        Breakpoints<V> breakpoints)

applyTo

public <V> void applyTo(HTMLElement element,
                        Breakpoints<V> breakpoints,
                        Function<V,String> stringValue)