JavaFX CSS Reference Guide

Contents

• Introduction
  • CSS and the JavaFX Scene Graph
  • Scene, Parent and SubScene Stylesheets
  • Naming Conventions
  • CSS Public API
  • Inheritance
  • @ Rules
  • Examples
  • Understanding Parser Warnings
  • Limitations
• Types
  • inherit
  • <boolean>
  • <string>
  • <number> & <integer>
  • <size>
  • <length>
  • <percentage>
  • <angle>
  • <duration>
  • <point>
  • <color-stop>
  • <uri>
  • <effect>
  • <font>
  • <paint>
  • <color>
• Stage
  • javafx.stage
    • PopupWindow
• Nodes
  • javafx.scene
    • Group
    • Node
    • Parent
    • Scene
  • javafx.scene.image
    • ImageView
  • javafx.scene.layout
    • AnchorPane
    • BorderPane
    • DialogPane
    • FlowPane
    • GridPane
    • HBox
    • Pane
    • Region
    • StackPane
    • TilePane
    • VBox
  • javafx.scene.media
    • MediaView
  • javafx.scene.shape
    • Shape
    • Arc
    • Circle
    • CubicCurve
    • Ellipse
    • Line
    • Path
    • Polygon
    • QuadCurve
    • Rectangle
    • SVGPath
  • javafx.scene.text
    • Text
  • javafx.scene.web
    • WebView
• Controls
  • javafx.scene.control
    • Accordion
    • Button
    • ButtonBase
    • Cell
    • CheckBox
    • CheckMenuItem
    • ChoiceBox
    • ColorPicker
    • ComboBox
    • ContextMenu
    • Control
    • DatePicker
    • HTMLEditor
    • Hyperlink
    • IndexedCell
    • Label
    • Labeled
    • ListCell
    • ListView
    • Menu
    • MenuBar
    • MenuButton
    • MenuItem
    • Pagination
    • PasswordField
    • ProgressBar
    • ProgressIndicator
    • RadioButton
    • RadioMenuItem
    • ScrollBar
    • ScrollPane
    • Separator
    • Spinner
    • Slider
    • SplitMenuButton
    • SplitPane
    • TabPane
    • TableColumnHeader
    • TableView
    • TextArea
    • TextInputControl
    • TextField
    • TitledPane
    • ToggleButton
    • ToolBar
    • Tooltip
    • TreeCell
    • TreeTableCell
    • TreeTableView
    • TreeView
    • WebView
• Charts
  • javafx.scene.chart
    • AreaChart
    • Axis
    • BarChart
    • BubbleChart
    • CategoryAxis
    • Chart
    • Legend
    • LineChart
    • NumberAxis
    • PieChart
    • ScatterChart
    • ValueAxis
    • XYChart
• References

Introduction

Never has styling a Java UI been easier than with JavaFX and Cascading Style Sheets (CSS). Going from one theme to another, or customizing the look of just one control, can all be done through CSS. To the novice, this may be unfamiliar territory; but the learning curve is not that great. Give CSS styling a try and the benefits will soon be apparent. You can also split the design and development workflow, or defer design until later in the project. Up to the last minute changes, and even post-deployment changes, in the UI's look can be achieved through JavaFX CSS.

The structure of this document is as follows. First, there is a description of all value types for JavaFX CSS properties.Where appropriate, this includes a grammar for the syntax of values of that type. Then, for each scene‑graph node that supports CSS styles, a table is given that lists the properties that are supported, along with type and semantic information. The pseudo‑classes for each class are also given. The description of CSS properties continues for the controls. For each control, the substructure of that control's skin is given, along with the style‑class names for the Region objects that implement that substructure.

CSS and the JavaFX Scene Graph

JavaFX Cascading Style Sheets (CSS) is based on the W3C CSS version 2.1 [1] with some additions from current work on version 3 [2]. JavaFX CSS also has some extensions to CSS in support of specific JavaFX features. The goal for JavaFX CSS is to allow web developers already familiar with CSS for HTML to use CSS to customize and develop themes for JavaFX controls and scene‑graph objects in a natural way.

JavaFX has a rich set of extensions to CSS in support of features such as color derivation, property lookup, and multiple background colors and borders for a single node. These features add significant new power for developers and designers and are described in detail in this document.

To the extent possible, JavaFX CSS follows the W3C standards; however, with few exceptions, JavaFX property names have been prefixed with a vendor extension of "-fx-". Even if these properties seem to be compatible with standard HTML CSS, JavaFX CSS processing assumes that the property values make use of JavaFX CSS extensions.

CSS styles are applied to nodes in the JavaFX scene‑graph in a way similar to the way CSS styles are applied to elements in the HTML DOM. Styles are first applied to the parent, then to its children. The code is written such that only those branches of the scene‑graph that might need CSS reapplied are visited. A node is styled after it is added to the scene graph. Styles are reapplied when there is a change to the node's pseudo‑class state, style‑class, id, inline style, or parent, or stylesheets are added to or removed from the scene. Note that the Node must be in the scene‑graph for CSS to be applied. The Node does not have to be shown, but must have a non‑null value for its sceneProperty. See applyCss for more details.

During a normal scene‑graph pulse, CSS styles are applied before the scene‑graph is laid out and painted. Styles for events that trigger a pseudo‑class state change, such as MouseEvent.MOUSE_ENTERED which triggers the "hover" state, are applied on the next pulse following the event.

CSS selectors are used to match styles to scene‑graph nodes. The relationship of a Node to a CSS selector is as follows:

• Node's getTypeSelector method returns a String which is analogous to a CSS Type Selector. By default, this method returns the simple name of the class. Note that the simple name of an inner class or of an anonymous class may not be usable as a type selector. In such a case, this method should be overridden to return a meaningful value.
• Each node in the scene‑graph has a styleClass property. Note that a node may have more than one style‑class. A Node's styleClass is analogous to the class="..." attribute that can appear on HTML elements. See Class Selectors.
• Each node in the scene‑graph has an id variable, a string. This is analogous to the id="..." attribute that can appear HTML elements. See ID Selectors.

