Java FX CSS Reference Guide
User Manual:
Open the PDF directly: View PDF .
Page Count: 31
Download | ![]() |
Open PDF In Browser | View PDF |
12/15/2017 JavaFX CSS Reference Guide Release: JavaFX 8 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& 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 https://docs.oracle.com/javase/8/javafx/api/javafx/scene/doc-files/cssref.html 1/31 12/15/2017 JavaFX CSS Reference Guide Button ButtonBase Cell CheckBox CheckMenuItem ChoiceBox ColorPicker ComboBox ContextMenu Control DatePicker HTMLEditor Hyperlink IndexedCell Label Labeled ListCell ListView Menu MenuBar MenuButton MenuItem MenuItemBase 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. https://docs.oracle.com/javase/8/javafx/api/javafx/scene/doc-files/cssref.html 2/31 12/15/2017 JavaFX CSS Reference Guide 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. The implementation allows designers to style an application by using style sheets to override property values set from code. For example, a call to rectangle.setFill(Color.YELLOW) can be overridden by an inline‑style or a style from an author stylesheet. This has implications for the cascade; particularly, when does a style from a style sheet override a value set from code? The JavaFX CSS implementation applies the following order of precedence: a style from a user agent style sheet has lower priority than a value set from code, which has lower priority than a Scene or Parent style sheet. Inline styles have highest precedence. Style sheets from a Parent instance are considered to be more specific than those styles from Scene style sheets. 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 https://docs.oracle.com/javase/8/javafx/api/javafx/scene/doc-files/cssref.html 3/31 12/15/2017 JavaFX CSS Reference Guide 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 Beginning with JavaFX 8.0, public API is available for developers to create styleable properties and manage pseudo-class state. Refer to javafx.css for details. 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". Class javafx.scene.Node Property cursor CSS Property -fx-cursor javafx.scene.text.Text textAlignment -fx-text-alignment javafx.scene.text.Font font -fx-font, -fx-font-family, -fx-font-size, -fx-font-weight, -fxfont-style Initial Value javafx.scene.Cursor.DEFAULT javafx.scene.text.TextAlignment.LEFT Font.DEFAULT (12px system) 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: @font-face { font-family: 'sample'; font-style: normal; font-weight: normal; src: local('sample'), url('http://font.samples/resources/sample.ttf';) format('truetype'); } 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. import import import import javafx.application.Application; javafx.scene.Scene; javafx.scene.control.Label; javafx.stage.Stage; public class HelloFontFace extends Application { @Override public void start(Stage primaryStage) { Label label = new Label("Hello @FontFace"); label.setStyle("-fx-font-family: sample; -fx-font-size: 80;"); Scene scene = new Scene(label); scene.getStylesheets().add("http://font.samples/web?family=samples"); primaryStage.setTitle("Hello @FontFace"); primaryStage.setScene(scene); primaryStage.show(); } } public static void main(String[] args) { launch(args); } 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 . The format hint is ignored. Examples Consider the following simple JavaFX application: https://docs.oracle.com/javase/8/javafx/api/javafx/scene/doc-files/cssref.html 4/31 12/15/2017 JavaFX CSS Reference Guide 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: com.sun.javafx.css.parser.CSSParser declaration Expected ' ' while parsing '-fx-backgroundcolor' at ?[1,49] The cryptic '?[1,49]' pertains to the location of the error. The format of the location string is [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 com.sun.javafx.css.StyleManager. This is not public API and is subject to change. 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 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 \ [1,6] code points. Types https://docs.oracle.com/javase/8/javafx/api/javafx/scene/doc-files/cssref.html 5/31 12/15/2017 JavaFX CSS Reference Guide 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 values can either have the string value of "true" or "false", the values are case insensitive as all CSS is case insensitive. 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 "this 'this 'this is is is is a a a a 'string'" \"string\"" "string"' \'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. & Some value types may have integer values (denoted by ) or real number values (denoted by ). Real numbers and integers are specified in decimal notation only. An consists of one or more digits "0" to "9". A can either be an , 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. A size is a with units of or . If units are not specified then specified the 'px' is assumed. [ 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. These are a percentage of some length, typically to the width or height of a node. [ % ] An angle is a with one of the following units. [ 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 A duration is a with second or millisecond units, or the value indefinite. [ [ s | ms ]] | indefinite s: duration in seconds https://docs.oracle.com/javase/8/javafx/api/javafx/scene/doc-files/cssref.html 6/31 12/15/2017 JavaFX CSS Reference Guide ms: duration in milliseconds. One second is 1000 milliseconds. indefinite: See Duration.INDEFINITE See also W3C time units. A point is an {x,y} coordinate. [ [ ] | [ | ] ] Stops are per W3C color-stop syntax. [ [ | ]? ] In a series of , stop distance values must all be or . Furthermore, if 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%. url ( [\"\']? [\"\']? ) 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 does not have a [scheme:] component, the 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 '/'). Examples of Resolving URLs in Stylesheets Stylesheet URL URL in Style Resolves to file:///some/path/build/classes/com/mycompany/myapp/mystyles.css url(images/Duke.png) file:///some/path/build/classes/com/mycompany/myapp/mystyles.css url(../images/Duke.png) file:///some/path/build/classes/com/mycompany/images/Duke.png jar:file:/some/path/build/myapp.jar!/com/mycompany/myapp/mystyles.css url(images/Duke.png) file:///some/path/build/classes/com/mycompany/myapp/images/Duke.png jar:file:/some/path/build/myapp.jar!/com/mycompany/myapp/images/Duke.png Examples of Resolving URLs in Inline Styles Classpath file:///some/path/build/classes URL in Style Resolved URL url(/com/mycompany/resources/images/Duke.png) file:///some/path/build/classes/com/mycompany/resources/images/Duke.png file:///some/path/build/myapp.jar url(/com/mycompany/resources/images/Duke.png) jar:file:/some/path/build/myapp.jar!/com/mycompany/resources/images/Duke.png 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. This snippet of code creates a scene filled with the "paste" image from HTMLEditor which is found in jfxrt.jar. @Override public void start(Stage stage) { StackPane root = new StackPane(); root.setStyle("-fx-background-image: url(/com/sun/javafx/scene/control/skin/modena/HTMLEditor-Paste.png);"); Scene scene = new Scene(root, 300, 250); stage.setScene(scene); stage.show(); } The same style would work equally as well from a stylesheet. 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( , , , , , ) = [ gaussian | one-pass-box | three-pass-box | two-pass-box ] The shadow Color. The radius of the shadow blur kernel. In the range [0.0 ... 127.0], typical value 10. https://docs.oracle.com/javase/8/javafx/api/javafx/scene/doc-files/cssref.html 7/31 12/15/2017 JavaFX CSS Reference Guide 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]. The shadow offset in the x direction, in pixels. 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( , , , , , ) = [ gaussian | one-pass-box | three-pass-box | two-pass-box ] The shadow Color. The radius of the shadow blur kernel. In the range [0.0 ... 127.0], typical value 10. 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]. The shadow offset in the x direction, in pixels. The shadow offset in the y direction, in pixels. 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. 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) The size of the font, using the syntax. The font's style, using the following syntax: [ normal | italic | oblique ] The font's weight, using the following syntax: [ normal | bold | bolder | lighter | 100 | 200 | 300 | 400 | 500 | 600 | 700 | 800 | 900 ] This font shorthand property can be used in place of the above properties. It uses the following syntax: [[ || ]? ] 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". CSS Property -fx-font Values Default Comments inherit shorthand property for font-size, font-family, font-weight and font-style -fx-font-family inherit -fx-font-size -fx-font-style inherit inherit -fx-font-weight inherit 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. | | | Linear Gradients linear-gradient( [ [from to ] | [ to ], ]? [ [ repeat | reflect ], ]? [, ]+) where = [left | right] || [top | bottom] Linear gradient creates a gradient going though all the stop colors along the line between the "from" and the "to" . 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 to ] nor [ to ] 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%) https://docs.oracle.com/javase/8/javafx/api/javafx/scene/doc-files/cssref.html 8/31 12/15/2017 JavaFX CSS Reference Guide 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 ( , ) to ( , ) stops [ ( , ) ]+ [ repeat | reflect ]? Radial Gradients radial-gradient([ focus-angle , ]? [ focus-distance , ]? [ center , ]? radius [ | ] [ [ repeat | reflect ], ]? [, ]+) 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 | ] ]? [ focus-distance ]? [ center ]? stops [ ( , ) ]+ [ repeat | reflect ]? Image Paint image-pattern( , [ , , , [, ]?]?) The parameters, in order, are: The URL of the image. The x origin of the anchor rectangle. The y origin of the anchor rectangle. The width of the anchor rectangle. The height of the anchor rectangle. 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( ) 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") | | | | Named Colors 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: aliceblue = #f0f8ff antiquewhite = #faebd7 aqua = #00ffff aquamarine = #7fffd4 azure = #f0ffff beige = #f5f5dc bisque = #ffe4c4 black = #000000 blanchedalmond = #ffebcd blue = #0000ff blueviolet = #8a2be2 brown = #a52a2a burlywood = #deb887 cadetblue = #5f9ea0 chartreuse = #7fff00 chocolate = #d2691e coral = #ff7f50 cornflowerblue = #6495ed cornsilk = #fff8dc crimson = #dc143c https://docs.oracle.com/javase/8/javafx/api/javafx/scene/doc-files/cssref.html 9/31 12/15/2017 JavaFX CSS Reference Guide cyan = #00ffff darkblue = #00008b darkcyan = #008b8b darkgoldenrod = #b8860b darkgray = #a9a9a9 darkgreen = #006400 darkgrey = #a9a9a9 darkkhaki = #bdb76b darkmagenta = #8b008b darkolivegreen = #556b2f darkorange = #ff8c00 darkorchid = #9932cc darkred = #8b0000 darksalmon = #e9967a darkslateblue = #483d8b darkslategray = #2f4f4f darkslategrey = #2f4f4f darkseagreen = #8fbc8f darkturquoise = #00ced1 deeppink = #ff1493 deepskyblue = #00bfff dimgray = #696969 dimgrey = #696969 dodgerblue = #1e90ff firebrick = #b22222 floralwhite = #fffaf0 forestgreen = #228b22 fuchsia = #ff00ff gainsboro = #dcdcdc ghostwhite = #f8f8ff gold = #ffd700 goldenrod = #daa520 gray = #808080 green = #008000 greenyellow = #adff2f grey = #808080 honeydew = #f0fff0 hotpink = #ff69b4 indianred = #cd5c5c indigo = #4b0082 ivory = #fffff0 khaki = #f0e68c lavender = #e6e6fa lavenderblush = #fff0f5 lawngreen = #7cfc00 lemonchiffon = #fffacd lightblue = #add8e6 lightcoral = #f08080 lightcyan = #e0ffff lightgoldenrodyellow = #fafad2 lightgray = #d3d3d3 lightgreen = #90ee90 lightgrey = #d3d3d3 lightpink = #ffb6c1 lightsalmon = #ffa07a lightskyblue = #87cefa lightslategray = #778899 lightslategrey = #778899 lightyellow = #ffffe0 lime = #00ff00 limegreen = #32cd32 linen = #faf0e6 magenta = #ff00ff maroon = #800000 mediumblue = #0000cd mediumslateblue = #7b68ee midnightblue = #191970 mediumorchid = #ba55d3 mediumspringgreen = #00fa9a mediumpurple = #9370db mediumturquoise = #48d1cc mediumaquamarine = #66cdaa mediumseagreen = #3cb371 mediumvioletred = #c71585 mintcream = #f5fffa mistyrose = #ffe4e1 moccasin = #ffe4b5 navajowhite = #ffdead navy = #000080 oldlace = #fdf5e6 olive = #808000 olivedrab = #6b8e23 orange = #ffa500 orangered = #ff4500 orchid = #da70d6 palegoldenrod = #eee8aa palegreen = #98fb98 paleturquoise = #afeeee palevioletred = #db7093 papayawhip = #ffefd5 peachpuff = #ffdab9 peru = #cd853f pink = #ffc0cb plum = #dda0dd powderblue = #b0e0e6 purple = #800080 red = #ff0000 rosybrown = #bc8f8f royalblue = #4169e1 saddlebrown = #8b4513 salmon = #fa8072 sandybrown = #f4a460 seagreen = #2e8b57 seashell = #fff5ee sienna = #a0522d silver = #c0c0c0 skyblue = #87ceeb slateblue = #6a5acd slategray = #708090 slategrey = #708090 snow = #fffafa springgreen = #00ff7f steelblue = #4682b4 tan = #d2b48c teal = #008080 thistle = #d8bfd8 tomato = #ff6347 turquoise = #40e0d0 violet = #ee82ee wheat = #f5deb3 white = #ffffff whitesmoke = #f5f5f5 yellow = #ffff00 yellowgreen = #9acd32 transparent = rgba(0,0,0,0) lightseagreen = #20b2aa lightsteelblue = #b0c4de darkviolet = #9400d3 Looked-up Colors 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. https://docs.oracle.com/javase/8/javafx/api/javafx/scene/doc-files/cssref.html 10/31 12/15/2017 JavaFX CSS Reference Guide 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 The RGB color model is used in numerical color specifications. It has a number of different supported forms. # | # | rgb( , , ) | rgb( %, % , % ) | rgba( , , , ) | rgba( % , % , %, ) 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 Colors can be specified using the HSB (sometimes called HSV) color model, as follows: hsb( , % , % ) | hsba( , % , % , ) 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 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 derive( , % ) 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( , [, ]+) 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 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( ) stops [ ( , ) ]+ https://docs.oracle.com/javase/8/javafx/api/javafx/scene/doc-files/cssref.html 11/31 12/15/2017 JavaFX CSS Reference Guide Stage javafx.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 styleclass 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 javafx.scene Group Style class: empty by default CSS Property Values Default Comments Group extends Parent. Group does not add any addtional CSS properties. Also has all properties of Parent Node Style class: empty by default CSS Property Values Default -fx-blend-mode [ add | blue | color-burn | color-dodge | darken | difference | exclusion | green | hard-light | lighten | multiply | overlay | red | screen | soft-light | srcatop | src-in | src-out | src-over ] -fx-cursor [ null | crosshair | default | hand | move | e-resize | h-resize | ne-resize | nw-resize | n-resize | se-resize | sw-resize | s-resize | w-resize | v-resize | text | wait ] | null -fx-effect null Range Comments null -fx-focus-traversable false inherits The default value for controls is true, although there are some exceptions. See Controls for details. Opacity can be thought of conceptually as a postprocessing operation. Conceptually, after the node (including its descendants) is rendered into an [0.0 ... 1.0] RGBA offscreen image, the opacity setting specifies how to blend the offscreen rendering into the current composite rendering. -fx-opacity 1 -fx-rotate 0 This is the angle of the rotation in degrees. Zero degrees is at 3 o'clock (directly to the right). Angle values are positive clockwise. Rotation is about the center. -fx-scale-x 1 scale about the center -fx-scale-y 1 scale about the center -fx-scale-z 1 scale about the center -fx-translate-x 0 -fx-translate-y 0 -fx-translate-z visibility [ visible | hidden | collapse | inherit ] 0 true (i.e, visible) See W3C visibility property Pseudo-classes CSS Pseudo-class Comments disabled applies when the disabled variable is true focused applies when the focused variable is true hover applies when the hover variable is true pressed applies when the pressed variable is true show-mnemonic apples when the mnemonic affordance (typically an underscore) should be shown. Parent Style class: empty by default CSS Property Values Default Comments Parent extends Node. Parent does not add any addtional CSS properties. Also has all properties of Node Scene Style class: not applicable https://docs.oracle.com/javase/8/javafx/api/javafx/scene/doc-files/cssref.html 12/31 12/15/2017 JavaFX CSS Reference Guide 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. javafx.scene.image ImageView Style class: image-view CSS Property Values Default -fx-image null Comments Relative URLs are resolved against the URL of the stylesheet. Also has all properties of Node javafx.scene.layout AnchorPane Style class: empty by default CSS Property Values Default Comments AnchorPane extends Pane and does not add any additional CSS properties. Also has all properties of Pane BorderPane Style class: empty by default CSS Property Values Default Comments BorderPane extends Pane and does not add any additional CSS properties. Also has all properties of Pane DialogPane Style class: dialog-pane CSS Property Values Default Comments -fx-graphic null Also has all properties of Pane Substructure header-panel — BoderPane graphic-container — StackPane content — Label button-bar — ButtonBar FlowPane Style class: empty by default CSS Property Values -fx-hgap -fx-vgap -fx-alignment [ top-left | top-center | top-right | center-left | center | center-right bottom-left | bottom-center | bottomright | baseline-left | baseline-center | baseline-right ] [ top | center | baseline | bottom ] -fx-orientation [ horizontal | vertical ] Comments 0 0 -fx-column-halignment [ left | center | right ] -fx-row-valignment Default top-left left center horizontal Also has all properties of Pane GridPane Style class: empty by default CSS Property Values -fx-hgap -fx-vgap -fx-alignment [ top-left | top-center | top-right | center-left | center | center-right bottom-left | bottom-center | bottom-right | baseline-left | baseline-center | baseline-right ] Default Comments 0 0 -fx-grid-lines-visible top-left false Also has all properties of Pane HBox Style class: empty by default CSS Property -fx-spacing Values top-left | top-center | top-right | center-left | center | center-right bottom-left | bottom-center | bottom-right | -fx-alignment [ baseline-left | baseline-center | baseline-right ] https://docs.oracle.com/javase/8/javafx/api/javafx/scene/doc-files/cssref.html Default Comments 0 top-left 13/31 12/15/2017 JavaFX CSS Reference Guide CSS Property Values Default -fx-fill-height Comments true Also has all properties of Pane Pane Style class: empty by default CSS Property Values Default Comments Pane extends Region to expose Region's children. Pane does not add any addtional CSS properties. Also has all properties of Region 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. 2. 3. 4. 5. background fills background images border strokes border images 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 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 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-backgroundinsets 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-imagerepeat, -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. CSS Property Values Default Comments BACKGROUND FILLS (see CSS Backgrounds and Borders Module Level 3: Backgrounds) -fx-region-background javafx.scene.layout.Background -fx-background-color [ , ]* -fx-background-insets | [ , [ | ] ]* -fx-background-radius [ ]{1,4} [ / [ ] {1,4} ]? [ , [ ]{1,4} [ / [ ]{1,4} ]? ]* null transparent 0 0 0 0 0 0 0 0 This cannot be set directly from CSS but is created from the property values of -fx-background-color, -fx-background-image, -fx-background-insets, -fxbackground-position, -fx-background-radius, -fx-background-repeat, -fxbackground-size A series of paint values separated by commas. A series of size values or sets of four size values, separated by commas. A single size value means all insets are the same. Otherwise, the four values for each inset are given in the order top, right, bottom, left. Each commaseparated value or set of values in the series applies to the corresponding background color. The same syntax and semenatics as CSS Backgrounds and Borders Module Level 3: Curve Radii applies to -fx-background-radius. Note that JavaFX supports only the short-hand syntax. Each comma-separated value or set of values in the series applies to the corresponding background color. BACKGROUND IMAGES (see CSS Backgrounds and Borders Module Level 3: Background Image) -fx-background-image [ , ]* https://docs.oracle.com/javase/8/javafx/api/javafx/scene/doc-files/cssref.html null A series of image URIs separated by commas. 14/31 12/15/2017 JavaFX CSS Reference Guide CSS Property -fx-background-position -fx-background-repeat -fx-background-size Values [ ,