Base implementation class for defining the visual representation of user
+ interface controls that need to handle platform events and therefore can take
+ advantage of using the Behavior API.
A base class for people wanting to customize a TextField
+ to contain nodes inside the text field itself, without being on top
+ of the users typed-in text.
public class BehaviorBase<C extends javafx.scene.control.Control,S extends javafx.scene.control.SkinBase<C>>
+extends Object
+
Encapsulates behavior interaction logic for a skin. The main functionality
+ in BehaviorBase revolves around infrastructure for resolving events into
+ function calls. A BehaviorBase implementation will usually contain logic for
+ handling key events based on the host platform, as well as view-specific
+ functions for handling mouse and key and other input events.
+
+
Although BehaviorBase is typically used as a base class, it is not abstract and
+ several skins instantiate an instance of BehaviorBase directly.
+
+
Note: This is an excerpt of the private Behavior API from the JavaFX codebase.
+ It serves as a compatibility layer for implementing certain controls, although it
+ can also be useful for new controls.
public abstract class BehaviorSkinBase<C extends javafx.scene.control.Control,B extends BehaviorBase<C,?>>
+extends javafx.scene.control.SkinBase<C>
+
Base implementation class for defining the visual representation of user
+ interface controls that need to handle platform events and therefore can take
+ advantage of using the Behavior API.
+
+
Note: This is an excerpt of the private Behavior API from the JavaFX codebase.
+ It serves as a compatibility layer for implementing certain controls, although it
+ can also be useful for new controls.
Unbinds all properties and removes any listeners before disposing the skin.
+ There's no need to remove listeners, which has been registered using
+ SkinBase.registerChangeListener(ObservableValue, Consumer) method,
+ because it will be done automatically from dispose method.
+
+
+
+
+
dispose
+
publicvoiddispose()
+
+
Specified by:
+
dispose in interface javafx.scene.control.Skin<C extends javafx.scene.control.Control>
+
Overrides:
+
dispose in class javafx.scene.control.SkinBase<C extends javafx.scene.control.Control>
Represents the event type that should be listened to by people who are
+ interested in knowing when the selected crumb has changed. This is accomplished
+ through listening to the selected crumb
+ property.
public class Breadcrumbs<T>
+extends javafx.scene.control.Control
+
A bread crumb bar. This control is useful to visualize and navigate
+ a hierarchical path structure, such as file systems.
+
+
+ String[] list = {"Root", "Folder", "file.txt"};
+ BreadCrumbItem<String> selectedCrumb = Breadcrumbs.buildTreeModel(list);
+ Breadcrumbs<String> breadcrumbs = new Breadcrumbs<>(selectedCrumb);
+
+
+
A breadcrumbs consist of two types of elements: a button (default is
+ Hyperlink) and a divider (default is for Label). You can
+ customize both by providing the corresponding factory.
Represents the bottom-most path node (the node on the most-right side in
+ terms of the bread crumb bar). The full path is then being constructed
+ using getParent() of the tree-items.
+
+
Consider the following hierarchy:
+ [Root] > [Folder] > [SubFolder] > [file.txt]
+
+
To show the above bread crumb bar, you have to set the [file.txt]
+ tree-node as selected crumb.
public finaljavafx.beans.property.BooleanPropertyautoNavigationEnabledProperty
+
Enables or disables auto navigation (default is enabled).
+ If auto navigation is enabled, it will automatically navigate to the
+ crumb which was clicked by the user, meaning it will set the
+ selectedCrumbProperty() upon click.
public finaljavafx.beans.property.ObjectProperty<javafx.util.Callback<Breadcrumbs.BreadCrumbItem<T>,javafx.scene.control.ButtonBase>>crumbFactoryProperty
+
The crumb factory is used to create custom bread crumb instances.
+ A null value is not allowed and will result in a fallback to the default factory.
+
+
BreadCrumbItem<T> specifies the tree item for creating bread crumb.
public finaljavafx.beans.property.ObjectProperty<javafx.util.Callback<Breadcrumbs.BreadCrumbItem<T>,? extends javafx.scene.Node>>dividerFactoryProperty
+
The divider factory is used to create custom instances of dividers.
+ A null value is not allowed and will result in a fallback to the default factory.
+
+
+
BreadCrumbItem<T> specifies the preceding tree item.
+ It can be null, which allows for inserting a divider before the first bread crumb,
+ such as when creating a Unix path.
+
? extends Node stands for resulting divider node. It can also be null,
+ indicating that there will be no divider inserted after the specified bread crumb.
Represents the bottom-most path node (the node on the most-right side in
+ terms of the bread crumb bar). The full path is then being constructed
+ using getParent() of the tree-items.
+
+
Consider the following hierarchy:
+ [Root] > [Folder] > [SubFolder] > [file.txt]
+
+
To show the above bread crumb bar, you have to set the [file.txt]
+ tree-node as selected crumb.
Represents the bottom-most path node (the node on the most-right side in
+ terms of the bread crumb bar). The full path is then being constructed
+ using getParent() of the tree-items.
+
+
Consider the following hierarchy:
+ [Root] > [Folder] > [SubFolder] > [file.txt]
+
+
To show the above bread crumb bar, you have to set the [file.txt]
+ tree-node as selected crumb.
Represents the bottom-most path node (the node on the most-right side in
+ terms of the bread crumb bar). The full path is then being constructed
+ using getParent() of the tree-items.
+
+
Consider the following hierarchy:
+ [Root] > [Folder] > [SubFolder] > [file.txt]
+
+
To show the above bread crumb bar, you have to set the [file.txt]
+ tree-node as selected crumb.
+
+
+
+
+
+
autoNavigationEnabledProperty
+
public finaljavafx.beans.property.BooleanPropertyautoNavigationEnabledProperty()
+
Enables or disables auto navigation (default is enabled).
+ If auto navigation is enabled, it will automatically navigate to the
+ crumb which was clicked by the user, meaning it will set the
+ selectedCrumbProperty() upon click.
Gets the value of the property autoNavigationEnabled.
+
+
Property description:
+
Enables or disables auto navigation (default is enabled).
+ If auto navigation is enabled, it will automatically navigate to the
+ crumb which was clicked by the user, meaning it will set the
+ selectedCrumbProperty() upon click.
+
+
+
+
+
+
setAutoNavigationEnabled
+
public finalvoidsetAutoNavigationEnabled(boolean enabled)
+
Sets the value of the property autoNavigationEnabled.
+
+
Property description:
+
Enables or disables auto navigation (default is enabled).
+ If auto navigation is enabled, it will automatically navigate to the
+ crumb which was clicked by the user, meaning it will set the
+ selectedCrumbProperty() upon click.
+
+
+
+
+
+
crumbFactoryProperty
+
public finaljavafx.beans.property.ObjectProperty<javafx.util.Callback<Breadcrumbs.BreadCrumbItem<T>,javafx.scene.control.ButtonBase>>crumbFactoryProperty()
+
The crumb factory is used to create custom bread crumb instances.
+ A null value is not allowed and will result in a fallback to the default factory.
+
+
BreadCrumbItem<T> specifies the tree item for creating bread crumb.
public finalvoidsetCrumbFactory(javafx.util.Callback<Breadcrumbs.BreadCrumbItem<T>,javafx.scene.control.ButtonBase> value)
+
Sets the value of the property crumbFactory.
+
+
Property description:
+
The crumb factory is used to create custom bread crumb instances.
+ A null value is not allowed and will result in a fallback to the default factory.
+
+
BreadCrumbItem<T> specifies the tree item for creating bread crumb.
public finaljavafx.util.Callback<Breadcrumbs.BreadCrumbItem<T>,javafx.scene.control.ButtonBase>getCrumbFactory()
+
Gets the value of the property crumbFactory.
+
+
Property description:
+
The crumb factory is used to create custom bread crumb instances.
+ A null value is not allowed and will result in a fallback to the default factory.
+
+
BreadCrumbItem<T> specifies the tree item for creating bread crumb.
public finaljavafx.beans.property.ObjectProperty<javafx.util.Callback<Breadcrumbs.BreadCrumbItem<T>,? extends javafx.scene.Node>>dividerFactoryProperty()
+
The divider factory is used to create custom instances of dividers.
+ A null value is not allowed and will result in a fallback to the default factory.
+
+
+
BreadCrumbItem<T> specifies the preceding tree item.
+ It can be null, which allows for inserting a divider before the first bread crumb,
+ such as when creating a Unix path.
+
? extends Node stands for resulting divider node. It can also be null,
+ indicating that there will be no divider inserted after the specified bread crumb.
public finalvoidsetDividerFactory(javafx.util.Callback<Breadcrumbs.BreadCrumbItem<T>,? extends javafx.scene.Node> value)
+
Sets the value of the property dividerFactory.
+
+
Property description:
+
The divider factory is used to create custom instances of dividers.
+ A null value is not allowed and will result in a fallback to the default factory.
+
+
+
BreadCrumbItem<T> specifies the preceding tree item.
+ It can be null, which allows for inserting a divider before the first bread crumb,
+ such as when creating a Unix path.
+
? extends Node stands for resulting divider node. It can also be null,
+ indicating that there will be no divider inserted after the specified bread crumb.
public finaljavafx.util.Callback<Breadcrumbs.BreadCrumbItem<T>,? extends javafx.scene.Node>getDividerFactory()
+
Gets the value of the property dividerFactory.
+
+
Property description:
+
The divider factory is used to create custom instances of dividers.
+ A null value is not allowed and will result in a fallback to the default factory.
+
+
+
BreadCrumbItem<T> specifies the preceding tree item.
+ It can be null, which allows for inserting a divider before the first bread crumb,
+ such as when creating a Unix path.
+
? extends Node stands for resulting divider node. It can also be null,
+ indicating that there will be no divider inserted after the specified bread crumb.
public class Calendar
+extends javafx.scene.control.Control
+
The Calendar control allows the user to select a date. The calendar is based on either
+ the standard ISO-8601 chronology or any of the other chronology classes defined in the
+ java.time.chrono package.
+
+
+
The value property represents the currently selected
+ LocalDate. The default value is null.
+
The chronology property specifies a calendar system to be used
+ for parsing, displaying, and choosing dates.
+
The value property is always defined in the ISO calendar system,
+ however, so applications based on a different chronology may use the conversion methods
+ provided in the Chronology API to get or set the corresponding
+ ChronoLocalDate value.
public class Card
+extends javafx.scene.control.Control
+
A versatile container that can be used in various contexts, such as headings,
+ text, dialogs and more. It includes a header to provide a brief overview
+ or context of the information. The sub-header and body sections provide
+ more detailed content, while the footer may include additional actions or
+ information.
public class CustomTextField
+extends javafx.scene.control.TextField
+
A base class for people wanting to customize a TextField
+ to contain nodes inside the text field itself, without being on top
+ of the users typed-in text.
+
+
+
+
+
+
+
Property Summary
+
Properties
+
+
Type
+
Property
+
Description
+
final javafx.beans.property.ObjectProperty<javafx.scene.Node>
A convenience wrapper for instantiating a CustomTextField with a
+ MaskTextFormatter. For additional info refer to the
+ MaskTextFormatter documentation.
Note that the MaskTextField allows for specifying the input mask as either a string
+ or a list of MaskChar. These formats cannot be converted to one another. Therefore,
+ if the input mask was specified as a list of MaskChar, this property will return
+ null value.
The whole dancing around the editable mask property is solely due to SceneBuilder
+ not works without no-arg constructor. It requires to make formatter value mutable
+ as well, which is not really tested and never intended to be supported. Also, since
+ the formatter property is not bound to the text field formatter property, setting the
+ latter manually can lead to memory leak.
Note that the MaskTextField allows for specifying the input mask as either a string
+ or a list of MaskChar. These formats cannot be converted to one another. Therefore,
+ if the input mask was specified as a list of MaskChar, this property will return
+ null value.
The whole dancing around the editable mask property is solely due to SceneBuilder
+ not works without no-arg constructor. It requires to make formatter value mutable
+ as well, which is not really tested and never intended to be supported. Also, since
+ the formatter property is not bound to the text field formatter property, setting the
+ latter manually can lead to memory leak.
The whole dancing around the editable mask property is solely due to SceneBuilder
+ not works without no-arg constructor. It requires to make formatter value mutable
+ as well, which is not really tested and never intended to be supported. Also, since
+ the formatter property is not bound to the text field formatter property, setting the
+ latter manually can lead to memory leak.
A control for displaying banners or alerts that is specifically
+ designed to grab the user’s attention. It is based on the Tile
+ layout and shares its structure.
Represents the message’s action handler. Setting an action handler makes the
+ message interactive (or clickable). When a user clicks on the interactive
+ message, the specified action handler will be called.
publicjavafx.beans.property.ObjectProperty<javafx.event.EventHandler<? super javafx.event.Event>>onCloseProperty
+
Represents the user-specified close handler, which is intended to be used to close
+ or dismiss the message. When a user clicks on the message's close button, the specified
+ close handler will be called.
Represents the message’s action handler. Setting an action handler makes the
+ message interactive (or clickable). When a user clicks on the interactive
+ message, the specified action handler will be called.
Represents the message’s action handler. Setting an action handler makes the
+ message interactive (or clickable). When a user clicks on the interactive
+ message, the specified action handler will be called.
Represents the message’s action handler. Setting an action handler makes the
+ message interactive (or clickable). When a user clicks on the interactive
+ message, the specified action handler will be called.
+
+
+
+
+
+
onCloseProperty
+
publicjavafx.beans.property.ObjectProperty<javafx.event.EventHandler<? super javafx.event.Event>>onCloseProperty()
+
Represents the user-specified close handler, which is intended to be used to close
+ or dismiss the message. When a user clicks on the message's close button, the specified
+ close handler will be called.
publicjavafx.event.EventHandler<? super javafx.event.Event>getOnClose()
+
Gets the value of the property onClose.
+
+
Property description:
+
Represents the user-specified close handler, which is intended to be used to close
+ or dismiss the message. When a user clicks on the message's close button, the specified
+ close handler will be called.
+
+
+
+
+
+
setOnClose
+
publicvoidsetOnClose(javafx.event.EventHandler<? super javafx.event.Event> onClose)
+
Sets the value of the property onClose.
+
+
Property description:
+
Represents the user-specified close handler, which is intended to be used to close
+ or dismiss the message. When a user clicks on the message's close button, the specified
+ close handler will be called.
public class ModalPane
+extends javafx.scene.control.Control
+
A container for displaying application dialogs ot top of the current scene
+ without opening a modal Stage. It's a translucent (glass) pane
+ that can hold arbitrary content as well as animate its appearance.
+
+
When displayProperty() value is changed the modal pane modifies own
+ Node.viewOrderProperty() value accordingly, thus moving itself on top of the
+ parent container or vise versa. You can change the target view order value via the
+ constructor param. This also means that one must not change the modal pane
+ Node.viewOrderProperty() property manually.
+
+
Example:
+
+
+ ModalPane modalPane = new ModalPane();
+
+ Label content = new Label("Content");
+ content.setSize(450, 450);
+
+ Button openBtn = new Button("Open");
+ openBtn.setOnAction(evt -> modalPane.show(content));
+
Indicates whether the modal pane is set to be on top or not.
+ When changed, the Node.viewOrderProperty() value will be modified accordingly.
+ See the getTopViewOrder().
Specifies whether the content should be treated as persistent or not.
+
+
By default, the modal pane exits when the ESC button is pressed or when
+ the mouse is clicked outside the content area. This property prevents
+ this behavior and plays a bouncing animation instead.
createDefaultSkin in class javafx.scene.control.Control
+
+
+
+
+
+
getTopViewOrder
+
publicintgetTopViewOrder()
+
Returns the value of Node.viewOrderProperty() to be set in order to display
+ the ModalPane on top of its parent container. This is a constructor parameter
+ that cannot be changed after the ModalPane has been instantiated.
Indicates whether the modal pane is set to be on top or not.
+ When changed, the Node.viewOrderProperty() value will be modified accordingly.
+ See the getTopViewOrder().
Indicates whether the modal pane is set to be on top or not.
+ When changed, the Node.viewOrderProperty() value will be modified accordingly.
+ See the getTopViewOrder().
+
+
+
+
+
+
setDisplay
+
publicvoidsetDisplay(boolean display)
+
Sets the value of the property display.
+
+
Property description:
+
Indicates whether the modal pane is set to be on top or not.
+ When changed, the Node.viewOrderProperty() value will be modified accordingly.
+ See the getTopViewOrder().
Specifies whether the content should be treated as persistent or not.
+
+
By default, the modal pane exits when the ESC button is pressed or when
+ the mouse is clicked outside the content area. This property prevents
+ this behavior and plays a bouncing animation instead.
Specifies whether the content should be treated as persistent or not.
+
+
By default, the modal pane exits when the ESC button is pressed or when
+ the mouse is clicked outside the content area. This property prevents
+ this behavior and plays a bouncing animation instead.
+
+
+
+
+
+
setPersistent
+
publicvoidsetPersistent(boolean persistent)
+
Sets the value of the property persistent.
+
+
Property description:
+
Specifies whether the content should be treated as persistent or not.
+
+
By default, the modal pane exits when the ESC button is pressed or when
+ the mouse is clicked outside the content area. This property prevents
+ this behavior and plays a bouncing animation instead.
+
+
+
+
+
+
show
+
publicvoidshow(javafx.scene.Node node)
+
A convenience method for setting the content of the modal pane content
+ and triggering its display state at the same time.
+
+
+
+
+
hide
+
publicvoidhide(boolean clear)
+
A convenience method for clearing the content of the modal pane content
+ and triggering its display state at the same time.
public class Notification
+extends javafx.scene.control.Control
+
A control that is intended for displaying notifications to users as pop-ups.
+ It is customizable with different colors and icons, can contain a graphic or image,
+ along with the message and additional actions for users to take.
Specifies the primary actions associated with this notification.
+
+
This property is used to store one or more action buttons that will
+ be displayed at the bottom of the notification when it appears. These
+ buttons will be placed inside the ButtonBar and use the alignment
+ that is described in the ButtonBar documentation.
Specifies the secondary actions associated with this notification.
+
+
This property is used to store one or more menu items that will be displayed
+ as a dropdown menu at the top corner of the notification when it appears.
+
+
The dropdown menu button will not appear if the list is empty.
Specifies the primary actions associated with this notification.
+
+
This property is used to store one or more action buttons that will
+ be displayed at the bottom of the notification when it appears. These
+ buttons will be placed inside the ButtonBar and use the alignment
+ that is described in the ButtonBar documentation.
Specifies the primary actions associated with this notification.
+
+
This property is used to store one or more action buttons that will
+ be displayed at the bottom of the notification when it appears. These
+ buttons will be placed inside the ButtonBar and use the alignment
+ that is described in the ButtonBar documentation.
Specifies the primary actions associated with this notification.
+
+
This property is used to store one or more action buttons that will
+ be displayed at the bottom of the notification when it appears. These
+ buttons will be placed inside the ButtonBar and use the alignment
+ that is described in the ButtonBar documentation.
Specifies the secondary actions associated with this notification.
+
+
This property is used to store one or more menu items that will be displayed
+ as a dropdown menu at the top corner of the notification when it appears.
+
+
The dropdown menu button will not appear if the list is empty.
Specifies the secondary actions associated with this notification.
+
+
This property is used to store one or more menu items that will be displayed
+ as a dropdown menu at the top corner of the notification when it appears.
+
+
The dropdown menu button will not appear if the list is empty.
Specifies the secondary actions associated with this notification.
+
+
This property is used to store one or more menu items that will be displayed
+ as a dropdown menu at the top corner of the notification when it appears.
+
+
The dropdown menu button will not appear if the list is empty.
A convenience wrapper for instantiating a CustomTextField
+ with a PasswordTextFormatter. For additional info refer to the
+ PasswordTextFormatter documentation.
Returns the enum constant of this class with the specified name.
+The string must match exactly an identifier used to declare an
+enum constant in this class. (Extraneous whitespace characters are
+not permitted.)
+
+
Parameters:
+
name - the name of the enum constant to be returned.
public class Popover
+extends javafx.scene.control.PopupControl
+
A control that is intended to provide detailed information about
+ an owning node in a popup window. The popup window has a lightweight
+ appearance (no default window decorations) and an arrow pointing at the owner.
+ Due to the nature of popup windows the Popover will move around with the parent
+ window when the user drags it.
+
+
The Popover can be detached from the owning node by dragging it away from the
+ owner. It stops displaying an arrow and starts displaying a title and a close
+ icon.
+
+
Example
+
+
+ var textFlow = new TextFlow(new Text("Some content"));
+ textFlow.setPrefWidth(300);
+
+ var popover = new Popover(textFlow);
+ popover.setTitle("Title");
+
+ var ownerLink = new Hyperlink("Show popover");
+ ownerLink.setOnAction(e -> popover.show(ownerLink));
+
public finaljavafx.beans.property.BooleanPropertydetachedProperty
+
Determines whether the popover is detached from the owning node or not.
+ A detached popover no longer shows an arrow pointing at the owner and
+ features its own title bar.
createDefaultSkin in class javafx.scene.control.PopupControl
+
+
+
+
+
+
getRoot
+
public finaljavafx.scene.layout.StackPanegetRoot()
+
The root pane stores the content node of the popover. It is accessible
+ via this method in order to support proper styling.
+
+
Example:
+
+
+ Popover popOver = new Popover();
+ popOver.getRoot().getStylesheets().add(...);
+
+
+
Returns:
+
the root pane
+
+
+
+
+
+
show
+
public finalvoidshow(javafx.scene.Node owner)
+
Shows the popover in a position relative to the edges of the given owner
+ node. The position is dependent on the arrow location. If the arrow is
+ pointing to the right then the popover will be placed to the left of the
+ given owner. If the arrow points up then the popover will be placed
+ below the given owner node. The arrow will slightly overlap with the
+ owner node.
+
+
Parameters:
+
owner - The owner of the popover.
+
+
+
+
+
+
show
+
public finalvoidshow(javafx.scene.Node owner,
+ double offset)
+
Shows the popover in a position relative to the edges of the given owner
+ node. The position is dependent on the arrow location. If the arrow is
+ pointing to the right then the popover will be placed to the left of the
+ given owner. If the arrow points up then the popover will be placed
+ below the given owner node.
+
+
Parameters:
+
owner - The owner of the popover.
+
offset - If negative specifies the distance to the owner node or when
+ positive specifies the number of pixels that the arrow will
+ overlap with the owner node (positive values are recommended).
+
+
+
+
+
+
show
+
public finalvoidshow(javafx.stage.Window owner)
+
+
Overrides:
+
show in class javafx.stage.PopupWindow
+
+
+
+
+
+
show
+
public finalvoidshow(javafx.stage.Window ownerWindow,
+ double anchorX,
+ double anchorY)
+
+
Overrides:
+
show in class javafx.stage.PopupWindow
+
+
+
+
+
+
show
+
public finalvoidshow(javafx.scene.Node owner,
+ double x,
+ double y)
+
Makes the popover visible at the give location and associates it with
+ the given owner node. The x and y coordinate will be the target location
+ of the arrow of the popover and not the location of the window.
+
+
Overrides:
+
show in class javafx.stage.PopupWindow
+
Parameters:
+
owner - The owning node.
+
x - The x coordinate for the popover arrow tip.
+
y - The y coordinate for the popover arrow tip.
+
+
+
+
+
+
show
+
public finalvoidshow(javafx.scene.Node owner,
+ double x,
+ double y,
+ javafx.util.Duration fadeInDuration)
+
Makes the popover visible at the give location and associates it with
+ the given owner node. The x and y coordinate will be the target location
+ of the arrow of the popover and not the location of the window.
+
+
Parameters:
+
owner - The owning node.
+
x - The x coordinate for the popover arrow tip.
+
y - The y coordinate for the popover arrow tip.
+
fadeInDuration - The time it takes for the popover to be fully visible.
+ This duration takes precedence over the fade-in property without setting.
+
+
+
+
+
+
hide
+
public finalvoidhide()
+
Hides the popover by quickly changing its opacity to 0.
public finaljavafx.beans.property.BooleanPropertydetachedProperty()
+
Determines whether the popover is detached from the owning node or not.
+ A detached popover no longer shows an arrow pointing at the owner and
+ features its own title bar.
Represents the node to be displayed within the progress indicator. If null,
+ it will fall back to the Label with an integer progress value from 1 to 100.
Represents the node to be displayed within the progress indicator. If null,
+ it will fall back to the Label with an integer progress value from 1 to 100.
Represents the node to be displayed within the progress indicator. If null,
+ it will fall back to the Label with an integer progress value from 1 to 100.
+
+
+
+
+
+
setGraphic
+
publicvoidsetGraphic(javafx.scene.Node graphic)
+
Sets the value of the property graphic.
+
+
Property description:
+
Represents the node to be displayed within the progress indicator. If null,
+ it will fall back to the Label with an integer progress value from 1 to 100.
public class Spacer
+extends javafx.scene.layout.Region
+
A spacing component used to distribute remaining width between
+ a parent's child components.
+
+
When placing a single Spacer before or after the child components,
+ the components will be pushed to the right and left of its container
+ for horizontally oriented Spacer, or to the top and bottom for vertically
+ oriented Spacer.
+
+
You can also specify the `Spacer` size. In this case, it will not be
+ extended and will work like a gap with the given size between sibling components.
+
+
Note that this control is not intended to be used in FXML unless SceneBuilder
+ supports constructor arguments, because none of the properties mentioned above are
+ observable.
+
+
+
+
+
+
+
Property Summary
+
+
Properties inherited from class javafx.scene.layout.Region
A versatile container that can used in various contexts such as dialog
+ headers, list items, and cards. It can contain a graphic, a title, description,
+ and optional actions.
Setting an action handler makes the tile interactive (or clickable).
+ When a user clicks on the interactive tile, the specified action handler will be called.
Setting an action handler makes the tile interactive (or clickable).
+ When a user clicks on the interactive tile, the specified action handler will be called.
Setting an action handler makes the tile interactive (or clickable).
+ When a user clicks on the interactive tile, the specified action handler will be called.
Setting an action handler makes the tile interactive (or clickable).
+ When a user clicks on the interactive tile, the specified action handler will be called.
public class ToggleSwitch
+extends javafx.scene.control.Labeled
+implements javafx.scene.control.Toggle
+
A control that provides users with the ability to choose between two distinct values.
+ It is functionally similar, though aesthetically different, from the RadioButton
+ and Checkbox.
+
+
+
+
+
+
+
Property Summary
+
Properties
+
+
Type
+
Property
+
Description
+
final javafx.beans.property.ObjectProperty<javafx.geometry.HorizontalDirection>
public finaljavafx.beans.property.ObjectProperty<javafx.scene.control.ToggleGroup>toggleGroupProperty
+
The ToggleGroup to which this ToggleSwitch belongs. A toggle can only
+ be in one group at any one time. If the group is changed, then the toggle is
+ removed from the old group prior to being added to the new group.
+
+
Specified by:
+
toggleGroupProperty in interface javafx.scene.control.Toggle
setSelected in interface javafx.scene.control.Toggle
+
Property description:
+
Returns whether this Toggle Switch is selected.
+
+
+
+
+
+
isSelected
+
public finalbooleanisSelected()
+
Gets the value of the property selected.
+
+
Specified by:
+
isSelected in interface javafx.scene.control.Toggle
+
Property description:
+
Returns whether this Toggle Switch is selected.
+
+
+
+
+
+
toggleGroupProperty
+
public finaljavafx.beans.property.ObjectProperty<javafx.scene.control.ToggleGroup>toggleGroupProperty()
+
The ToggleGroup to which this ToggleSwitch belongs. A toggle can only
+ be in one group at any one time. If the group is changed, then the toggle is
+ removed from the old group prior to being added to the new group.
+
+
Specified by:
+
toggleGroupProperty in interface javafx.scene.control.Toggle
public finalvoidsetToggleGroup(javafx.scene.control.ToggleGroup value)
+
Sets the value of the property toggleGroup.
+
+
Specified by:
+
setToggleGroup in interface javafx.scene.control.Toggle
+
Property description:
+
The ToggleGroup to which this ToggleSwitch belongs. A toggle can only
+ be in one group at any one time. If the group is changed, then the toggle is
+ removed from the old group prior to being added to the new group.
+
+
+
+
+
+
getToggleGroup
+
public finaljavafx.scene.control.ToggleGroupgetToggleGroup()
+
Gets the value of the property toggleGroup.
+
+
Specified by:
+
getToggleGroup in interface javafx.scene.control.Toggle
+
Property description:
+
The ToggleGroup to which this ToggleSwitch belongs. A toggle can only
+ be in one group at any one time. If the group is changed, then the toggle is
+ removed from the old group prior to being added to the new group.
+
+
+
+
+
+
labelPositionProperty
+
public finaljavafx.beans.property.ObjectProperty<javafx.geometry.HorizontalDirection>labelPositionProperty()
+
Specifies the side where Labeled.textProperty() value should be placed.
+ Default is HorizontalDirection.LEFT.
Base implementation class for defining the visual representation of user
+ interface controls that need to handle platform events and therefore can take
+ advantage of using the Behavior API.
Base implementation class for defining the visual representation of user
+ interface controls that need to handle platform events and therefore can take
+ advantage of using the Behavior API.
A base class for people wanting to customize a TextField
+ to contain nodes inside the text field itself, without being on top
+ of the users typed-in text.
Base implementation class for defining the visual representation of user
+ interface controls that need to handle platform events and therefore can take
+ advantage of using the Behavior API.
A base class for people wanting to customize a TextField
+ to contain nodes inside the text field itself, without being on top
+ of the users typed-in text.
public class DeckPane
+extends javafx.scene.layout.AnchorPane
+
Represents a pane that displays all of its child nodes in a deck,
+ where only one node can be visible at a time. It does not maintain any
+ sequence (model), but only cares about the top node, which can be changed
+ by various transition effects.
+
+
View Order
+
+
DeckPane manages Node.viewOrderProperty() of its children. Topmost
+ visible node always has the highest view order value, while the rest of the nodes
+ have the default value, which is zero. Following that logic, one must not set
+ child nodes view order manually, because it will break the contract.
+
+
If all child nodes have the same view order value (default state after creating
+ a new DeckPane), they are displayed in order specified by the root container, which
+ is AnchorPane. When a node is removed from the pane, its view order is
+ restored automatically.
Adds the given nodes to the pane and binds them to the pane edges
+ using the provided offset. See AnchorPane.setTopAnchor(Node, Double)
+ for the reference.
+
+
Parameters:
+
offset - The offset values for each othe the specified nodes.
+
nodes - The array of the nodes to be added.
+
+
+
+
+
+
swipeUp
+
publicvoidswipeUp(javafx.scene.Node target)
+
Places target node on the top of the pane while playing the
+ swipe transition from bottom to top. If the pane doesn't contain
+ that node, it will be added to the end before playing transition.
+
+
Parameters:
+
target - The node to be set on top.
+
+
+
+
+
+
swipeDown
+
publicvoidswipeDown(javafx.scene.Node target)
+
Places target node on the top of the pane while playing the
+ swipe transition from top to bottom. If the pane doesn't contain
+ that node, it will be added to the end before playing transition.
+
+
Parameters:
+
target - The node to be set on top.
+
+
+
+
+
+
swipeLeft
+
publicvoidswipeLeft(javafx.scene.Node target)
+
Places target node on the top of the pane while playing the
+ swipe transition from right to left. If the pane doesn't contain
+ that node, it will be added to the end before playing transition.
+
+
Parameters:
+
target - The node to be set on top.
+
+
+
+
+
+
swipeRight
+
publicvoidswipeRight(javafx.scene.Node target)
+
Places target node on the top of the pane while playing the
+ swipe transition from left to right. If the pane doesn't contain
+ that node, it will be added to the end before playing transition.
+
+
Parameters:
+
target - The node to be set on top.
+
+
+
+
+
+
slideUp
+
publicvoidslideUp(javafx.scene.Node target)
+
Places target node on the top of the pane while playing the
+ slide transition from bottom to top. If the pane doesn't contain
+ that node, it will be added to the end before playing transition.
+
+
Parameters:
+
target - The node to be set on top.
+
+
+
+
+
+
slideDown
+
publicvoidslideDown(javafx.scene.Node target)
+
Places target node on the top of the pane while playing the
+ slide transition from top to bottom. If the pane doesn't contain
+ that node, it will be added to the end before playing transition.
+
+
Parameters:
+
target - The node to be set on top.
+
+
+
+
+
+
slideLeft
+
publicvoidslideLeft(javafx.scene.Node target)
+
Places target node on the top of the pane while playing the
+ slide transition from right to left. If the pane doesn't contain
+ that node, it will be added to the end before playing transition.
+
+
Parameters:
+
target - The node to be set on top.
+
+
+
+
+
+
slideRight
+
publicvoidslideRight(javafx.scene.Node target)
+
Places target node on the top of the pane while playing the
+ slide transition from left to right. If the pane doesn't contain
+ that node, it will be added to the end before playing transition.
public class InputGroup
+extends javafx.scene.layout.HBox
+
A layout that helps combine multiple controls into a group that looks
+ like a single control.
+
+
Without it, you would have to manually add the ".left-pill", ".center-pill"
+ and ".right-pill" styles classes to each control in such combination.
+ The InputGroup removes this ceremony. Since it inherits from HBox, you can use
+ the same API.
+
+
+
+
+
+
+
Property Summary
+
+
Properties inherited from class javafx.scene.layout.HBox
+alignment, fillHeight, spacing
+
+
Properties inherited from class javafx.scene.layout.Region
public class ModalBox
+extends javafx.scene.layout.AnchorPane
+
A specialized control (or layout) designed to hold the ModalPane
+ dialog content. It includes the close button out-of-the-box and allows for the
+ addition of arbitrary children.
+
+
The ModalBox is derived from the AnchorPane, so it inherits the same API.
+ Just be sure that you haven't removed the close button while using it.
Methods inherited from interface javafx.css.Styleable
+getStyleableNode
+
+
+
+
+
+
+
+
+
+
Property Details
+
+
+
+
onClose
+
publicjavafx.beans.property.ObjectProperty<javafx.event.EventHandler<? super javafx.event.Event>>onCloseProperty
+
The property representing the user specified close handler.
+
+
Note that if you have also specified the ModalPane instance or CSS selector,
+ this handler will be executed after the default close handler. Therefore, you
+ can use it to perform arbitrary actions on dialog close.
Creates a ModalBox layout with the given children and binds
+ the close handler to a ModalPane via CSS selector. When user clicks
+ on the close button, it performs a ModalPane lookup via the specified
+ selector and calls the ModalPane.hide() method automatically.
+
+
Parameters:
+
selector - The ModalPane pane CSS selector.
+
children - The initial set of children for this pane.
Creates a ModalBox layout with the given children and binds
+ the close handler to a ModalPane. When user clicks on the close button,
+ it calls the ModalPane.hide() method automatically.
+
+
Parameters:
+
modalPane - The ModalPane pane CSS selector.
+
children - The initial set of children for this pane.
+
+
+
+
+
+
+
+
+
+
Method Details
+
+
+
+
addContent
+
publicvoidaddContent(javafx.scene.Node node)
+
Adds (prepends) specified node to the ModalBox before the close button.
+
+
Otherwise, if the added node takes up the full size of the ModalBox
+ and Node.isMouseTransparent() is false, then the close button
+ will not receive mouse events and therefore will not be clickable.
+
+
Parameters:
+
node - The node to be added.
+
+
+
+
+
+
close
+
publicvoidclose()
+
Manually closes the ModalBox in case one needs to use their
+ own close button.
+
+
+
+
+
createLayout
+
protectedvoidcreateLayout()
+
+
+
+
+
setCloseButtonPosition
+
protectedvoidsetCloseButtonPosition()
+
+
+
+
+
handleClose
+
protectedvoidhandleClose()
+
+
+
+
+
onCloseProperty
+
publicjavafx.beans.property.ObjectProperty<javafx.event.EventHandler<? super javafx.event.Event>>onCloseProperty()
+
The property representing the user specified close handler.
+
+
Note that if you have also specified the ModalPane instance or CSS selector,
+ this handler will be executed after the default close handler. Therefore, you
+ can use it to perform arbitrary actions on dialog close.
publicjavafx.event.EventHandler<? super javafx.event.Event>getOnClose()
+
Gets the value of the property onClose.
+
+
Property description:
+
The property representing the user specified close handler.
+
+
Note that if you have also specified the ModalPane instance or CSS selector,
+ this handler will be executed after the default close handler. Therefore, you
+ can use it to perform arbitrary actions on dialog close.
+
+
+
+
+
+
setOnClose
+
publicvoidsetOnClose(javafx.event.EventHandler<? super javafx.event.Event> onClose)
+
Sets the value of the property onClose.
+
+
Property description:
+
The property representing the user specified close handler.
+
+
Note that if you have also specified the ModalPane instance or CSS selector,
+ this handler will be executed after the default close handler. Therefore, you
+ can use it to perform arbitrary actions on dialog close.
Returns the path to the theme user-agent stylesheet in binary
+ (BSS) format. See Application.setUserAgentStylesheet(String) for more info.
+ All built-in themes are available in BSS format, but custom themes may not,
+ hence the method may return null value.
Returns the path to the theme user-agent stylesheet in binary
+ (BSS) format. See Application.setUserAgentStylesheet(String) for more info.
+ All built-in themes are available in BSS format, but custom themes may not,
+ hence the method may return null value.
Returns the path to the theme user-agent stylesheet in binary
+ (BSS) format. See Application.setUserAgentStylesheet(String) for more info.
+ All built-in themes are available in BSS format, but custom themes may not,
+ hence the method may return null value.
Returns the path to the theme user-agent stylesheet in binary
+ (BSS) format. See Application.setUserAgentStylesheet(String) for more info.
+ All built-in themes are available in BSS format, but custom themes may not,
+ hence the method may return null value.
Returns the path to the theme user-agent stylesheet in binary
+ (BSS) format. See Application.setUserAgentStylesheet(String) for more info.
+ All built-in themes are available in BSS format, but custom themes may not,
+ hence the method may return null value.
Returns the path to the theme user-agent stylesheet in binary
+ (BSS) format. See Application.setUserAgentStylesheet(String) for more info.
+ All built-in themes are available in BSS format, but custom themes may not,
+ hence the method may return null value.
Returns the path to the theme user-agent stylesheet in binary
+ (BSS) format. See Application.setUserAgentStylesheet(String) for more info.
+ All built-in themes are available in BSS format, but custom themes may not,
+ hence the method may return null value.
public staticvoidaddStyleClass(javafx.scene.Node node,
+ String styleClass,
+ String... excludes)
+
Adds the given style class to the node and removes the excluded classes.
+ This method is supposed to be used when only one from a set of classes
+ have to be present at once.
public staticvoidactivatePseudoClass(javafx.scene.Node node,
+ javafx.css.PseudoClass pseudoClass,
+ javafx.css.PseudoClass... excludes)
+
Activates given pseudo-class to the node and deactivates the excluded pseudo-classes.
+ This method is supposed to be used when only one from a set of pseudo-classes
+ have to be present at once.
public staticvoidappendStyle(javafx.scene.Node node,
+ String prop,
+ String value)
+
Appends CSS style declaration to the specified node.
+ There's no check for duplicates, so the CSS declarations with the same property
+ name can be appended multiple times.
+
+
Parameters:
+
node - The node to append the new style declaration.
Converts a CSS string to the Base64-encoded data URI. The resulting string is
+ an inline data URI that can be applied to any node in the following manner:
+
+
Returns the path to the theme user-agent stylesheet in binary
+ (BSS) format. See Application.setUserAgentStylesheet(String) for more info.
+ All built-in themes are available in BSS format, but custom themes may not,
+ hence the method may return null value.
+
+
+
+
+
isDarkMode
+
booleanisDarkMode()
+
Signifies whether the theme uses a light font on a dark background
+ or vise versa.
Contains extra style class names introduced to tweak some controls view
+ if and where it makes sense. The reason of supporting tweaks is to allow
+ users to write less CSS code.
Combines the rotateIn(Node, Duration) effect with the node’s downward
+ movement from the left, creating an animated entrance of the node from the top
+ left corner.
Combines the rotateIn(Node, Duration) effect with the node’s downward
+ movement from the right, creating an animated entrance of the node from the top
+ right corner.
Combines the rotateIn(Node, Duration) effect with the node’s upward
+ movement from the left, creating an animated entrance of the node from the
+ bottom left corner.
Combines the rotateIn(Node, Duration) effect with the node’s upward
+ movement from the right, creating an animated entrance of the node from the
+ bottom right corner.
Combines the rotateOut(Node, Duration) effect with the node’s downward
+ movement to the left, creating an animated exit of the node towards the bottom
+ left corner.
Combines the rotateOut(Node, Duration) effect with the node’s downward
+ movement to the right, creating an animated exit of the node towards the bottom
+ right corner.
Combines the rotateOut(Node, Duration) effect with the node’s upward
+ movement to the left, creating an animated exit of the node towards the top
+ left corner.
Combines the rotateOut(Node, Duration) effect with the node’s upward
+ movement to the right, creating an animated exit of the node towards the top
+ right corner.
Reduces the scale of the node, creating a shrinking effect that starts from
+ its original size and gradually zooms out to a smaller size, emphasizing
+ the node’s exit.
public staticjavafx.animation.TimelineshakeX(javafx.scene.Node node,
+ double offset)
+
Rapidly moves the node from side-to-side horizontally,
+ creating a shaking or vibrating effect.
+
+
Parameters:
+
node - The node to be animated.
+
offset - The shake offset.
+
+
+
+
+
+
shakeY
+
public staticjavafx.animation.TimelineshakeY(javafx.scene.Node node)
+
+
+
+
+
shakeY
+
public staticjavafx.animation.TimelineshakeY(javafx.scene.Node node,
+ double offset)
+
Rapidly moves the node up and down vertically, creating
+ a shaking or bouncing effect.
+
+
Parameters:
+
node - The node to be animated.
+
offset - The shake offset.
+
+
+
+
+
+
wobble
+
public staticjavafx.animation.Timelinewobble(javafx.scene.Node node)
+
Causes the node to rapidly wobble back and forth,
+ creating a visually engaging effect.
+
+
Parameters:
+
node - The node to be animated.
+
+
+
+
+
+
fadeIn
+
public staticjavafx.animation.TimelinefadeIn(javafx.scene.Node node,
+ javafx.util.Duration duration)
+
Gradually increases the opacity of the node from 0 to 1,
+ making it appear on the scene with a fading-in effect.
+
+
Parameters:
+
node - The node to be animated.
+
duration - The animation duration.
+
+
+
+
+
+
fadeOut
+
public staticjavafx.animation.TimelinefadeOut(javafx.scene.Node node,
+ javafx.util.Duration duration)
+
Gradually decreases the opacity of the node from 1 to 0,
+ making it disappear from the scene with a fading-out effect.
+
+
Parameters:
+
node - The node to be animated.
+
duration - The animation duration.
+
+
+
+
+
+
fadeInDown
+
public staticjavafx.animation.TimelinefadeInDown(javafx.scene.Node node,
+ javafx.util.Duration duration)
+
Combines the fadeIn(Node, Duration) effect with the node’s downward
+ movement, creating an animated entrance of the node from the top.
+
+
Parameters:
+
node - The node to be animated.
+
duration - The animation duration.
+
+
+
+
+
+
fadeOutDown
+
public staticjavafx.animation.TimelinefadeOutDown(javafx.scene.Node node,
+ javafx.util.Duration duration)
+
Combines the fadeOut(Node, Duration) effect with the node’s downward
+ movement, creating an animated exit of the node to the bottom.
+
+
Parameters:
+
node - The node to be animated.
+
duration - The animation duration.
+
+
+
+
+
+
fadeInLeft
+
public staticjavafx.animation.TimelinefadeInLeft(javafx.scene.Node node,
+ javafx.util.Duration duration)
+
Combines the fadeIn(Node, Duration) effect with the node’s leftward
+ movement, creating an animated entrance of the node from the left.
+
+
Parameters:
+
node - The node to be animated.
+
duration - The animation duration.
+
+
+
+
+
+
fadeOutLeft
+
public staticjavafx.animation.TimelinefadeOutLeft(javafx.scene.Node node,
+ javafx.util.Duration duration)
+
Combines the fadeOut(Node, Duration) effect with the node’s leftward
+ movement, creating an animated exit of the node to the left.
+
+
Parameters:
+
node - The node to be animated.
+
duration - The animation duration.
+
+
+
+
+
+
fadeInRight
+
public staticjavafx.animation.TimelinefadeInRight(javafx.scene.Node node,
+ javafx.util.Duration duration)
+
Combines the fadeIn(Node, Duration) effect with the node’s rightward
+ movement, creating an animated entrance of the node from the right.
+
+
Parameters:
+
node - The node to be animated.
+
duration - The animation duration.
+
+
+
+
+
+
fadeOutRight
+
public staticjavafx.animation.TimelinefadeOutRight(javafx.scene.Node node,
+ javafx.util.Duration duration)
+
Combines the fadeOut(Node, Duration) effect with the node’s rightward
+ movement, creating an animated exit of the node to the right.
+
+
Parameters:
+
node - The node to be animated.
+
duration - The animation duration.
+
+
+
+
+
+
fadeInUp
+
public staticjavafx.animation.TimelinefadeInUp(javafx.scene.Node node,
+ javafx.util.Duration duration)
+
Combines the fadeIn(Node, Duration) effect with the node’s upward
+ movement, creating an animated entrance of the node from the bottom.
+
+
Parameters:
+
node - The node to be animated.
+
duration - The animation duration.
+
+
+
+
+
+
fadeOutUp
+
public staticjavafx.animation.TimelinefadeOutUp(javafx.scene.Node node,
+ javafx.util.Duration duration)
+
Combines the fadeOut(Node, Duration) effect with the node’s upward
+ movement, creating an animated exit of the node to the top.
+
+
Parameters:
+
node - The node to be animated.
+
duration - The animation duration.
+
+
+
+
+
+
rollIn
+
public staticjavafx.animation.TimelinerollIn(javafx.scene.Node node,
+ javafx.util.Duration duration)
+
Applies an animated effect to the node causing it to roll into
+ the scene from the left side at an angle.
+
+
Parameters:
+
node - The node to be animated.
+
duration - The animation duration.
+
+
+
+
+
+
rollOut
+
public staticjavafx.animation.TimelinerollOut(javafx.scene.Node node,
+ javafx.util.Duration duration)
+
Applies an animated effect to the node causing it to roll out
+ from the scene to the right side at an angle.
+
+
Parameters:
+
node - The node to be animated.
+
duration - The animation duration.
+
+
+
+
+
+
rotateIn
+
public staticjavafx.animation.TimelinerotateIn(javafx.scene.Node node,
+ javafx.util.Duration duration)
+
Rotates the node and gradually increases its opacity,
+ giving it an animated entrance effect.
+
+
Parameters:
+
node - The node to be animated.
+
duration - The animation duration.
+
+
+
+
+
+
rotateOut
+
public staticjavafx.animation.TimelinerotateOut(javafx.scene.Node node,
+ javafx.util.Duration duration)
+
Rotates the node and gradually decreases its opacity,
+ giving it an animated exit effect.
+
+
Parameters:
+
node - The node to be animated.
+
duration - The animation duration.
+
+
+
+
+
+
rotateInDownLeft
+
public staticjavafx.animation.TimelinerotateInDownLeft(javafx.scene.Node node,
+ javafx.util.Duration duration)
+
Combines the rotateIn(Node, Duration) effect with the node’s downward
+ movement from the left, creating an animated entrance of the node from the top
+ left corner.
+
+
Parameters:
+
node - The node to be animated.
+
duration - The animation duration.
+
+
+
+
+
+
rotateOutDownLeft
+
public staticjavafx.animation.TimelinerotateOutDownLeft(javafx.scene.Node node,
+ javafx.util.Duration duration)
+
Combines the rotateOut(Node, Duration) effect with the node’s downward
+ movement to the left, creating an animated exit of the node towards the bottom
+ left corner.
+
+
Parameters:
+
node - The node to be animated.
+
duration - The animation duration.
+
+
+
+
+
+
rotateInDownRight
+
public staticjavafx.animation.TimelinerotateInDownRight(javafx.scene.Node node,
+ javafx.util.Duration duration)
+
Combines the rotateIn(Node, Duration) effect with the node’s downward
+ movement from the right, creating an animated entrance of the node from the top
+ right corner.
+
+
Parameters:
+
node - The node to be animated.
+
duration - The animation duration.
+
+
+
+
+
+
rotateOutDownRight
+
public staticjavafx.animation.TimelinerotateOutDownRight(javafx.scene.Node node,
+ javafx.util.Duration duration)
+
Combines the rotateOut(Node, Duration) effect with the node’s downward
+ movement to the right, creating an animated exit of the node towards the bottom
+ right corner.
+
+
Parameters:
+
node - The node to be animated.
+
duration - The animation duration.
+
+
+
+
+
+
rotateInUpLeft
+
public staticjavafx.animation.TimelinerotateInUpLeft(javafx.scene.Node node,
+ javafx.util.Duration duration)
+
Combines the rotateIn(Node, Duration) effect with the node’s upward
+ movement from the left, creating an animated entrance of the node from the
+ bottom left corner.
+
+
Parameters:
+
node - The node to be animated.
+
duration - The animation duration.
+
+
+
+
+
+
rotateOutUpLeft
+
public staticjavafx.animation.TimelinerotateOutUpLeft(javafx.scene.Node node,
+ javafx.util.Duration duration)
+
Combines the rotateOut(Node, Duration) effect with the node’s upward
+ movement to the left, creating an animated exit of the node towards the top
+ left corner.
+
+
Parameters:
+
node - The node to be animated.
+
duration - The animation duration.
+
+
+
+
+
+
rotateInUpRight
+
public staticjavafx.animation.TimelinerotateInUpRight(javafx.scene.Node node,
+ javafx.util.Duration duration)
+
Combines the rotateIn(Node, Duration) effect with the node’s upward
+ movement from the right, creating an animated entrance of the node from the
+ bottom right corner.
+
+
Parameters:
+
node - The node to be animated.
+
duration - The animation duration.
+
+
+
+
+
+
rotateOutUpRight
+
public staticjavafx.animation.TimelinerotateOutUpRight(javafx.scene.Node node,
+ javafx.util.Duration duration)
+
Combines the rotateOut(Node, Duration) effect with the node’s upward
+ movement to the right, creating an animated exit of the node towards the top
+ right corner.
+
+
Parameters:
+
node - The node to be animated.
+
duration - The animation duration.
+
+
+
+
+
+
slideInDown
+
public staticjavafx.animation.TimelineslideInDown(javafx.scene.Node node,
+ javafx.util.Duration duration)
+
Applies an animated effect to the node, causing it to slide into view
+ from the top side.
+
+
Parameters:
+
node - The node to be animated.
+
duration - The animation duration.
+
+
+
+
+
+
slideOutDown
+
public staticjavafx.animation.TimelineslideOutDown(javafx.scene.Node node,
+ javafx.util.Duration duration)
+
Applies an animated effect to the node, causing it to slide out of view
+ through the bottom side.
+
+
Parameters:
+
node - The node to be animated.
+
duration - The animation duration.
+
+
+
+
+
+
slideInLeft
+
public staticjavafx.animation.TimelineslideInLeft(javafx.scene.Node node,
+ javafx.util.Duration duration)
+
Applies an animated effect to the node, causing it to slide into view
+ from the left side.
+
+
Parameters:
+
node - The node to be animated.
+
duration - The animation duration.
+
+
+
+
+
+
slideOutLeft
+
public staticjavafx.animation.TimelineslideOutLeft(javafx.scene.Node node,
+ javafx.util.Duration duration)
+
Applies an animated effect to the node, causing it to slide out of view
+ through the left side.
+
+
Parameters:
+
node - The node to be animated.
+
duration - The animation duration.
+
+
+
+
+
+
slideInRight
+
public staticjavafx.animation.TimelineslideInRight(javafx.scene.Node node,
+ javafx.util.Duration duration)
+
Applies an animated effect to the node, causing it to slide into view
+ from the right side.
+
+
Parameters:
+
node - The node to be animated.
+
duration - The animation duration.
+
+
+
+
+
+
slideOutRight
+
public staticjavafx.animation.TimelineslideOutRight(javafx.scene.Node node,
+ javafx.util.Duration duration)
+
Applies an animated effect to the node, causing it to slide out of view
+ through the right side.
+
+
Parameters:
+
node - The node to be animated.
+
duration - The animation duration.
+
+
+
+
+
+
slideInUp
+
public staticjavafx.animation.TimelineslideInUp(javafx.scene.Node node,
+ javafx.util.Duration duration)
+
Applies an animated effect to the node, causing it to slide into view
+ from the bottom side.
+
+
Parameters:
+
node - The node to be animated.
+
duration - The animation duration.
+
+
+
+
+
+
slideOutUp
+
public staticjavafx.animation.TimelineslideOutUp(javafx.scene.Node node,
+ javafx.util.Duration duration)
+
Applies an animated effect to the node, causing it to slide out of view
+ through the top side.
+
+
Parameters:
+
node - The node to be animated.
+
duration - The animation duration.
+
+
+
+
+
+
zoomIn
+
public staticjavafx.animation.TimelinezoomIn(javafx.scene.Node node,
+ javafx.util.Duration duration)
public staticjavafx.animation.TimelinezoomOut(javafx.scene.Node node,
+ javafx.util.Duration duration,
+ double endValue)
+
Reduces the scale of the node, creating a shrinking effect that starts from
+ its original size and gradually zooms out to a smaller size, emphasizing
+ the node’s exit.
Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
While parsing all created nodes will be added to the given root container.
+ The container choice depends on the actual markup. Default constructor accepts any
+ Pane or its descendant. Using theTextFlow for text-only markup
+ (no block nodes) and VBox otherwise, is recommended.
+
+
Supported tags
+
+ Bold Text : text : [b]{text}[/b]
+ Italic Text : text : [i]{text}[/i]
+ Underlined Text : text : [u]{text}[/u]
+ Strikethrough Text : text : [s]{text}[/s]
+ Font Color : text : [color={color}]{text}[/color]
+ Font Family : text : [font={monospace}]{text}[/font]
+ Font Size : text : [size={size}]{text}[/size]
+ Link : text : [url={url}]{text}[/url]
+ [url url={url} class={class}]{text}[/url]
+ Email : text : [email]{text}[/email]
+ [email email={url} class={class}]{text}[/email]
+ Style : text : [style={style}]{text}[/style]
+ Subscript : text : [sub]{text}[/sub]
+ Superscript : text : [sup]{text}[/sup]
+ Heading : text : [heading]{text}[/heading]
+ [heading={level}]{text}[/heading]
+ Code : text : [code]{text}[/code]
+ [code={class}]{text}[/code]
+ Span : text : [span]{text}[/span]
+ [span={class}]{text}[/span]
+ [span style={style} class={class}]{text}[/span]
+ Label : text : [label]{text}[/label]
+ [label={class}]{text}[/label]
+ [label style={style} class={class}]{text}[/label]
+ Caption Text : text : [caption]{text}[/caption]
+ Small Text : text : [small]{text}[/small]
+ Abbreviation : text : [abbr="tooltip text"]{text}[/abbr]
+ Unordered List : block : [ul]
+ [li]Entry 1[/li]
+ [li]Entry 2[/li]
+ [/ul]
+ [ul={bullet character}]
+ [li]Entry 1[/li]
+ [li]Entry 2[/li]
+ [/ul]
+ Ordered List : block : [ol]
+ [li]Entry 1[/li]
+ [li]Entry 2[/li]
+ [/ol]
+ [ol={start number or letter}]
+ [li]Entry 1[/li]
+ [li]Entry 2[/li]
+ [/ol]
+ Alignment : block : [left]{content}[/left]
+ [center]{content}[/center]
+ [right]{content}[/right]
+ [align={javafx.geometry.Pos}]{content}[/align]
+ Indentation : block : [indent]{content}[/indent]
+ [indent=level]{content}[/indent]
+ Horizontal Rule : block : [hr/]
+ [hr=thickness/]
+
+
+
+
If a tag param contains whitespaces or trailing slash is must be
+ enclosed in double or single quotes.
+
If a tag only has a single param, it can be shortened to the
+ [name=value]{text}[/name]. In this case the tag param name
+ considered to be equal to the tag name.
+
Unknown tag params will be ignored.
+
+
+
Action Events
+ Some nodes, e.g. Hyperlink require action handlers. To avoid traversing
+ the root container's node graph you can add an event filter.
+
+
+ var input = "Visit the [url=https://example.com]website[/url].";
+ var textFlow = BBCodeParser.createLayout(input);
+ textFlow.addEventFilter(ActionEvent.ACTION, e-> {
+ if (e.getTarget() instanceof Hyperlink link) {
+ openURL(link.getUserData());
+ }
+ e.consume();
+ });
+
+
+
+
+
+
+
+
Nested Class Summary
+
+
Nested classes/interfaces inherited from interface atlantafx.base.util.BBCodeHandler
Returns the enum constant of this class with the specified name.
+The string must match exactly an identifier used to declare an
+enum constant in this class. (Extraneous whitespace characters are
+not permitted.)
+
+
Parameters:
+
name - the name of the enum constant to be returned.
Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
A simple push parser for the BBCode markup.
+ As the content is parsed, methods of BBCodeHandler are called.
+
+
The parser doesn't impose restrictions on tag names or tag params.
+ It's a handler implementation responsibility to differentiate supported
+ tags from unsupported and so to for the tag params. This allows user to utilize
+ arbitrary tags or params without changing the parser behaviour. The parser,
+ however, verifies that each opening tag has the matching closing tag.
+
+
If parsing is failed due to invalid input an IllegalStateException
+ will be thrown.
public class DoubleStringConverter
+extends javafx.util.StringConverter<Double>
+
Converts between user-edited strings and Double values.
+
+
Accepts an optional Runnable that resets the editor on NumberFormatException,
+ or a TextField or Spinner that is preemptively monitored for invalid input
+ during typing, and restricts valid input to a specified range when committed.
+
+
This implementation shows up to two decimal digits, but only if a fractional part
+ exists. The default implementation always shows one decimal digit which hinders typing.
Creates a DoubleStringConverter with the specified input range.
+
+
Preemptively monitors input to reject any invalid characters during
+ typing. Restricts input to [min, max] (inclusive) when
+ valid text is committed, and resets input to the closest value to zero
+ within [min, max] when invalid text is committed.
+
+
Parameters:
+
input - The TextField providing user-edited strings.
Creates a DoubleStringConverter for the specified Spinner.
+
+
Uses the TextField and minimum and maximum values of the specified
+ Spinner for construction, and also sets the new DoubleStringConverter
+ on its SpinnerValueFactory.DoubleSpinnerValueFactory.
+
+
Parameters:
+
spinner - The Spinner to create a DoubleStringConverter for.
Specify null to clear a previously set Runnable. When creating
+ a DoubleStringConverter for a TextField or Spinner, this callback is
+ automatically defined to reset committed invalid input to the closest value
+ to zero within the legal range. Setting a different callback will overwrite this
+ functionality.
+
+
Parameters:
+
reset - The Runnable to call upon NumberFormatException.
Converts the specified string into its double value.
+ A null, empty, or otherwise invalid argument returns zero
+ and also executes the editor reset callback, if any.
+
+
Specified by:
+
fromString in class javafx.util.StringConverter<Double>
public class IntegerStringConverter
+extends javafx.util.StringConverter<Integer>
+
Converts between user-edited strings and integer values.
+
+
Accepts an optional Runnable that resets the editor on NumberFormatException,
+ or a TextField or Spinner that is preemptively monitored for invalid
+ input during typing, and restricts valid input to a specified range when committed.
Creates an IntegerStringConverter with an editor reset callback.
+ Specifying null has the same effect as the default constructor.
+
+
Parameters:
+
reset - The Runnable to call upon NumberFormatException.
+
+
+
+
+
+
IntegerStringConverter
+
publicIntegerStringConverter(javafx.scene.control.TextField input,
+ int min,
+ int max)
+
Creates an IntegerStringConverter with the specified input range.
+
+
Preemptively monitors input to reject any invalid characters during
+ typing, restricts input to [min, max] (inclusive) when
+ valid text is committed, and resets input to the closest value to zero
+ within [min, max] when invalid text is committed.
+
+
Parameters:
+
input - The TextField providing user-edited strings.
Creates an IntegerStringConverter for the specified Spinner.
+ Uses the TextField and minimum and maximum values of the specified
+ Spinner for construction, and also sets the new IntegerStringConverter
+ on its SpinnerValueFactory.IntegerSpinnerValueFactory.
+
+
Parameters:
+
spinner - The Spinner to create an IntegerStringConverter for.
Specify null to clear a previously set Runnable. When creating
+ an IntegerStringConverter for a TextField or Spinner, this callback is
+ automatically defined to reset committed invalid input to the closest value
+ to zero within the legal range. Setting a different callback will overwrite
+ this functionality.
+
+
Parameters:
+
reset - The Runnable to call upon NumberFormatException.
Converts the specified string into its integer value.
+ A null, empty, or otherwise invalid argument returns zero
+ and also executes the editor reset callback, if any.
+
+
Specified by:
+
fromString in class javafx.util.StringConverter<Integer>
Corrects the replaced text. For any replaced character it checks whether it matches
+ the mask character at the same position and applies MaskChar.transform(char).
+ if true. If not, returns null, thus signifying that added text is not valid.
Corrects added text. For any input character it checks whether it matches
+ the mask character at the same position and applies MaskChar.transform(char).
+ if true. If not, returns null, thus signifying that added text is not valid.
public class MaskTextFormatter
+extends javafx.scene.control.TextFormatter<String>
+
A TextFormatter that can restrict the user input by applying a position-based mask.
+ It works for the editing cases when the input string has a fixed length and each character
+ can be restricted based on its position.
+
+
Input Mask
+ You can specify an input mask either as a string of the predefined characters or as a list of
+ MaskChar, including your own implementation if you're not satisfied with the default
+ SimpleMaskChar, e.g. if you want to override the placeholder character.
+ The pre-defined mask characters are:
+
+
A - ASCII alphabetic character: [a-zA-Z].
+
N - ASCII alphanumeric character: [a-zA-Z0-9].
+
X - any character except spaces.
+
H - hexadecimal character: [a-fA-F0-9].
+
D - any digit except zero: [1-9].
+
9 - any digit required: [0-9].
+
8..1 - any digit from 0 to that number, respectively.
+
0 - zero only.
+
+
+
Behavior
+ Any TextField with MaskTextFormatter applied shows a placeholder
+ mask by default. This is basically the input mask with all mask characters replaced
+ with the MaskChar.getPlaceholder() character.
+
+
The behavior changes if you set the TextInputControl.promptTextProperty().
+ In that case placeholder mask is only displayed when TextField gets focus and
+ will be hidden after focus lost. So, the placeholder mask is always displayed when focus
+ is set to the TextField.
+
+
You can replace the placeholder mask with any sensible default simply by changing initial
+ TextField text to any string that is valid against the input mask.
+
+
The caret will be positioned before the first not fixed character (see MaskChar.isFixed())
+ starting from the beginning of the input mask.
+
+
Validation
+ Validation is out of the MaskTextFormatter scope. E.g. if one can use "29:59"
+ to restrict time picker input then "27:30" would be a valid input, but obviously an
+ invalid time. Moreover, remember that partial input like this "22:_9" is also possible.
+ Input mask is supposed to assist and guide user input, but can barely cancel the validation
+ completely.
+
+
+
+
+
+
+
Property Summary
+
+
Properties inherited from class javafx.scene.control.TextFormatter
+Starting from the Overview page, you can browse the documentation using the links in each page, and in the navigation bar at the top of each page. The Index and Search box allow you to navigate to specific declarations and summary pages, including: All Packages, All Classes and Interfaces
+
+
Search
+
You can search for definitions of modules, packages, types, fields, methods, system properties and other terms defined in the API, using some or all of the name, optionally using "camelCase" abbreviations. For example:
+
+
j.l.obj will match "java.lang.Object"
+
InpStr will match "java.io.InputStream"
+
HM.cK will match "java.util.HashMap.containsKey(Object)"
+The following sections describe the different kinds of pages in this collection.
+
+
Module
+
Each module has a page that contains a list of its packages, dependencies on other modules, and services, with a summary for each. These pages may contain the following categories:
+
+
Packages
+
Modules
+
Services
+
+
+
+
Package
+
Each package has a page that contains a list of its classes and interfaces, with a summary for each. These pages may contain the following categories:
+
+
Interfaces
+
Classes
+
Enum Classes
+
Exceptions
+
Errors
+
Annotation Interfaces
+
+
+
+
Class or Interface
+
Each class, interface, nested class and nested interface has its own separate page. Each of these pages has three sections consisting of a declaration and description, member summary tables, and detailed member descriptions. Entries in each of these sections are omitted if they are empty or not applicable.
+
+
Class Inheritance Diagram
+
Direct Subclasses
+
All Known Subinterfaces
+
All Known Implementing Classes
+
Class or Interface Declaration
+
Class or Interface Description
+
+
+
+
Nested Class Summary
+
Enum Constant Summary
+
Field Summary
+
Property Summary
+
Constructor Summary
+
Method Summary
+
Required Element Summary
+
Optional Element Summary
+
+
+
+
Enum Constant Details
+
Field Details
+
Property Details
+
Constructor Details
+
Method Details
+
Element Details
+
+
Note: Annotation interfaces have required and optional elements, but not methods. Only enum classes have enum constants. The components of a record class are displayed as part of the declaration of the record class. Properties are a feature of JavaFX.
+
The summary entries are alphabetical, while the detailed descriptions are in the order they appear in the source code. This preserves the logical groupings established by the programmer.
+
+
+
Other Files
+
Packages and modules may contain pages with additional information related to the declarations nearby.
+
+
+
Use
+
Each documented package, class and interface has its own Use page. This page describes what packages, classes, methods, constructors and fields use any part of the given class or package. Given a class or interface A, its Use page includes subclasses of A, fields declared as A, methods that return A, and methods and constructors with parameters of type A. You can access this page by first going to the package, class or interface, then clicking on the USE link in the navigation bar.
+
+
+
Tree (Class Hierarchy)
+
There is a Class Hierarchy page for all packages, plus a hierarchy for each package. Each hierarchy page contains a list of classes and a list of interfaces. Classes are organized by inheritance structure starting with java.lang.Object. Interfaces do not inherit from java.lang.Object.
+
+
When viewing the Overview page, clicking on TREE displays the hierarchy for all packages.
+
When viewing a particular package, class or interface page, clicking on TREE displays the hierarchy for only that package.
Each serializable or externalizable class has a description of its serialization fields and methods. This information is of interest to those who implement rather than use the API. While there is no link in the navigation bar, you can get to this information by going to any serialized class and clicking "Serialized Form" in the "See Also" section of the class description.
+
+
+
All Packages
+
The All Packages page contains an alphabetic index of all packages contained in the documentation.
+
+
+
All Classes and Interfaces
+
The All Classes and Interfaces page contains an alphabetic index of all classes and interfaces contained in the documentation, including annotation interfaces, enum classes, and record classes.
+
+
+
Index
+
The Index contains an alphabetic index of all classes, interfaces, constructors, methods, and fields in the documentation, as well as summary pages such as All Packages, All Classes and Interfaces.
+
+
+
+This help file applies to API documentation generated by the standard doclet.
+
+
Base implementation class for defining the visual representation of user
+ interface controls that need to handle platform events and therefore can take
+ advantage of using the Behavior API.
A base class for people wanting to customize a TextField
+ to contain nodes inside the text field itself, without being on top
+ of the users typed-in text.
Combines the Animations.rotateIn(Node, Duration) effect with the node’s downward
+ movement from the left, creating an animated entrance of the node from the top
+ left corner.
Combines the Animations.rotateIn(Node, Duration) effect with the node’s downward
+ movement from the right, creating an animated entrance of the node from the top
+ right corner.
Combines the Animations.rotateIn(Node, Duration) effect with the node’s upward
+ movement from the left, creating an animated entrance of the node from the
+ bottom left corner.
Combines the Animations.rotateIn(Node, Duration) effect with the node’s upward
+ movement from the right, creating an animated entrance of the node from the
+ bottom right corner.
Combines the Animations.rotateOut(Node, Duration) effect with the node’s downward
+ movement to the left, creating an animated exit of the node towards the bottom
+ left corner.
Combines the Animations.rotateOut(Node, Duration) effect with the node’s downward
+ movement to the right, creating an animated exit of the node towards the bottom
+ right corner.
Combines the Animations.rotateOut(Node, Duration) effect with the node’s upward
+ movement to the left, creating an animated exit of the node towards the top
+ left corner.
Combines the Animations.rotateOut(Node, Duration) effect with the node’s upward
+ movement to the right, creating an animated exit of the node towards the top
+ right corner.
+
+
ROUNDED - Static variable in class atlantafx.base.theme.Styles
Reduces the scale of the node, creating a shrinking effect that starts from
+ its original size and gradually zooms out to a smaller size, emphasizing
+ the node’s exit.
+
+
+
diff --git a/apidocs/jquery-ui.overrides.css b/apidocs/jquery-ui.overrides.css
new file mode 100644
index 0000000..facf852
--- /dev/null
+++ b/apidocs/jquery-ui.overrides.css
@@ -0,0 +1,35 @@
+/*
+ * Copyright (c) 2020, 2022, Oracle and/or its affiliates. All rights reserved.
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * This code is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License version 2 only, as
+ * published by the Free Software Foundation. Oracle designates this
+ * particular file as subject to the "Classpath" exception as provided
+ * by Oracle in the LICENSE file that accompanied this code.
+ *
+ * This code is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
+ * version 2 for more details (a copy is included in the LICENSE file that
+ * accompanied this code).
+ *
+ * You should have received a copy of the GNU General Public License version
+ * 2 along with this work; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
+ *
+ * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
+ * or visit www.oracle.com if you need additional information or have any
+ * questions.
+ */
+
+.ui-state-active,
+.ui-widget-content .ui-state-active,
+.ui-widget-header .ui-state-active,
+a.ui-button:active,
+.ui-button:active,
+.ui-button.ui-state-active:hover {
+ /* Overrides the color of selection used in jQuery UI */
+ background: #F8981D;
+ border: 1px solid #F8981D;
+}
diff --git a/apidocs/legal/ADDITIONAL_LICENSE_INFO b/apidocs/legal/ADDITIONAL_LICENSE_INFO
new file mode 100644
index 0000000..ff700cd
--- /dev/null
+++ b/apidocs/legal/ADDITIONAL_LICENSE_INFO
@@ -0,0 +1,37 @@
+ ADDITIONAL INFORMATION ABOUT LICENSING
+
+Certain files distributed by Oracle America, Inc. and/or its affiliates are
+subject to the following clarification and special exception to the GPLv2,
+based on the GNU Project exception for its Classpath libraries, known as the
+GNU Classpath Exception.
+
+Note that Oracle includes multiple, independent programs in this software
+package. Some of those programs are provided under licenses deemed
+incompatible with the GPLv2 by the Free Software Foundation and others.
+For example, the package includes programs licensed under the Apache
+License, Version 2.0 and may include FreeType. Such programs are licensed
+to you under their original licenses.
+
+Oracle facilitates your further distribution of this package by adding the
+Classpath Exception to the necessary parts of its GPLv2 code, which permits
+you to use that code in combination with other independent modules not
+licensed under the GPLv2. However, note that this would not permit you to
+commingle code under an incompatible license with Oracle's GPLv2 licensed
+code by, for example, cutting and pasting such code into a file also
+containing Oracle's GPLv2 licensed code and then distributing the result.
+
+Additionally, if you were to remove the Classpath Exception from any of the
+files to which it applies and distribute the result, you would likely be
+required to license some or all of the other code in that distribution under
+the GPLv2 as well, and since the GPLv2 is incompatible with the license terms
+of some items included in the distribution by Oracle, removing the Classpath
+Exception could therefore effectively compromise your ability to further
+distribute the package.
+
+Failing to distribute notices associated with some files may also create
+unexpected legal consequences.
+
+Proceed with caution and we recommend that you obtain the advice of a lawyer
+skilled in open source matters before removing the Classpath Exception or
+making modifications to this package which may subsequently be redistributed
+and/or involve the use of third party software.
diff --git a/apidocs/legal/ASSEMBLY_EXCEPTION b/apidocs/legal/ASSEMBLY_EXCEPTION
new file mode 100644
index 0000000..065b8d9
--- /dev/null
+++ b/apidocs/legal/ASSEMBLY_EXCEPTION
@@ -0,0 +1,27 @@
+
+OPENJDK ASSEMBLY EXCEPTION
+
+The OpenJDK source code made available by Oracle America, Inc. (Oracle) at
+openjdk.java.net ("OpenJDK Code") is distributed under the terms of the GNU
+General Public License version 2
+only ("GPL2"), with the following clarification and special exception.
+
+ Linking this OpenJDK Code statically or dynamically with other code
+ is making a combined work based on this library. Thus, the terms
+ and conditions of GPL2 cover the whole combination.
+
+ As a special exception, Oracle gives you permission to link this
+ OpenJDK Code with certain code licensed by Oracle as indicated at
+ http://openjdk.java.net/legal/exception-modules-2007-05-08.html
+ ("Designated Exception Modules") to produce an executable,
+ regardless of the license terms of the Designated Exception Modules,
+ and to copy and distribute the resulting executable under GPL2,
+ provided that the Designated Exception Modules continue to be
+ governed by the licenses under which they were offered by Oracle.
+
+As such, it allows licensees and sublicensees of Oracle's GPL2 OpenJDK Code
+to build an executable that includes those portions of necessary code that
+Oracle could not provide under GPL2 (or that Oracle has provided under GPL2
+with the Classpath exception). If you modify or add to the OpenJDK code,
+that new GPL2 code may still be combined with Designated Exception Modules
+if the new code is made subject to this exception by its copyright holder.
diff --git a/apidocs/legal/LICENSE b/apidocs/legal/LICENSE
new file mode 100644
index 0000000..8b400c7
--- /dev/null
+++ b/apidocs/legal/LICENSE
@@ -0,0 +1,347 @@
+The GNU General Public License (GPL)
+
+Version 2, June 1991
+
+Copyright (C) 1989, 1991 Free Software Foundation, Inc.
+51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+
+Everyone is permitted to copy and distribute verbatim copies of this license
+document, but changing it is not allowed.
+
+Preamble
+
+The licenses for most software are designed to take away your freedom to share
+and change it. By contrast, the GNU General Public License is intended to
+guarantee your freedom to share and change free software--to make sure the
+software is free for all its users. This General Public License applies to
+most of the Free Software Foundation's software and to any other program whose
+authors commit to using it. (Some other Free Software Foundation software is
+covered by the GNU Library General Public License instead.) You can apply it to
+your programs, too.
+
+When we speak of free software, we are referring to freedom, not price. Our
+General Public Licenses are designed to make sure that you have the freedom to
+distribute copies of free software (and charge for this service if you wish),
+that you receive source code or can get it if you want it, that you can change
+the software or use pieces of it in new free programs; and that you know you
+can do these things.
+
+To protect your rights, we need to make restrictions that forbid anyone to deny
+you these rights or to ask you to surrender the rights. These restrictions
+translate to certain responsibilities for you if you distribute copies of the
+software, or if you modify it.
+
+For example, if you distribute copies of such a program, whether gratis or for
+a fee, you must give the recipients all the rights that you have. You must
+make sure that they, too, receive or can get the source code. And you must
+show them these terms so they know their rights.
+
+We protect your rights with two steps: (1) copyright the software, and (2)
+offer you this license which gives you legal permission to copy, distribute
+and/or modify the software.
+
+Also, for each author's protection and ours, we want to make certain that
+everyone understands that there is no warranty for this free software. If the
+software is modified by someone else and passed on, we want its recipients to
+know that what they have is not the original, so that any problems introduced
+by others will not reflect on the original authors' reputations.
+
+Finally, any free program is threatened constantly by software patents. We
+wish to avoid the danger that redistributors of a free program will
+individually obtain patent licenses, in effect making the program proprietary.
+To prevent this, we have made it clear that any patent must be licensed for
+everyone's free use or not licensed at all.
+
+The precise terms and conditions for copying, distribution and modification
+follow.
+
+TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+0. This License applies to any program or other work which contains a notice
+placed by the copyright holder saying it may be distributed under the terms of
+this General Public License. The "Program", below, refers to any such program
+or work, and a "work based on the Program" means either the Program or any
+derivative work under copyright law: that is to say, a work containing the
+Program or a portion of it, either verbatim or with modifications and/or
+translated into another language. (Hereinafter, translation is included
+without limitation in the term "modification".) Each licensee is addressed as
+"you".
+
+Activities other than copying, distribution and modification are not covered by
+this License; they are outside its scope. The act of running the Program is
+not restricted, and the output from the Program is covered only if its contents
+constitute a work based on the Program (independent of having been made by
+running the Program). Whether that is true depends on what the Program does.
+
+1. You may copy and distribute verbatim copies of the Program's source code as
+you receive it, in any medium, provided that you conspicuously and
+appropriately publish on each copy an appropriate copyright notice and
+disclaimer of warranty; keep intact all the notices that refer to this License
+and to the absence of any warranty; and give any other recipients of the
+Program a copy of this License along with the Program.
+
+You may charge a fee for the physical act of transferring a copy, and you may
+at your option offer warranty protection in exchange for a fee.
+
+2. You may modify your copy or copies of the Program or any portion of it, thus
+forming a work based on the Program, and copy and distribute such modifications
+or work under the terms of Section 1 above, provided that you also meet all of
+these conditions:
+
+ a) You must cause the modified files to carry prominent notices stating
+ that you changed the files and the date of any change.
+
+ b) You must cause any work that you distribute or publish, that in whole or
+ in part contains or is derived from the Program or any part thereof, to be
+ licensed as a whole at no charge to all third parties under the terms of
+ this License.
+
+ c) If the modified program normally reads commands interactively when run,
+ you must cause it, when started running for such interactive use in the
+ most ordinary way, to print or display an announcement including an
+ appropriate copyright notice and a notice that there is no warranty (or
+ else, saying that you provide a warranty) and that users may redistribute
+ the program under these conditions, and telling the user how to view a copy
+ of this License. (Exception: if the Program itself is interactive but does
+ not normally print such an announcement, your work based on the Program is
+ not required to print an announcement.)
+
+These requirements apply to the modified work as a whole. If identifiable
+sections of that work are not derived from the Program, and can be reasonably
+considered independent and separate works in themselves, then this License, and
+its terms, do not apply to those sections when you distribute them as separate
+works. But when you distribute the same sections as part of a whole which is a
+work based on the Program, the distribution of the whole must be on the terms
+of this License, whose permissions for other licensees extend to the entire
+whole, and thus to each and every part regardless of who wrote it.
+
+Thus, it is not the intent of this section to claim rights or contest your
+rights to work written entirely by you; rather, the intent is to exercise the
+right to control the distribution of derivative or collective works based on
+the Program.
+
+In addition, mere aggregation of another work not based on the Program with the
+Program (or with a work based on the Program) on a volume of a storage or
+distribution medium does not bring the other work under the scope of this
+License.
+
+3. You may copy and distribute the Program (or a work based on it, under
+Section 2) in object code or executable form under the terms of Sections 1 and
+2 above provided that you also do one of the following:
+
+ a) Accompany it with the complete corresponding machine-readable source
+ code, which must be distributed under the terms of Sections 1 and 2 above
+ on a medium customarily used for software interchange; or,
+
+ b) Accompany it with a written offer, valid for at least three years, to
+ give any third party, for a charge no more than your cost of physically
+ performing source distribution, a complete machine-readable copy of the
+ corresponding source code, to be distributed under the terms of Sections 1
+ and 2 above on a medium customarily used for software interchange; or,
+
+ c) Accompany it with the information you received as to the offer to
+ distribute corresponding source code. (This alternative is allowed only
+ for noncommercial distribution and only if you received the program in
+ object code or executable form with such an offer, in accord with
+ Subsection b above.)
+
+The source code for a work means the preferred form of the work for making
+modifications to it. For an executable work, complete source code means all
+the source code for all modules it contains, plus any associated interface
+definition files, plus the scripts used to control compilation and installation
+of the executable. However, as a special exception, the source code
+distributed need not include anything that is normally distributed (in either
+source or binary form) with the major components (compiler, kernel, and so on)
+of the operating system on which the executable runs, unless that component
+itself accompanies the executable.
+
+If distribution of executable or object code is made by offering access to copy
+from a designated place, then offering equivalent access to copy the source
+code from the same place counts as distribution of the source code, even though
+third parties are not compelled to copy the source along with the object code.
+
+4. You may not copy, modify, sublicense, or distribute the Program except as
+expressly provided under this License. Any attempt otherwise to copy, modify,
+sublicense or distribute the Program is void, and will automatically terminate
+your rights under this License. However, parties who have received copies, or
+rights, from you under this License will not have their licenses terminated so
+long as such parties remain in full compliance.
+
+5. You are not required to accept this License, since you have not signed it.
+However, nothing else grants you permission to modify or distribute the Program
+or its derivative works. These actions are prohibited by law if you do not
+accept this License. Therefore, by modifying or distributing the Program (or
+any work based on the Program), you indicate your acceptance of this License to
+do so, and all its terms and conditions for copying, distributing or modifying
+the Program or works based on it.
+
+6. Each time you redistribute the Program (or any work based on the Program),
+the recipient automatically receives a license from the original licensor to
+copy, distribute or modify the Program subject to these terms and conditions.
+You may not impose any further restrictions on the recipients' exercise of the
+rights granted herein. You are not responsible for enforcing compliance by
+third parties to this License.
+
+7. If, as a consequence of a court judgment or allegation of patent
+infringement or for any other reason (not limited to patent issues), conditions
+are imposed on you (whether by court order, agreement or otherwise) that
+contradict the conditions of this License, they do not excuse you from the
+conditions of this License. If you cannot distribute so as to satisfy
+simultaneously your obligations under this License and any other pertinent
+obligations, then as a consequence you may not distribute the Program at all.
+For example, if a patent license would not permit royalty-free redistribution
+of the Program by all those who receive copies directly or indirectly through
+you, then the only way you could satisfy both it and this License would be to
+refrain entirely from distribution of the Program.
+
+If any portion of this section is held invalid or unenforceable under any
+particular circumstance, the balance of the section is intended to apply and
+the section as a whole is intended to apply in other circumstances.
+
+It is not the purpose of this section to induce you to infringe any patents or
+other property right claims or to contest validity of any such claims; this
+section has the sole purpose of protecting the integrity of the free software
+distribution system, which is implemented by public license practices. Many
+people have made generous contributions to the wide range of software
+distributed through that system in reliance on consistent application of that
+system; it is up to the author/donor to decide if he or she is willing to
+distribute software through any other system and a licensee cannot impose that
+choice.
+
+This section is intended to make thoroughly clear what is believed to be a
+consequence of the rest of this License.
+
+8. If the distribution and/or use of the Program is restricted in certain
+countries either by patents or by copyrighted interfaces, the original
+copyright holder who places the Program under this License may add an explicit
+geographical distribution limitation excluding those countries, so that
+distribution is permitted only in or among countries not thus excluded. In
+such case, this License incorporates the limitation as if written in the body
+of this License.
+
+9. The Free Software Foundation may publish revised and/or new versions of the
+General Public License from time to time. Such new versions will be similar in
+spirit to the present version, but may differ in detail to address new problems
+or concerns.
+
+Each version is given a distinguishing version number. If the Program
+specifies a version number of this License which applies to it and "any later
+version", you have the option of following the terms and conditions either of
+that version or of any later version published by the Free Software Foundation.
+If the Program does not specify a version number of this License, you may
+choose any version ever published by the Free Software Foundation.
+
+10. If you wish to incorporate parts of the Program into other free programs
+whose distribution conditions are different, write to the author to ask for
+permission. For software which is copyrighted by the Free Software Foundation,
+write to the Free Software Foundation; we sometimes make exceptions for this.
+Our decision will be guided by the two goals of preserving the free status of
+all derivatives of our free software and of promoting the sharing and reuse of
+software generally.
+
+NO WARRANTY
+
+11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR
+THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE
+STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE
+PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED,
+INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
+FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND
+PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE,
+YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
+
+12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL
+ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE
+PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
+GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR
+INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA
+BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A
+FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER
+OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
+
+END OF TERMS AND CONDITIONS
+
+How to Apply These Terms to Your New Programs
+
+If you develop a new program, and you want it to be of the greatest possible
+use to the public, the best way to achieve this is to make it free software
+which everyone can redistribute and change under these terms.
+
+To do so, attach the following notices to the program. It is safest to attach
+them to the start of each source file to most effectively convey the exclusion
+of warranty; and each file should have at least the "copyright" line and a
+pointer to where the full notice is found.
+
+ One line to give the program's name and a brief idea of what it does.
+
+ Copyright (C)
+
+ This program is free software; you can redistribute it and/or modify it
+ under the terms of the GNU General Public License as published by the Free
+ Software Foundation; either version 2 of the License, or (at your option)
+ any later version.
+
+ This program is distributed in the hope that it will be useful, but WITHOUT
+ ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
+ more details.
+
+ You should have received a copy of the GNU General Public License along
+ with this program; if not, write to the Free Software Foundation, Inc.,
+ 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+
+Also add information on how to contact you by electronic and paper mail.
+
+If the program is interactive, make it output a short notice like this when it
+starts in an interactive mode:
+
+ Gnomovision version 69, Copyright (C) year name of author Gnomovision comes
+ with ABSOLUTELY NO WARRANTY; for details type 'show w'. This is free
+ software, and you are welcome to redistribute it under certain conditions;
+ type 'show c' for details.
+
+The hypothetical commands 'show w' and 'show c' should show the appropriate
+parts of the General Public License. Of course, the commands you use may be
+called something other than 'show w' and 'show c'; they could even be
+mouse-clicks or menu items--whatever suits your program.
+
+You should also get your employer (if you work as a programmer) or your school,
+if any, to sign a "copyright disclaimer" for the program, if necessary. Here
+is a sample; alter the names:
+
+ Yoyodyne, Inc., hereby disclaims all copyright interest in the program
+ 'Gnomovision' (which makes passes at compilers) written by James Hacker.
+
+ signature of Ty Coon, 1 April 1989
+
+ Ty Coon, President of Vice
+
+This General Public License does not permit incorporating your program into
+proprietary programs. If your program is a subroutine library, you may
+consider it more useful to permit linking proprietary applications with the
+library. If this is what you want to do, use the GNU Library General Public
+License instead of this License.
+
+
+"CLASSPATH" EXCEPTION TO THE GPL
+
+Certain source files distributed by Oracle America and/or its affiliates are
+subject to the following clarification and special exception to the GPL, but
+only where Oracle has expressly included in the particular source file's header
+the words "Oracle designates this particular file as subject to the "Classpath"
+exception as provided by Oracle in the LICENSE file that accompanied this code."
+
+ Linking this library statically or dynamically with other modules is making
+ a combined work based on this library. Thus, the terms and conditions of
+ the GNU General Public License cover the whole combination.
+
+ As a special exception, the copyright holders of this library give you
+ permission to link this library with independent modules to produce an
+ executable, regardless of the license terms of these independent modules,
+ and to copy and distribute the resulting executable under terms of your
+ choice, provided that you also meet, for each linked independent module,
+ the terms and conditions of the license of that module. An independent
+ module is a module which is not derived from or based on this library. If
+ you modify this library, you may extend this exception to your version of
+ the library, but you are not obligated to do so. If you do not wish to do
+ so, delete this exception statement from your version.
diff --git a/apidocs/legal/jquery/index.html b/apidocs/legal/jquery/index.html
new file mode 100644
index 0000000..328d3ce
--- /dev/null
+++ b/apidocs/legal/jquery/index.html
@@ -0,0 +1,554 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Jquery - AtlantaFX
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
jQuery v 3.6.0
+Copyright OpenJS Foundation and other contributors, https://openjsf.org/
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+******************************************
+
+The jQuery JavaScript Library v3.6.0 also includes Sizzle.js
+
+Sizzle.js includes the following license:
+
+Copyright JS Foundation and other contributors, https://js.foundation/
+
+This software consists of voluntary contributions made by many
+individuals. For exact contribution history, see the revision history
+available at https://github.com/jquery/sizzle
+
+The following license applies to all parts of this software except as
+documented below:
+
+====
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+====
+
+All files located in the node_modules and external directories are
+externally maintained libraries used by this software which have their
+own licenses; we recommend you read them, as their terms may differ from
+the terms above.
+
+*********************
+
Copyright jQuery Foundation and other contributors, https://jquery.org/
+
+This software consists of voluntary contributions made by many
+individuals. For exact contribution history, see the revision history
+available at https://github.com/jquery/jquery-ui
+
+The following license applies to all parts of this software except as
+documented below:
+
+====
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+====
+
+Copyright and related rights for sample code are waived via CC0. Sample
+code is defined as all source code contained within the demos directory.
+
+CC0: http://creativecommons.org/publicdomain/zero/1.0/
+
+====
+
+All files located in the node_modules and external directories are
+externally maintained libraries used by this software which have their
+own licenses; we recommend you read them, as their terms may differ from
+the terms above.
+