Module atlantafx.base

Package atlantafx.base.theme

Class Styles

java.lang.Object

atlantafx.base.theme.Styles

public final class Styles
extends Object

A set of constants and utility methods that simplifies adding CSS classes programmatically.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ACCENT
static final String	BG_ACCENT_EMPHASIS
static final String	BG_ACCENT_MUTED
static final String	BG_ACCENT_SUBTLE
static final String	BG_DANGER_EMPHASIS
static final String	BG_DANGER_MUTED
static final String	BG_DANGER_SUBTLE
static final String	BG_DEFAULT
static final String	BG_INSET
static final String	BG_NEUTRAL_EMPHASIS
static final String	BG_NEUTRAL_EMPHASIS_PLUS
static final String	BG_NEUTRAL_MUTED
static final String	BG_NEUTRAL_SUBTLE
static final String	BG_SUBTLE
static final String	BG_SUCCESS_EMPHASIS
static final String	BG_SUCCESS_MUTED
static final String	BG_SUCCESS_SUBTLE
static final String	BG_WARNING_EMPHASIS
static final String	BG_WARNING_MUTED
static final String	BG_WARNING_SUBTLE
static final String	BORDER_DEFAULT
static final String	BORDER_MUTED
static final String	BORDER_SUBTLE
static final String	BORDERED
static final String	BOTTOM
static final String	BUTTON_CIRCLE
static final String	BUTTON_ICON
static final String	BUTTON_OUTLINED
static final String	CENTER
static final String	CENTER_PILL
static final String	DANGER
static final String	DATA_URI_PREFIX
static final String	DENSE
static final String	ELEVATED_1
static final String	ELEVATED_2
static final String	ELEVATED_3
static final String	ELEVATED_4
static final String	FLAT
static final String	FONT_ICON
static final String	INTERACTIVE
static final String	LARGE
static final String	LEFT
static final String	LEFT_PILL
static final String	MEDIUM
static final String	RIGHT
static final String	RIGHT_PILL
static final String	ROUNDED
static final String	SMALL
static final javafx.css.PseudoClass	STATE_ACCENT
static final javafx.css.PseudoClass	STATE_DANGER
static final javafx.css.PseudoClass	STATE_INTERACTIVE
static final javafx.css.PseudoClass	STATE_SUCCESS
static final javafx.css.PseudoClass	STATE_WARNING
static final String	STRIPED
static final String	SUCCESS
static final String	TABS_BORDER_TOP
static final String	TABS_CLASSIC
static final String	TABS_FLOATING
static final String	TEXT
static final String	TEXT_BOLD
static final String	TEXT_BOLDER
static final String	TEXT_CAPTION
static final String	TEXT_ITALIC
static final String	TEXT_LIGHTER
static final String	TEXT_MUTED
static final String	TEXT_NORMAL
static final String	TEXT_OBLIQUE
static final String	TEXT_ON_EMPHASIS
static final String	TEXT_SMALL
static final String	TEXT_STRIKETHROUGH
static final String	TEXT_SUBTLE
static final String	TEXT_UNDERLINED
static final String	TITLE_1
static final String	TITLE_2
static final String	TITLE_3
static final String	TITLE_4
static final String	TOP
static final String	WARNING

Method Summary

Modifier and Type	Method	Description
static void	activatePseudoClass(javafx.scene.Node node, javafx.css.PseudoClass pseudoClass, javafx.css.PseudoClass... excludes)	Activates given pseudo-class to the node and deactivates the excluded pseudo-classes.
static void	addStyleClass(javafx.scene.Node node, String styleClass, String... excludes)	Adds the given style class to the node and removes the excluded classes.
static void	appendStyle(javafx.scene.Node node, String prop, String value)	Appends CSS style declaration to the specified node.
static void	removeStyle(javafx.scene.Node node, String prop)	Removes the specified CSS style declaration from the specified node.
static String	toDataURI(String css)	Converts a CSS string to the Base64-encoded data URI.
static void	toggleStyleClass(javafx.scene.Node node, String styleClass)	Adds the given style class to the node if it's not present, otherwise removes it.

Methods inherited from class java.lang.Object

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

Field Details

DATA_URI_PREFIX

public static final String DATA_URI_PREFIX

See Also:

• Constant Field Values

ACCENT

public static final String ACCENT

See Also:

• Constant Field Values

SUCCESS

public static final String SUCCESS

See Also:

• Constant Field Values

WARNING

public static final String WARNING

See Also:

• Constant Field Values

DANGER

public static final String DANGER

See Also:

• Constant Field Values

TEXT

public static final String TEXT

See Also:

• Constant Field Values

FONT_ICON

public static final String FONT_ICON

See Also:

• Constant Field Values