JavaFX CSS also supports pseudo‑classes, but does not implement the full range of pseudo‑classes as specified in Pseudo‑classes. The pseudo‑classes supported by each Node type are given in the tables within this reference. Note that JavaFX does not currently support structural pseudo‑classes.

Each node honors a set of properties that depends on the node's JavaFX class (as distinct from its styleClass). The properties honored by each node class are shown in detail in tables later in this document. The property value that is actually applied depends on the precedence of the origin of the rule, as described above, as well as the specificity of the rule's selector as described in CSS 2 [1] . Ultimately, a property value string is converted into a JavaFX value of the appropriate type and is then assigned to an instance variable of the JavaFX object.

Scene, Parent and SubScene Stylesheets

CSS styles can come from style sheets or inline styles. Style sheets are loaded from the URLs specified in the getStylesheets property of the Scene object. If the scene‑graph contains a Control, a default user agent style sheet is loaded. Inline styles are specified via the Node setStyle API. Inline styles are analogous to the style="..." attribute of an HTML element. Styles loaded from a Scene's style sheets take precedence over selectors from the user agent style sheet. Inline styles take precedence over styles originating elsewhere. The precedence order of style selectors can be modified using "!important" in a style declaration.

Beginning with JavaFX 2.1, the Parent class has a getStylesheets property, allowing style sheets to be set on a container. This allows for one branch of of the scene‑graph to have a distinct set of styles. Any instance of Parent can have style sheets. A child will take its styles from its own inline styles, the style sheets of all its ancestors, and any style sheets from the Scene.

Beginning with JavaFX 8u20, the Scene class has a getUserAgentStylesheet property, allowing a user‑style sheet to be set on a Scene. This allows a Scene to have a set of user‑agent styles distinct from the platform default. When a user‑agent stylesheet is set on a Scene, the user‑agent styles are used instead of the styles from the platform default user‑agent stylesheet.

Beginning with JavaFX 8u20, the SubScene class has a getUserAgentStylesheet property, allowing a user‑style sheet to be set on a SubScene. This allows a SubScene of the scene‑graph to have set of user‑agent styles distinct from the platform default or from the Scene in which the SubScene is contained. When a user‑agent stylesheet is set on a SubScene, the user‑agent styles are used instead of the styles from the platform default user‑agent stylesheet or any user‑agent stylesheet set on the Scene.

It is important to note that styles from a stylesheet added to a Scene or Parent, do not affect a SubScene which is a child or descendent of the Scene or Parent. Unless a user‑agent has been set on the SubScene, the SubScene will get styles from the a Scene's user‑agent stylesheet or the platform user‑agent stylesheet.

Naming Conventions

Naming conventions have been established for deriving CSS style‑class names from JavaFX class names, and for deriving CSS property names from JavaFX variable names. Note that this is only a naming convention; there is no automatic name conversion. Most JavaFX names use "camel case," that is, mixed case names formed from compound words, where the initial letter of each sub-word is capitalized. Most CSS names in the HTML world are all lower case, with compound words separated by hyphens. The convention is therefore to take JavaFX class names and form their corresponding CSS style‑class name by separating the compound words with hyphens and convering the letters to all lower case. For example, the JavaFX ToggleButton class would have a style‑class of "toggle-button". The convention for mapping JavaFX variable names to CSS property names is similar, with the addition of the "-fx-" prefix. For example, the blendMode variable would have a corresponding CSS property name of "-fx-blend-mode".

CSS Public API

Inheritance

CSS also provides for certain properties to be inherited by default, or to be inherited if the property value is 'inherit'. If a value is inherited, it is inherited from the computed value of the element's parent in the document tree. In JavaFX, inheritance is similar, except that instead of elements in the document tree, inheritance occurs from parent nodes in the scene‑graph.

The following properties inherit by default. Any property can be made to inherit by giving it the value "inherit".

Within the hierarchy of JavaFX classes (for example, Rectangle is a subclass of Shape, which in turn is a subclass of Node), the CSS properties of an ancestor are also CSS properties of the descendant. This means that a subclass will respond to the same set of properties as its ancestor classes, and to additional properties it defines itself. So, a Shape supports all the properties of Node plus several more, and Rectangle supports all the properties of Shape plus a couple more. However, because using a JavaFX class name as a type selector is an exact match, providing style declarations for a Shape will not cause a Rectangle to use those values (unless the .css value for the Rectangle's property is "inherit").

For font inheritance, the CSS engine looks only for the styles in the table above. When looking for a font to inherit, the search terminates at any node that has a Font property that was set by the user. The user-set font is inherited provided there is not an author or an inline-style that applies specifically to that node. In this case, the inherited font is created from the user-set font and any parts of the applicable author or in-line style.

@ Rules

Beginning with JavaFX 8u20, the CSS @import is also partially supported. Only unconditional import is supported. In other words, the media‑type qualifier is not supported. Also, the JavaFX CSS parser is non-compliant with regard to where an @import may appear within a stylesheet (see At‑rules). Users are cautioned that this will be fixed in a future release. Adherence to the W3C standard is strongly advised.

Since JavaFX 8, the implementation partially supports the CSS3 syntax to load a font from a URL using the @font‑face rule:

This allows public resources for fonts to be used in a JavaFX application. For example, assume the URL "http://font.samples/web?family=samples" returns the @font‑face rule given above. Then the following code shows how the sample font could be used in a JavaFX application.

Or, the URL could be imported into a stylesheet with the @import rule.

Although the parser will parse the syntax, all @font‑face descriptors are ignored except for the src descriptor. The src descriptor is expected to be a <url>. The format hint is ignored.

Examples

Consider the following simple JavaFX application:

Scene scene = new Scene(new Group());
scene.getStylesheets().add(“test.css”);
Rectangle rect = new Rectangle(100,100);
rect.setLayoutX(50);
rect.setLayoutY(50);
rect.getStyleClass().add("my-rect");
((Group)scene.getRoot()).getChildren().add(rect);

Without any styles, this will display a plain black rectangle. If test.css contains the following:

.my-rect { -fx-fill: red; }

the rectangle will be red instead of black:

If test.css contains the following:

.my-rect {
    -fx-fill: yellow;
    -fx-stroke: green;
    -fx-stroke-width: 5;
    -fx-stroke-dash-array: 12 2 4 2;
    -fx-stroke-dash-offset: 6;
    -fx-stroke-line-cap: butt;
}

the result will be a yellow rectangle with a nicely dashed green border:

Understanding Parser Warnings

When the JavaFX CSS parser encounters a syntax error, a warning message is emitted which conveys as much information as is available to help resolve the error. For example

WARNING: javafx.css.CssParser declaration Expected '<percent>' while parsing '-fx-background-color' at ?[1,49]

The cryptic '?[1,49]' pertains to the location of the error. The format of the location string is

<url>[line, position]

If the error is found while parsing a file, the file URL will be given. If the error is from an inline style (as in the example above), the URL is given as a question mark. The line and position give an offset into the file or string where the token begins. Please note that the line and position may not be accurate in releases prior to JavaFX 2.2.

Applications needing to detect errors from the parser can add a listener to the errors property of javafx.css.CssParser.

Limitations

1. While the JavaFX CSS parser will parse valid CSS syntax, it is not a fully compliant CSS parser. One should not expect the parser to handle syntax not specified in this document.
2. With the exception of @font‑face and @import, @-keyword statements are ignored.
3. The <media-query-list> of the @import statement is not parsed.
4. The structural pseudo‑classes are not supported.
5. The ":active" and ":focus" dynamic pseudo‑classes are not supported. However, Nodes do support the ":pressed" and ":focused" pseudo‑classes, which are similar.
6. The ":link" and ":visited" pseudo‑classes are not supported in general. However, Hyperlink objects can be styled, and they support the ":visited" pseudo‑class.
7. JavaFX CSS does not support comma-separated series of font family names in the -fx-font-family property. The optional line height parameter when specifying fonts is not supported. There is no equivalent for the font-variant property.
8. JavaFX CSS uses the HSB color model instead of the HSL color model.
9. If a property of a node is initialized by calling the set method of the property, the CSS implementation will see this as a user set value and the value will not be overwritten by a style from a user agent style sheet.
10. When parsing a URI, the parser doesn't handle URI escapes nor \<hex-digit>[1,6] code points.

Types

inherit

Each property has a type, which determines what kind of value and the syntax for specifying those values. In addition, each property may have a specified value of 'inherit', which means that, for a given node, the property takes the same computed value as the property for the node's parent. The 'inherit' value can be used on properties that are not normally inherited.

If the 'inherit' value is set on the root element, the property is assigned its initial value.

<boolean>

Boolean values can either have the string value of "true" or "false", the values are case insensitive as all CSS is case insensitive.

<string>

Strings can either be written with double quotes or with single quotes. Double quotes cannot occur inside double quotes, unless escaped (e.g., as '\"' or as '\22'). Analogously for single quotes (e.g., "\'" or "\27").

"this is a 'string'"
"this is a \"string\""
'this is a "string"'
'this is a \'string\''

A string cannot directly contain a newline. To include a newline in a string, use an escape representing the line feed character in ISO-10646 (U+000A), such as "\A" or "\00000a". This character represents the generic notion of "newline" in CSS. See the 'content' property for an example.

<number> & <integer>

Some value types may have integer values (denoted by <integer>) or real number values (denoted by <number>). Real numbers and integers are specified in decimal notation only. An <integer> consists of one or more digits "0" to "9". A <number> can either be an <integer>, or it can be zero or more digits followed by a dot (.) followed by one or more digits. Both integers and real numbers may be preceded by a "-" or "+" to indicate the sign. -0 is equivalent to 0 and is not a negative number.

[+|-]? [[0-9]+|[0-9]*"."[0-9]+]

Note that many properties that allow an integer or real number as a value actually restrict the value to some range, often to a non-negative value.

<size>

A size is a <number> with units of <length> or <percentage>. If a unit is not specified then 'px' is assumed.

<length>

<number>[ px | mm | cm | in | pt | pc | em | ex ]?

No whitespace is allowed between the number and units if provided. Some units are relative and others absolute.

Relative

• px: pixels, relative to the viewing device
• em: the 'font-size' of the relevant font
• ex: the 'x-height' of the relevant font

Absolute

• in: inches — 1 inch is equal to 2.54 centimeters.
• cm: centimeters
• mm: millimeters
• pt: points — the points used by CSS 2.1 are equal to 1/72nd of an inch.
• pc: picas — 1 pica is equal to 12 points.

<percentage>

These are a percentage of some length, typically to the width or height of a node.

<number>[ % ]

<angle>

An angle is a <number> with one of the following units.

<number>[ deg | rad | grad | turn ]

• deg: angle in degrees — all other angle units are converted to degrees.
• rad: angle in radians
• grad: angle in gradians
• turn: angle in turns

<duration>

A duration is a <number> with second or millisecond units, or the value indefinite.

[<number>[ s | ms ]] | indefinite

• s: duration in seconds
• ms: duration in milliseconds. One second is 1000 milliseconds.
• indefinite: See Duration.INDEFINITE

See also W3C time units.

<point>

A point is an {x,y} coordinate.

[ [ <length> <length> ] | [ <percentage> | <percentage> ] ]

<color-stop>

Stops are per W3C color-stop syntax.

[ <color> [ <percentage> | <length>]? ]

In a series of <color-stop>, stop distance values must all be <percentage> or <length>. Furthermore, if <length> values are used, then the distance value for first and last stop in the series must be specified. This restriction may be removed in a future release.

"red, white 70%, blue" is valid since the distance for red and blue is assumed to be 0% and 100%, respectively.

"red 10, white, blue 90" is valid. Because distance for red and blue is 10 and 90, respectively, the distance for white can be calculated.

"red, white 70, blue" is not valid since distance units do not agree.

"red, white, blue" is valid. The stops are distributed evenly between 0% and 100%.

<uri>

url ( [\"\']? <address> [\"\']? )

<address> is a hierarchical URI of the form [scheme:][//authority][path] (see [2]). For example:

url(http://example.com/images/Duke.png)
url(/com/example/javafx/app/images/Duke.png)

If the <address> does not have a [scheme:] component, the <address> is considered to be the [path] component only. A leading '/' character indicates that the [path] is relative to the root of the classpath. If the the style appears in a stylesheet and has no leading '/' character, the path is relative to the base URI of the stylesheet. If the style appears in an inline style, the path is relative to the root of the classpath (regardless of whether or not there is a leading '/').

Note that for inline styles, leading dot-segments (e.g. '..' or '.') do resolve since the path is always anchored at the root of the classpath.

As an example, the code snippet below creates a scene filled with a fictional 'Duke.png' image, located in an 'image' directory:

The same style would work equally as well from a stylesheet.

<effect>

JavaFX CSS currently supports the DropShadow and InnerShadow effects from the JavaFX platform. See the class documentation in javafx.scene.effect for further details about the semantics of the various effect parameters.

Drop Shadow

A high-level effect that renders a shadow of the given content behind the content.

dropshadow( <blur-type> , <color> , <number> , <number> , <number> , <number> )

<blur-type> = [ gaussian | one-pass-box | three-pass-box | two-pass-box ]
<color> The shadow Color.
<number> The radius of the shadow blur kernel. In the range [0.0 ... 127.0], typical value 10.
<number> The spread of the shadow. The spread is the portion of the radius where the contribution of the source material will be 100%. The remaining portion of the radius will have a contribution controlled by the blur kernel. A spread of 0.0 will result in a distribution of the shadow determined entirely by the blur algorithm. A spread of 1.0 will result in a solid growth outward of the source material opacity to the limit of the radius with a very sharp cutoff to transparency at the radius. Values should be in the range [0.0 ... 1.0].
<number> The shadow offset in the x direction, in pixels.
<number> The shadow offset in the y direction, in pixels.

Inner Shadow

A high-level effect that renders a shadow inside the edges of the given content.

innershadow( <blur-type> , <color> , <number> , <number> , <number> , <number> )

<blur-type> = [ gaussian | one-pass-box | three-pass-box | two-pass-box ]
<color> The shadow Color.
<number> The radius of the shadow blur kernel. In the range [0.0 ... 127.0], typical value 10.
<number> The choke of the shadow. The choke is the portion of the radius where the contribution of the source material will be 100%. The remaining portion of the radius will have a contribution controlled by the blur kernel. A choke of 0.0 will result in a distribution of the shadow determined entirely by the blur algorithm. A choke of 1.0 will result in a solid growth inward of the shadow from the edges to the limit of the radius with a very sharp cutoff to transparency inside the radius. Values should be in the range [0.0 ... 1.0].
<number> The shadow offset in the x direction, in pixels.
<number> The shadow offset in the y direction, in pixels.

<font>

JavaFX CSS supports the ability to specify fonts using separate family, size, style, and weight properties, as well as the ability to specify a font using a single shorthand property. There are four value types related to fonts plus a shorthand property that encompasses all four properties. The font-related types are as follows.

<font-family>The string name of the font family. An actual font family name available on the system can be used, or one of the following generic family names can be used:

• 'serif' (e.g., Times)
• 'sans-serif' (e.g., Helvetica)
• 'cursive' (e.g., Zapf-Chancery)
• 'fantasy' (e.g., Western)
• 'monospace' (e.g., Courier)

<font-size> The size of the font, using the <size> syntax.

<font-style> The font's style, using the following syntax:
[ normal | italic | oblique ]

<font-weight> The font's weight, using the following syntax:
[ normal | bold | bolder | lighter | 100 | 200 | 300 | 400 | 500 | 600 | 700 | 800 | 900 ]

<font> This font shorthand property can be used in place of the above properties. It uses the following syntax:
[[ <font-style> || <font-weight> ]? <font-size> <font-family> ]

Font Properties

Most classes that use text will support the following font properties. In some cases a similar set of properties will be supported but with a different prefix instead of "-fx-font".

<paint>

Paint values can either be a solid color specified in one of the color syntaxes, they can be a linear or radial gradient, or an image-pattern.

<color> | <linear-gradient> | <radial-gradient> | <image-pattern> <repeating-image-pattern>

Linear Gradients <linear-gradient>

linear-gradient( [ [from <point> to <point>] | [ to <side-or-corner>], ]? [ [ repeat | reflect ], ]? <color-stop>[, <color-stop>]+)

where <side-or-corner> = [left | right] || [top | bottom]

Linear gradient creates a gradient going though all the stop colors along the line between the "from" <point> and the "to" <point>. If the points are percentages, then they are relative to the size of the area being filled. Percentage and length sizes can not be mixed in a single gradient function.

If neither repeat nor reflect are given, then the CycleMethod defaults "NO_CYCLE".
If neither [from <point> to <point>] nor [ to <side-or-corner> ] are given, then the gradient direction defaults to 'to bottom'.
Stops are per W3C color-stop syntax and are normalized accordingly.

This example will create a gradient from top left to bottom right of the filled area with red at the top left corner and black at the bottom right.

linear-gradient(to bottom right, red, black)

This is equivalent to:

linear-gradient(from 0% 0% to 100% 100%, red 0%, black 100%)

This more complex example will create a 50px high bar at the top with a 3 color gradient with white underneath for the rest of the filled area.

linear-gradient(from 0px 0px to 0px 50px, gray, darkgray 50%, dimgray 99%, white)

The following syntax for linear gradient does not conform to the CSS grammar and is deprecated in JavaFX 2.0. The JavaFX 2.0 CSS parser supports the syntax but this support may be removed in later releases.

linear (<size>, <size>) to (<size>, <size>) stops [ (<number>,<color>) ]+ [ repeat | reflect ]?

Radial Gradients <radial-gradient>

radial-gradient([ focus-angle <angle>, ]? [ focus-distance <percentage>, ]? [ center <point>, ]? radius [ <length> | <percentage> ] [ [ repeat | reflect ], ]? <color-stop>[, <color-stop>]+)

Radial gradient creates a gradient going though all the stop colors radiating outward from the center point to the radius. If the center point is not given, the center defaults to (0,0). Percentage values are relative to the size of the area being filled. Percentage and length sizes can not be mixed in a single gradient function.

If neither repeat nor reflect are given, then the CycleMethod defaults "NO_CYCLE".
Stops are per W3C color-stop syntax and are normalized accordingly.

Following are examples of the use of radial-gradient:

radial-gradient(radius 100%, red, darkgray, black)

radial-gradient(focus-angle 45deg, focus-distance 20%, center 25% 25%, radius 50%, reflect, gray, darkgray 75%, dimgray)

The following syntax for radial gradient does not conform to the CSS grammar and is deprecated in JavaFX 2.0. The JavaFX 2.0 CSS parser supports the syntax but this support may be removed in later releases.

radial [focus-angle <number> | <number> ] ]? [ focus-distance <size> ]? [ center <size,size> ]? <size> stops [ ( <number>, <color> ) ]+ [ repeat | reflect ]?

Image Paint <image-pattern>

image-pattern(<string>, [<size>, <size>, <size>, <size>[, <boolean>]?]?)

The parameters, in order, are:

<string> The URL of the image.
<size> The x origin of the anchor rectangle.
<size> The y origin of the anchor rectangle.
<size> The width of the anchor rectangle.
<size> The height of the anchor rectangle.
<boolean> The proportional flag which indicates whether start and end locations are proportional or absolute

For a full explanation of the parameters, refer to the ImagePattern javadoc.

Following are examples of the use of image-pattern:

image-pattern("images/Duke.png")

image-pattern("images/Duke.png", 20%, 20%, 80%, 80%)

image-pattern("images/Duke.png", 20%, 20%, 80%, 80%, true)

image-pattern("images/Duke.png", 20, 20, 80, 80, false)

Related, there is the repeating-image-pattern function which is a shorthand for producing tiled image based fills. It is equivalent to

image-pattern("images/Duke.png", 0, 0, imageWidth, imageHeight, false)

repeating-image-pattern(<string>)

The only parameter is the uri of the image. Following is an example of the use of image-pattern:

repeating-image-pattern("com/mycompany/myapp/images/Duke.png")

<color>

<named-color> | <looked-up-color> | <rgb-color> | <hsb-color> | <color-function>

Named Colors <named-color>

CSS supports a bunch of named constant colors. Named colors can be specified with just their unquoted name for example:

.button {
    -fx-background-color: red;
}

The named colors that are available in CSS are:

Looked-up Colors <looked-up-color>

With looked-up colors you can refer to any other color property that is set on the current node or any of its parents. This is a very powerful feature, as it allows a generic palette of colors to be specified on the scene then used thoughout the application. If you want to change one of those palette colors you can do so at any level in the scene tree and it will affect that node and all its decendents. Looked-up colors are not looked up until they are applied, so they are live and react to any style changes that might occur, such as replacing a palette color at runtime with the "style" property on a node.

In the following example, all background color of all buttons uses the looked up color "abc".

.root { abc: #f00 }
.button { -fx-background-color: abc }

RGB Colors <rgb-color>

The RGB color model is used in numerical color specifications. It has a number of different supported forms.

#<digit><digit><digit>
| #<digit><digit><digit><digit><digit><digit>
| rgb( <integer> , <integer> , <integer> )
| rgb( <integer> %, <integer>% , <integer>% )
| rgba( <integer> , <integer> , <integer> , <number> )
| rgba( <integer>% , <integer>% , <integer> %, <number> )

These examples all specify the same color for the text fill of a Label:

• .label { -fx-text-fill: #f00 } /* #rgb */
• .label { -fx-text-fill: #ff0000 } /* #rrggbb */
• .label { -fx-text-fill: rgb(255,0,0) }
• .label { -fx-text-fill: rgb(100%, 0%, 0%) }
• .label { -fx-text-fill: rgba(255,0,0,1) }

RGB Hex: The format of an RGB value in hexadecimal notation is a ‘#’ immediately followed by either three or six hexadecimal characters. The three-digit RGB notation (#rgb) is converted into six-digit form (#rrggbb) by replicating digits, not by adding zeros. For example, #fb0 expands to #ffbb00. This ensures that white (#ffffff) can be specified with the short notation (#fff) and removes any dependencies on the color depth of the display.

RGB Decimal or Percent: The format of an RGB value in the functional notation is ‘rgb(’ followed by a comma-separated list of three numerical values (either three decimal integer values or three percentage values) followed by ‘)’. The integer value 255 corresponds to 100%, and to F or FF in the hexadecimal notation: rgb(255,255,255) = rgb(100%,100%,100%) = #FFF. White space characters are allowed around the numerical values.

RGB + Alpha: This is an extension of the RGB color model to include an ‘alpha’ value that specifies the opacity of a color. This is accomplished via a functional syntax of the form rgba(...) form that takes a fourth parameter which is the alpha value. The alpha value must be a number in the range 0.0 (representing completely transparent) and 1.0 (completely opaque). As with the rgb() function, the red, green, and blue values may be decimal integers or percentages. The following examples all specify the same color:

• .label { -fx-text-fill: rgb(255,0,0) } /* integer range 0 — 255*/
• .label { -fx-text-fill: rgba(255,0,0,1) /* the same, with explicit opacity of 1 */
• .label { -fx-text-fill: rgb(100%,0%,0%) } /* float range 0.0% — 100.0% */
• .label { -fx-text-fill: rgba(100%,0%,0%,1) } /* the same, with explicit opacity of 1 */

HSB Colors <hsb-color>

Colors can be specified using the HSB (sometimes called HSV) color model, as follows:

hsb( <number> , <number>% , <number>% ) | hsba( <number> , <number>% , <number>% , <number> )

The first number is hue, a number in the range 0 to 360 degrees. The second number is saturation, a percentage in the range 0% to 100%. The third number is brightness, also a percentage in the range 0% to 100%. The hsba(...) form takes a fourth parameter at the end which is a alpha value in the range 0.0 to 1.0, specifying completely transparent and completely opaque, respectively.

Color Functions <color-function>

JavaFX supports some color computation functions. These compute new colors from input colors at the time the color style is applied. This enables a color theme to be specified using a single base color and to have variant colors computed from that base color. There are two color functions: derive() and ladder().

<derive> | <ladder>

Derive <derive>

derive( <color> , <number>% )

The derive function takes a color and computes a brighter or darker version of that color. The second parameter is the brightness offset, representing how much brighter or darker the derived color should be. Positive percentages indicate brighter colors and negative percentages indicate darker colors. A value of -100% means completely black, 0% means no change in brightness, and 100% means completely white.

Ladder<ladder>

ladder(<color> , <color-stop> [, <color-stop>]+)

The ladder function interpolates between colors. The effect is as if a gradient is created using the stops provided, and then the brightness of the provided <color> is used to index a color value within that gradient. At 0% brightness, the color at the 0.0 end of the gradient is used; at 100% brightness, the color at the 1.0 end of the gradient is used; and at 50% brightness, the color at 0.5, the midway point of the gradient, is used. Note that no gradient is actually rendered. This is merely an interpolation function that results in a single color.

Stops are per W3C color-stop syntax and are normalized accordingly.

For example, you could use the following if you want the text color to be black or white depending upon the brightness of the background.

background: white;
-fx-text-fill: ladder(background, white 49%, black 50%);

The resulting -fx-text-fill value will be black, because the background (white) has a brightness of 100%, and the color at 1.0 on the gradient is black. If we were to change the background color to black or dark grey, the brightness would be less than 50%, giving an -fx-text-fill value of white.

The following syntax for ladder does not conform to the CSS grammar and is deprecated in JavaFX 2.0. The JavaFX 2.0 CSS parser supports the syntax but this support may be removed in later releases.

ladder(<color>) stops [ ( <number> , <color> ) ]+

Stage

Group

Style class: .root.popup

PopupWindow does not have any properties that can be styled by CSS, but a PopupWindow does have its own Scene. Scene's root gets the .root style-class by default. If the Scene is the root scene of a PopupWindow, then the .popup style-class is also added. This allows the root scene of a PopupWindow to have distinct styles via the CSS rule .root.popup { /* declarations */ }

Nodes

Group

Style class: empty by default

Node

Style class: empty by default

Pseudo-classes

Parent

Style class: empty by default

Scene

Style class: not applicable

The Scene object has no settable CSS properties, nor does it have any pseudo‑classes. However, the root node of the scene is assigned the style class "root" (in addition to style classes already assigned to the node). This is useful because the root node of Scene is the root container for all active scene‑graph nodes. Thus, it can serve as a container for properties that are inherited or looked up.

ImageView

Style class: image-view

AnchorPane

Style class: empty by default

BorderPane

Style class: empty by default

DialogPane

Style class: dialog-pane

Substructure

• header-panel — BoderPane
  • graphic-container — StackPane
• content — Label
• button-bar — ButtonBar

FlowPane

Style class: empty by default

GridPane

Style class: empty by default

HBox

Style class: empty by default

Pane

Style class: empty by default

Region

Style class: empty by default

A Region is a Node (extending from Parent) with backgrounds and borders that are styleable via CSS. A Region is typically a rounded rectangle, though this can be modified through CSS to be an arbitrary shape. Regions can contain other Region objects (sub-regions) or they can contain sub-controls. All Regions have the same set of CSS properties as described below.

Each Region consists of several layers, painted from bottom to top, in this order:

1. background fills
2. background images
3. border strokes
4. border images
5. contents

The background and border mechanisms are patterned after the CSS 3 draft backgrounds and borders module. See [4] for a detailed description.

Background fills are specified with the properties -fx-background-color, -fx-background-radius and -fx-background-insets. The -fx-background-color property is a series of one or more comma-separated <paint> values. The number of values in the series determines the number of background rectangles that are painted. Background rectangles are painted in the order specified using the given <paint> value. Each background rectangle can have different radii and insets. The -fx-background-radius and -fx-background-insets properties are series of comma-separated values (or sets of values). The radius and insets values used for a particular background are the found in the corresponding position in the -fx-background-radius and -fx-background-insets series. For example, suppose a series of three values is given for the -fx-background-color property. A series of three values should also be specified for the -fx-background-radius and -fx-background-insets properties. The first background will be painted using the first radius value and first insets value, the second background will be painted with the second radius value and second insets value, and so forth.

Note also that properties such as -fx-background-radius and -fx-background-insets can contain a series of values or sets of four values. A set of values is separated by whitespace, whereas the values or sets-of-values in a series are separated by commas. For -fx-background-radius, a single value indicates that the value should be used for the radius of all four corners of the background rectangle. A set of four values indicates that different radius values are to be used for the top-left, top-right, bottom-right, and bottom-left corners, in that order. Similarly, the -fx-background-insets property can also contain a series of values or sets of values. A set of four values for -fx-background-insets indicates that different insets are to be used for the top, right, bottom, and left edges of the rectangle, in that order.

Background images are specified with the properties -fx-background-image, -fx-background-repeat, -fx-background-position and -fx-background-size. The number of images in the series of -fx-background-image values determines the number of background images that are painted. The -fx-background-repeat, -fx-background-position, and -fx-background-size properties each can contain a series of values. For each item in the -fx-background-image series, the corresponding items in the -fx-background-repeat, -fx-background-position, and -fx-background-size properties are applied to that background image.

Stroked borders are specified with the properties -fx-border-color, -fx-border-style, -fx-border-width, -fx-border-radius and -fx-border-insets. Each property contains a series of items. The maximum number of items in the -fx- border-color or -fx-border-style property determines the number of border layers that are painted.. Each border in the series is painted using information from the corresponding series item of the -fx-border-color, -fx-border-style, -fx-border-width, -fx-border-radius, and -fx-border-insets properties. If there is no -fx-border-color, the default color is black. if there is no -fx-border-style, the default style is solid.

Image borders are specified with the properties -fx-border-image-source, -fx-border-image-repeat, -fx-border-image-slice, -fx-border-image-width and -fx-border-image-insets. Each property contains a series of items. The number of items in the -fx-border-image-source property determines the number of images that are painted. Each image in the series is painted using information from the corresponding series items of the -fx-border-image-repeat, -fx-border-image-slice, -fx-border-image-width, and -fx-border-image-insets properties.

The region's contents are a sequence of nodes, like any other container. The contents are set programmatically and cannot be set via CSS.

StackPane

Style class: empty by default

TilePane

Style class: empty by default

VBox

Style class: empty by default

MediaView

Style class: media-view

Shape

Style class: empty by default

Arc

Style class: empty by default

The Arc node has all the properties of Shape and Node.

Circle

Style class: empty by default

The Circle node has all the properties of Shape and Node.

CubicCurve

Style class: empty by default

The CubicCurve node has all the properties of Shape and Node.

Ellipse

Style class: empty by default

The Ellipse node has all the properties of Shape and Node.

Line

Style class: empty by default

Path

Style class: empty by default

Polygon

Style class: empty by default

The Polygon node has all the properties of Shape and Node.

QuadCurve

Style class: empty by default

The QuadCurve node has all the properties of Shape and Node.

Rectangle

Style class: empty by default

SVGPath

Style class: empty by default

The SVGPath node has all the properties of Shape and Node.

Text

Style class: empty by default

WebView

Style class: web-view

Since JavaFX 2.0, the default skins for all controls support styling from CSS. This is accomplished by building the skins from layout objects called Regions. Most of the style properties for a control are provided by the Region objects that comprise the control's skin. Each Region object of the skin's substructure has its own style‑class so that it can be styled specifically. The control itself will sometimes provide CSS properties in addition to those provided by its Regions. Finally, controls may also define pseudo‑classes such as "vertical" and "horizontal" in addition to those defined by Node.

With the following exceptions, controls are focus traversable. This means that Control sets the initial value of the focusTraversable property true; whereas in Node, the initial value of the focusTraversable property is false. The following controls are not focus traversable by default: Accordion, Cell, Label, MenuBar, ProgressBar, ProgressIndicator, ScrollBar, ScrollPane, Separator, SplitPane, ToolBar.

Accordion

Style class: accordion

The Accordion control has all the properties and pseudo‑classes of Control

Substructure

• first-titled-pane — the first TitledPane

Button

Style class: button

The Button control has all the properties of ButtonBase

Pseudo-classes

ButtonBase

The ButtonBase control has all the properties of Labeled

Pseudo-classes

Cell

Style class: cell

Pseudo-classes

Substructure

• text — a Labeled

CheckBox

Style class: check-box

The CheckBox control has all the properties of ButtonBase

Pseudo-classes

Substructure

• box — a StackPane
  • mark — a StackPane

CheckMenuItem

Pseudo-classes

ChoiceBox

Style class: choice-box

The ChoiceBox control has all the properties and pseudo‑classes of Control

Substructure

• open-button — Region
  • arrow — Region

ColorPicker

Style class: color-picker

The ColorPicker control has all the properties and pseudo‑classes of ComboBoxBase

Substructure

• color display node — Label
• arrow-button — StackPane
  • arrow — StackPane

ComboBox

Style class: combo-box

The ComboBox control has all the properties and pseudo‑classes of ComboBoxBase

Substructure

• list-cell — a ListCell instance used to show the selection in the button area of a non-editable ComboBox
• text-input — a TextField instance used to show the selection and allow input in the button area of an editable ComboBox
• combo-box-popup — a PopupControl that is displayed when the button is pressed
  • list-view — a ListView
    • list-cell — a ListCell

ComboBoxBase

Style class: combo-box-base

The ComboBoxBase control has all the properties of Control

Substructure

• arrow-button — a StackPane
  • arrow — a StackPane

ContextMenu

Style class: context-menu

The ContextMenu class has all the properties of PopupControl.

.choice-box > .context-menu { ... }

Substructure

• context-menu — a Region
  • scroll-arrow — a StackPane
    • menu-up-arrow — a StackPane
  • scroll-arrow — a StackPane
    • menu-down-arrow — a StackPane
  • * — a VBox
    • menu-item — a Region
      • label — a Label
      • left-container — a StackPane (for radio buttons and check boxes)
      • right-container — a StackPane (for pull-right menus)
        • arrow — a Region
      • graphic-container — a StackPane (for MenuItem graphic)

Control

The Control class has all the properties of Region

DatePicker

Style class: date-picker

The DatePicker control has all the properties and pseudo‑classes of ComboBoxBase

Substructure

• date-picker-display-node — TextField

HTMLEditor

Style class: html-editor

The Hyperlink control has all the properties of Control.

Substructure

• grid — GridPane (contains WebView)
  • top-toolbar — ToolBar
    • html-editor-cut — ToggleButton
    • html-editor-copy — ToggleButton
    • html-editor-paste — ToggleButton
    • html-editor-align-left — ToggleButton
    • html-editor-align-right — ToggleButton
    • html-editor-align-center — ToggleButton
    • html-editor-align-justify — ToggleButton
    • html-editor-outdent — ToggleButton
    • html-editor-indent — ToggleButton
    • html-editor-bullets — ToggleButton
    • html-editor-numbers — ToggleButton
  • web-view — WebView
  • bottom-toolbar — ToolBar
    • format-menu-button — ComboBox
    • font-family-menu-button — ComboBox
    • font-size-menu-button — ComboBox
    • html-editor-bold — ToggleButton
    • html-editor-italic — ToggleButton
    • html-editor-underline — ToggleButton
    • html-editor-strike — ToggleButton
    • html-editor-hr — ToggleButton
    • html-editor-foreground — ColorPicker
    • html-editor-background — ColorPicker

Hyperlink

Style class: hyperlink

The Hyperlink control has all the properties of ButtonBase.

Pseudo-classes

Substructure

• label — Label

IndexedCell

Style class: indexed-cell

The IndexedCell control has all the properties of Cell.

Pseudo-classes

Label

Style class: label

Label has all the properties and pseudo‑class state of Labeled

Labeled

ListCell

Style class: list-cell

The ListCell control has all the settable properties and pseudo‑classes of IndexedCell.

ListView

Style class: list-view

Pseudo-classes

Substructure

• .list-view — the ListView<T>
  • .virtual-flow — VirtualFlow
    • .clipped-container — Region
      • .sheet — Group
        • .cell.indexed-cell.list-cell — ListCell<T>
      • .scroll-bar — ScrollBar

Menu

Style class: menu

Pseudo-classes

MenuBar

Style class: menu-bar

MenuBar has all the pseudo‑class states of Control

Substructure

• menu

MenuButton

Style class: menu-button

The MenuButton control has all the properties of ButtonBase

Pseudo-classes

MenuItem

Style class: menu-item

Pagination

Style class: pagination

Pagination has all the pseudo‑class states of Control

Substructure

• page — StackPane
• pagination-control — StackPane
  • leftArrowButton — Button
    • leftArrow — StackPane
  • rightArrowButton — Button
    • rightArrow — StackPane
  • bullet-button — ToggleButton
  • number-button — ToogleButton
  • page-information — Label

PasswordField

Style class: password-field

The PasswordField control has all the properties of TextField

PopupControl

PopupControl is also a PopupWindow and as such, its root node has the style-class .root.popup

ProgressBar

Style class: progress-bar

Pseudo-classes

Substructure

• track — StackPane
  • bar — Region

ProgressIndicator

Style class: progress-indicator

Pseudo-classes

Substructure

• indicator — StackPane
• progress — StackPane
• percentage — Text
• tick — StackPane

RadioButton

Style class: radio-button

The RadioButton control has all the properties of ToggleButton

Substructure

• radio — Region
  • dot — Region
• label — Label

RadioMenuItem

Pseudo-classes

ScrollBar

Style class: scroll-bar

Pseudo-classes

Substructure

• decrement-button — StackPane
  • decrement-arrow — StackPane
• track — StackPane
• thumb — StackPane
• increment-button — StackPane
  • increment-arrow — StackPane

ScrollPane

Style class: scroll-pane

Pseudo-classes

Substructure

• viewport — StackPane
  • * — StackPane
  • • The ScrollPane's content
• scroll-bar:vertical — ScrollBar
• scroll-bar:horizontal — ScrollBar
• corner — StackPane

Separator

Style class: separator

Pseudo-classes

Substructure

• line — Region

Spinner

Style class: spinner

Note that the default style class, "spinner", puts arrows on right, stacked vertically. The following style classes can also be used in combination with the default style class in order to control the layout of the Spinner.

Pseudo-classes

Substructure

• text-field — TextField
• increment-arrow-button — StackPane
  • increment-arrow — Region
• decrement-arrow-button — StackPane
  • decrement-arrow — Region

Slider

Style class: slider

Pseudo-classes

Substructure

• axis — NumberAxis
• track — Region
• thumb — Region

SplitMenuButton

Style class: split-menu-button

SplitPane

Style class: split-pane

Pseudo-classes

Substructure

• split-pane-divider — StackPane
  • vertical-grabber — StackPane
  • horizontal-grabber — StackPane

TabPane

Style class: tab-pane

Note: The styleclass is "tab-pane floating" if the TabPane is floating.

Pseudo-classes

Substructure

• tab-header-area — StackPane
  • headers-region — StackPane
  • tab-header-background — StackPane
  • control-buttons-tab — StackPane
    • tab-down-button — Pane
      • arrow — StackPane
  • tab — Tab
    • tab-label — Label
    • tab-close-button — StackPane
• tab-content-area — StackPane

TableColumnHeader

Style class: column-header

Pseudo-classes

Substructure

• column-resize-line — Region
• column-overlay — Region
• placeholder — StackPane
• column-header-background — StackPane
  • nested-column-header
    • column-header
  • filler — Region
  • show-hide-columns-button — StackPane
    • show-hide-column-image — StackPane
  • column-drag-header — StackPane
    • label — Label

TableView

Style class: table-view

Pseudo-classes

Substructure

• column-resize-line — Region
• column-overlay — Region
• placeholder — StackPane
• column-header-background — StackPane
  • nested-column-header
    • column-header
  • filler — Region
  • show-hide-columns-button — StackPane
    • show-hide-column-image — StackPane
  • column-drag-header — StackPane
    • label — Label
• table-column — TableColumn

TextArea

Style class: text-area

Substructure

• scroll-pane — ScrollPane
  • content — Region

TextInputControl

Pseudo-classes

TextField

Style class: text-field

TextField has all the pseudo‑class states of TextInputControl

TitledPane

Pseudo-classes

Substructure

• title — HBox
  • text — Label/li>
  • arrow-button — StackPane/li>
    • arrow — StackPane
• content — StackPane/li>

ToggleButton

Style class: toggle-button

The ToggleButton control has all the properties of ButtonBase.

Pseudo-classes

ToolBar

Style class: tool-bar

Pseudo-classes

Substructure

• tool-bar-overflow-button — StackPane
  • arrow — StackPane

Tooltip

Style class: tooltip

Substructure

• label — Label
• page-corner — StackPane

TreeCell

Style class: tree-cell

Pseudo-classes

TreeTableCell

Style class: tree-table-cell

Pseudo-classes

TreeView

Style class: tree-table-view

TreeView

Style class: tree-view

Charts

AreaChart

Axis

Style class: axis

Substructure

• axis-label — Text
• axis-tick-mark — Path

BarChart

BubbleChart

CategoryAxis

Style class: axis

Chart

Style class: chart

Substructure

• chart-title — Label
• chart-content — Pane

Legend

Style class: chart-legend

Substructure

• chart-legend-item — Label
• chart-legend-item-symbol — Node (the Label's graphic)

LineChart

NumberAxis

Style class: axis

PieChart

ScatterChart

ValueAxis

Style class: axis

Substructure

• axis-minor-tick-mark — Path

XYChart

Style class: set by sub-type

Substructure

• plot-content — Group
• chart-plot-background — Region
• chart-alternative-column-fill — Path
• chart-alternative-row-fill — Path
• chart-vertical-grid-lines — Path
• chart-horizontal-grid-lines — Path
• chart-vertical-zero-line — Line
• chart-horizontal-zero-line — Line

References

[1] CSS 2.1: http://www.w3.org/TR/CSS21/

[2] CSS 3 work in progress http://www.w3.org/Style/CSS/current-work (May 2010).

[3] SVG Paths: http://www.w3.org/TR/SVG/paths.html

[4] CSS Backgrounds and Borders Module Level 3: http://www.w3.org/TR/css3-background/

[5] Uniform Resource Identifier (URI): Generic Syntax RFC-3986

Report a bug or suggest an enhancement
Copyright © 2008, 2023, Oracle and/or its affiliates. All rights reserved.