BUTTON_CIRCLE

public static final String BUTTON_CIRCLE

See Also:

• Constant Field Values

BUTTON_ICON

public static final String BUTTON_ICON

See Also:

• Constant Field Values

BUTTON_OUTLINED

public static final String BUTTON_OUTLINED

See Also:

• Constant Field Values

LEFT_PILL

public static final String LEFT_PILL

See Also:

• Constant Field Values

CENTER_PILL

public static final String CENTER_PILL

See Also:

• Constant Field Values

RIGHT_PILL

public static final String RIGHT_PILL

See Also:

• Constant Field Values

SMALL

public static final String SMALL

See Also:

• Constant Field Values

MEDIUM

public static final String MEDIUM

See Also:

• Constant Field Values

LARGE

public static final String LARGE

See Also:

• Constant Field Values

TOP

public static final String TOP

See Also:

• Constant Field Values

RIGHT

public static final String RIGHT

See Also:

• Constant Field Values

BOTTOM

public static final String BOTTOM

See Also:

• Constant Field Values

LEFT

public static final String LEFT

See Also:

• Constant Field Values

CENTER

public static final String CENTER

See Also:

• Constant Field Values

FLAT

public static final String FLAT

See Also:

• Constant Field Values

BORDERED

public static final String BORDERED

See Also:

• Constant Field Values

DENSE

public static final String DENSE

See Also:

• Constant Field Values

ELEVATED_1

public static final String ELEVATED_1

See Also:

• Constant Field Values

ELEVATED_2

public static final String ELEVATED_2

See Also:

• Constant Field Values

ELEVATED_3

public static final String ELEVATED_3

See Also:

• Constant Field Values

ELEVATED_4

public static final String ELEVATED_4

See Also:

• Constant Field Values

INTERACTIVE

public static final String INTERACTIVE

See Also:

• Constant Field Values

ROUNDED

public static final String ROUNDED

See Also:

• Constant Field Values

STRIPED

public static final String STRIPED

See Also:

• Constant Field Values

TABS_BORDER_TOP

public static final String TABS_BORDER_TOP

See Also:

• Constant Field Values

TABS_CLASSIC

public static final String TABS_CLASSIC

See Also:

• Constant Field Values

TABS_FLOATING

public static final String TABS_FLOATING

See Also:

• Constant Field Values

TITLE_1

public static final String TITLE_1

See Also:

• Constant Field Values

TITLE_2

public static final String TITLE_2

See Also:

• Constant Field Values

TITLE_3

public static final String TITLE_3

See Also:

• Constant Field Values

TITLE_4

public static final String TITLE_4

See Also:

• Constant Field Values

TEXT_CAPTION

public static final String TEXT_CAPTION

See Also:

• Constant Field Values

TEXT_SMALL

public static final String TEXT_SMALL

See Also:

• Constant Field Values

TEXT_BOLD

public static final String TEXT_BOLD

See Also:

• Constant Field Values

TEXT_BOLDER

public static final String TEXT_BOLDER

See Also:

• Constant Field Values

TEXT_NORMAL

public static final String TEXT_NORMAL

See Also:

• Constant Field Values

TEXT_LIGHTER

public static final String TEXT_LIGHTER

See Also:

• Constant Field Values

TEXT_ITALIC

public static final String TEXT_ITALIC

See Also:

• Constant Field Values

TEXT_OBLIQUE

public static final String TEXT_OBLIQUE

See Also:

• Constant Field Values

TEXT_STRIKETHROUGH

public static final String TEXT_STRIKETHROUGH

See Also:

• Constant Field Values

TEXT_UNDERLINED

public static final String TEXT_UNDERLINED

See Also:

• Constant Field Values

TEXT_MUTED

public static final String TEXT_MUTED

See Also:

• Constant Field Values

TEXT_SUBTLE

public static final String TEXT_SUBTLE

See Also:

• Constant Field Values

TEXT_ON_EMPHASIS

public static final String TEXT_ON_EMPHASIS

See Also:

• Constant Field Values

STATE_ACCENT

public static final javafx.css.PseudoClass STATE_ACCENT

STATE_SUCCESS

public static final javafx.css.PseudoClass STATE_SUCCESS

STATE_WARNING

public static final javafx.css.PseudoClass STATE_WARNING

STATE_DANGER

public static final javafx.css.PseudoClass STATE_DANGER

STATE_INTERACTIVE

public static final javafx.css.PseudoClass STATE_INTERACTIVE

BG_DEFAULT

public static final String BG_DEFAULT

See Also:

• Constant Field Values

BG_INSET

public static final String BG_INSET

See Also:

• Constant Field Values

BG_SUBTLE

public static final String BG_SUBTLE

See Also:

• Constant Field Values

BG_NEUTRAL_EMPHASIS_PLUS

public static final String BG_NEUTRAL_EMPHASIS_PLUS

See Also:

• Constant Field Values

BG_NEUTRAL_EMPHASIS

public static final String BG_NEUTRAL_EMPHASIS

See Also:

• Constant Field Values

BG_NEUTRAL_MUTED

public static final String BG_NEUTRAL_MUTED

See Also:

• Constant Field Values

BG_NEUTRAL_SUBTLE

public static final String BG_NEUTRAL_SUBTLE

See Also:

• Constant Field Values

BG_ACCENT_EMPHASIS

public static final String BG_ACCENT_EMPHASIS

See Also:

• Constant Field Values

BG_ACCENT_MUTED

public static final String BG_ACCENT_MUTED

See Also:

• Constant Field Values

BG_ACCENT_SUBTLE

public static final String BG_ACCENT_SUBTLE

See Also:

• Constant Field Values

BG_WARNING_EMPHASIS

public static final String BG_WARNING_EMPHASIS

See Also:

• Constant Field Values

BG_WARNING_MUTED

public static final String BG_WARNING_MUTED

See Also:

• Constant Field Values

BG_WARNING_SUBTLE

public static final String BG_WARNING_SUBTLE

See Also:

• Constant Field Values

BG_SUCCESS_EMPHASIS

public static final String BG_SUCCESS_EMPHASIS

See Also:

• Constant Field Values

BG_SUCCESS_MUTED

public static final String BG_SUCCESS_MUTED

See Also:

• Constant Field Values

BG_SUCCESS_SUBTLE

public static final String BG_SUCCESS_SUBTLE

See Also:

• Constant Field Values

BG_DANGER_EMPHASIS

public static final String BG_DANGER_EMPHASIS

See Also:

• Constant Field Values

BG_DANGER_MUTED

public static final String BG_DANGER_MUTED

See Also:

• Constant Field Values

BG_DANGER_SUBTLE

public static final String BG_DANGER_SUBTLE

See Also:

• Constant Field Values

BORDER_DEFAULT

public static final String BORDER_DEFAULT

See Also:

• Constant Field Values

BORDER_MUTED

public static final String BORDER_MUTED

See Also:

• Constant Field Values

BORDER_SUBTLE

public static final String BORDER_SUBTLE

See Also:

• Constant Field Values

Method Details

toggleStyleClass

public static void toggleStyleClass(javafx.scene.Node node,
 String styleClass)

Adds the given style class to the node if it's not present, otherwise removes it.

Parameters:

node - The target node.

styleClass - The style class to be toggled.

Throws:

NullPointerException - if node or style class is null

addStyleClass

public static void addStyleClass(javafx.scene.Node node,
 String styleClass,
 String... excludes)

Adds the given style class to the node and removes the excluded classes. This method is supposed to be used when only one from a set of classes have to be present at once.

Parameters:

node - The target node.

styleClass - The style class to be toggled.

excludes - The style classes to be excluded.

Throws:

NullPointerException - if node or styleClass is null

activatePseudoClass

public static void activatePseudoClass(javafx.scene.Node node,
 javafx.css.PseudoClass pseudoClass,
 javafx.css.PseudoClass... excludes)

Activates given pseudo-class to the node and deactivates the excluded pseudo-classes. This method is supposed to be used when only one from a set of pseudo-classes have to be present at once.

Parameters:

node - The node to activate the pseudo-class on.

pseudoClass - The pseudo-class to be activated.

excludes - The pseudo-classes to be deactivated.

Throws:

NullPointerException - if node or pseudo-class is null

appendStyle

public static void appendStyle(javafx.scene.Node node,
 String prop,
 String value)

Appends CSS style declaration to the specified node. There's no check for duplicates, so the CSS declarations with the same property name can be appended multiple times.

Parameters:

node - The node to append the new style declaration.

prop - The CSS property name.

value - The CSS property value.

Throws:

NullPointerException - if node is null

removeStyle

public static void removeStyle(javafx.scene.Node node,
 String prop)

Removes the specified CSS style declaration from the specified node.

Parameters:

node - The node to remove the style from.

prop - The name of the style property to remove.

Throws:

NullPointerException - if node is null

toDataURI

public static String toDataURI(String css)

Converts a CSS string to the Base64-encoded data URI. The resulting string is an inline data URI that can be applied to any node in the following manner:

 var dataUri = Styles.toDataURI();
 node.getStylesheets().add(dataUri);
 node.getStylesheets().contains(dataUri);
 node.getStylesheets().remove(dataUri);
 

Parameters:

css - The CSS string to encode.

Returns:

The resulting data URI string.