Modifier and Type	Class and Description
public static interface	Platform.Preferences Contains preferences of the current platform.

Modifier and Type	Field and Description
private static ReadOnlyBooleanWrapper	accessibilityActiveProperty

Access	Constructor and Description
private	Platform()

Modifier and Type	Method and Description
public static ReadOnlyBooleanProperty	Returns: the read-only boolean property indicating if accessibility is active accessibilityActiveProperty() Indicates whether or not accessibility is active.
public static boolean	Returns: `true` if a nested event loop can be started, and `false` otherwise. canStartNestedEventLoop() Indicates whether a nested event loop can be started from the current thread in the current state.
public static Object	Returns: the value passed into the corresponding call to exitEventLoop enterNestedEventLoop(Object the Object that identifies the nested event loop, which must not be null key) Enter a nested event loop and block until the corresponding exitNestedEventLoop call is made.
public static void	exit() Causes the JavaFX application to terminate.
public static void	exitNestedEventLoop(Object the Object that identifies the nested event loop, which must not be null key, Object an Object that is returned to the caller of the corresponding enterNestedEventLoop. This may be null. rval) Exit a nested event loop and unblock the caller of the corresponding enterNestedEventLoop.
public static Platform.Preferences	Returns: the `Preferences` instance getPreferences() Gets the preferences of the current platform.
public static boolean	isAccessibilityActive()
public static boolean	Returns: true if running on the JavaFX Application Thread isFxApplicationThread() Returns true if the calling thread is the JavaFX Application Thread.
public static boolean	Returns: the implicitExit attribute isImplicitExit() Gets the value of the implicitExit attribute.
public static Optional<Boolean>	Returns: the lock state of the key corresponding to `keyCode`, or an empty `Optional` if the system cannot determine its state isKeyLocked(KeyCode the `KeyCode` of the lock state to query keyCode) Returns a flag indicating whether the key corresponding to `keyCode` is in the locked (or "on") state.
public static boolean	Returns: true if there is a nested event loop running, and false otherwise. isNestedLoopRunning() Checks whether a nested event loop is running, returning true to indicate that one is, and false if there are no nested event loops currently running.
public static boolean	Returns: true if a specific conditional feature is supported by the platform, otherwise false isSupported(ConditionalFeature the conditional feature in question. feature) Queries whether a specific conditional feature is supported by the platform.
public static void	requestNextPulse() Requests the Java Runtime to perform a pulse.
public static void	runLater(Runnable the Runnable whose run method will be executed on the JavaFX Application Thread runnable) Run the specified Runnable on the JavaFX Application Thread at some unspecified time in the future.
public static void	setImplicitExit(boolean a flag indicating whether or not to implicitly exit when the last window is closed. implicitExit) Sets the implicitExit attribute to the specified value.
public static void	startup(Runnable the Runnable whose run method will be executed on the JavaFX Application Thread once it has been started runnable) This method starts the JavaFX runtime.

accessibilityActiveProperty	back to summary
private static ReadOnlyBooleanWrapper accessibilityActiveProperty

Platform	back to summary
private Platform()

Method Detail

accessibilityActiveProperty	back to summary
public static ReadOnlyBooleanProperty accessibilityActiveProperty() Indicates whether or not accessibility is active. This property is typically set to true the first time an assistive technology, such as a screen reader, requests information about any JavaFX window or its children. This property can be accessed only from the JavaFX Application Thread. Returns:ReadOnlyBooleanProperty the read-only boolean property indicating if accessibility is active Exceptions IllegalStateException: if this method is called on a thread other than the JavaFX Application Thread. Since JavaFX 8u40

accessibilityActiveProperty

public static ReadOnlyBooleanProperty accessibilityActiveProperty()

Indicates whether or not accessibility is active. This property is typically set to true the first time an assistive technology, such as a screen reader, requests information about any JavaFX window or its children.

This property can be accessed only from the JavaFX Application Thread.

Returns:ReadOnlyBooleanProperty

the read-only boolean property indicating if accessibility is active

Exceptions

IllegalStateException:: if this method is called on a thread other than the JavaFX Application Thread.

Since

JavaFX 8u40

canStartNestedEventLoop back to summary

canStartNestedEventLoop	back to summary
public static boolean canStartNestedEventLoop() Indicates whether a nested event loop can be started from the current thread in the current state. A nested event loop can be started from an event handler or from a `Runnable` passed to `runLater(Runnable)`. This method must be called on the JavaFX Application thread. Returns:boolean `true` if a nested event loop can be started, and `false` otherwise. Exceptions IllegalStateException: if this method is called on a thread other than the JavaFX Application Thread. Since 21

public static boolean canStartNestedEventLoop()

Indicates whether a nested event loop can be started from the current thread in the current state. A nested event loop can be started from an event handler or from a Runnable passed to runLater(Runnable). This method must be called on the JavaFX Application thread.

Returns:boolean

true if a nested event loop can be started, and false otherwise.

Exceptions

IllegalStateException:: if this method is called on a thread other than the JavaFX Application Thread.

Since

enterNestedEventLoop back to summary

enterNestedEventLoop	back to summary
public static Object enterNestedEventLoop(Object key) Enter a nested event loop and block until the corresponding exitNestedEventLoop call is made. The key passed into this method is used to uniquely identify the matched enter/exit pair. This method creates a new nested event loop and blocks until the corresponding exitNestedEventLoop method is called with the same key. The return value of this method will be the `rval` object supplied to the exitNestedEventLoop method call that unblocks it. This method must either be called from an input event handler or from the run method of a Runnable passed to `Platform.runLater`. It must not be called during animation or layout processing. There is a finite limit on the depth of the nested event loop stack. An exception will be thrown if this limit is exceeded. Applications that want to avoid an exception can call `canStartNestedEventLoop` to check whether it is possible to start one. Parameters key:Object the Object that identifies the nested event loop, which must not be null Returns:Object the value passed into the corresponding call to exitEventLoop Exceptions IllegalArgumentException: if the specified key is associated with a nested event loop that has not yet returned NullPointerException: if the key is null IllegalStateException: if this method is called during animation or layout processing. if this method is called on a thread other than the JavaFX Application Thread. if this call would exceed the maximum number of nested event loops. Since 9

public static Object enterNestedEventLoop(Object key)

Enter a nested event loop and block until the corresponding exitNestedEventLoop call is made. The key passed into this method is used to uniquely identify the matched enter/exit pair. This method creates a new nested event loop and blocks until the corresponding exitNestedEventLoop method is called with the same key. The return value of this method will be the rval object supplied to the exitNestedEventLoop method call that unblocks it.

This method must either be called from an input event handler or from the run method of a Runnable passed to Platform.runLater. It must not be called during animation or layout processing.

There is a finite limit on the depth of the nested event loop stack. An exception will be thrown if this limit is exceeded. Applications that want to avoid an exception can call canStartNestedEventLoop to check whether it is possible to start one.

Parameters

key:Object: the Object that identifies the nested event loop, which must not be null

Returns:Object

the value passed into the corresponding call to exitEventLoop

Exceptions

IllegalArgumentException:

if the specified key is associated with a nested event loop that has not yet returned

NullPointerException:

if the key is null

IllegalStateException:

if this method is called during animation or layout processing.
if this method is called on a thread other than the JavaFX Application Thread.
if this call would exceed the maximum number of nested event loops.

Since

exit	back to summary
public static void exit() Causes the JavaFX application to terminate. If this method is called after the Application start method is called, then the JavaFX launcher will call the Application stop method and terminate the JavaFX application thread. The launcher thread will then shutdown. If there are no other non-daemon threads that are running, the Java VM will exit. If this method is called from the Preloader or the Application init method, then the Application stop method may not be called. This method may be called from any thread.

exit

back to summary

public static void exit()

Causes the JavaFX application to terminate. If this method is called after the Application start method is called, then the JavaFX launcher will call the Application stop method and terminate the JavaFX application thread. The launcher thread will then shutdown. If there are no other non-daemon threads that are running, the Java VM will exit. If this method is called from the Preloader or the Application init method, then the Application stop method may not be called.

This method may be called from any thread.

exitNestedEventLoop	back to summary
public static void exitNestedEventLoop(Object key, Object rval) Exit a nested event loop and unblock the caller of the corresponding enterNestedEventLoop. The key passed into this method is used to uniquely identify the matched enter/exit pair. This method causes the nested event loop that was previously created with the key to exit and return control to the caller. If the specified nested event loop is not the inner-most loop then it will not return until all other inner loops also exit. Parameters key:Object the Object that identifies the nested event loop, which must not be null rval:Object an Object that is returned to the caller of the corresponding enterNestedEventLoop. This may be null. Exceptions IllegalArgumentException: if the specified key is not associated with an active nested event loop NullPointerException: if the key is null IllegalStateException: if this method is called on a thread other than the FX Application thread Since 9

exitNestedEventLoop

back to summary

public static void exitNestedEventLoop(Object key, Object rval)

Exit a nested event loop and unblock the caller of the corresponding enterNestedEventLoop. The key passed into this method is used to uniquely identify the matched enter/exit pair. This method causes the nested event loop that was previously created with the key to exit and return control to the caller. If the specified nested event loop is not the inner-most loop then it will not return until all other inner loops also exit.

Parameters

key:Object: the Object that identifies the nested event loop, which must not be null
rval:Object: an Object that is returned to the caller of the corresponding enterNestedEventLoop. This may be null.

Exceptions

IllegalArgumentException:: if the specified key is not associated with an active nested event loop
NullPointerException:: if the key is null
IllegalStateException:: if this method is called on a thread other than the FX Application thread

Since

getPreferences back to summary

getPreferences	back to summary
public static Platform.Preferences getPreferences() Gets the preferences of the current platform. The map returned from this method is unmodifiable, which means that keys and values cannot be added, removed, or updated. Calling any mutator method on the map will always cause `UnsupportedOperationException` to be thrown. However, the mappings will be updated by JavaFX when the operating system reports that a platform preference has changed. Returns:Platform.Preferences the `Preferences` instance Exceptions IllegalStateException: if this method is called on a thread other than the JavaFX Application Thread. Since 22 See Also Windows preferences, macOS preferences, Linux preferences

public static Platform.Preferences getPreferences()

Gets the preferences of the current platform.

The map returned from this method is unmodifiable, which means that keys and values cannot be added, removed, or updated. Calling any mutator method on the map will always cause UnsupportedOperationException to be thrown. However, the mappings will be updated by JavaFX when the operating system reports that a platform preference has changed.

Returns:Platform.Preferences

the Preferences instance

Exceptions

IllegalStateException:: if this method is called on a thread other than the JavaFX Application Thread.

Since

isAccessibilityActive	back to summary
public static boolean isAccessibilityActive()

isFxApplicationThread	back to summary
public static boolean isFxApplicationThread() Returns true if the calling thread is the JavaFX Application Thread. Use this call to ensure that a given task is being executed (or not being executed) on the JavaFX Application Thread. Returns:boolean true if running on the JavaFX Application Thread

isFxApplicationThread

back to summary

public static boolean isFxApplicationThread()

Returns true if the calling thread is the JavaFX Application Thread. Use this call to ensure that a given task is being executed (or not being executed) on the JavaFX Application Thread.

Returns:boolean: true if running on the JavaFX Application Thread

isImplicitExit	back to summary
public static boolean isImplicitExit() Gets the value of the implicitExit attribute. This method may be called from any thread. Returns:boolean the implicitExit attribute Since JavaFX 2.2

isImplicitExit

back to summary

public static boolean isImplicitExit()

Gets the value of the implicitExit attribute.

This method may be called from any thread.

Returns:boolean: the implicitExit attribute
Since: JavaFX 2.2

isKeyLocked back to summary

isKeyLocked	back to summary
public static Optional<Boolean> isKeyLocked(KeyCode keyCode) Returns a flag indicating whether the key corresponding to `keyCode` is in the locked (or "on") state. `keyCode` must be one of: `KeyCode#CAPS` or `KeyCode#NUM_LOCK`. If the underlying system is not able to determine the state of the specified `keyCode`, an empty `Optional` is returned. If the keyboard attached to the system doesn't have the specified key, an `Optional` containing `false` is returned. This method must be called on the JavaFX Application thread. Parameters keyCode:KeyCode the `KeyCode` of the lock state to query Returns:Optional<Boolean> the lock state of the key corresponding to `keyCode`, or an empty `Optional` if the system cannot determine its state Exceptions IllegalArgumentException: if `keyCode` is not one of the valid `KeyCode` values IllegalStateException: if this method is called on a thread other than the JavaFX Application Thread Since 17

public static Optional<Boolean> isKeyLocked(KeyCode keyCode)

Returns a flag indicating whether the key corresponding to keyCode is in the locked (or "on") state. keyCode must be one of: KeyCode#CAPS or KeyCode#NUM_LOCK. If the underlying system is not able to determine the state of the specified keyCode, an empty Optional is returned. If the keyboard attached to the system doesn't have the specified key, an Optional containing false is returned. This method must be called on the JavaFX Application thread.

Parameters

keyCode:KeyCode: the KeyCode of the lock state to query

Returns:Optional<Boolean>

the lock state of the key corresponding to keyCode, or an empty Optional if the system cannot determine its state

Exceptions

IllegalArgumentException:: if keyCode is not one of the valid KeyCode values
IllegalStateException:: if this method is called on a thread other than the JavaFX Application Thread

Since

isNestedLoopRunning	back to summary
public static boolean isNestedLoopRunning() Checks whether a nested event loop is running, returning true to indicate that one is, and false if there are no nested event loops currently running. This method must be called on the JavaFX Application thread. Returns:boolean true if there is a nested event loop running, and false otherwise. Exceptions IllegalStateException: if this method is called on a thread other than the JavaFX Application Thread. Since 9

isNestedLoopRunning

back to summary

public static boolean isNestedLoopRunning()

Checks whether a nested event loop is running, returning true to indicate that one is, and false if there are no nested event loops currently running. This method must be called on the JavaFX Application thread.

Returns:boolean

true if there is a nested event loop running, and false otherwise.

Exceptions

IllegalStateException:: if this method is called on a thread other than the JavaFX Application Thread.

Since

isSupported	back to summary
public static boolean isSupported(ConditionalFeature feature) Queries whether a specific conditional feature is supported by the platform. For example: // Query whether filter effects are supported if (Platform.isSupported(ConditionalFeature.EFFECT)) { // use effects } Parameters feature:ConditionalFeature the conditional feature in question. Returns:boolean true if a specific conditional feature is supported by the platform, otherwise false

isSupported

back to summary

public static boolean isSupported(ConditionalFeature feature)

Queries whether a specific conditional feature is supported by the platform.

For example:

// Query whether filter effects are supported
if (Platform.isSupported(ConditionalFeature.EFFECT)) {
   // use effects
}

Parameters

feature:ConditionalFeature: the conditional feature in question.

Returns:boolean

true if a specific conditional feature is supported by the platform, otherwise false

requestNextPulse	back to summary
public static void requestNextPulse() Requests the Java Runtime to perform a pulse. This will run a pulse even if there are no animation timers, scene graph modifications, or window events that would otherwise cause the pulse to run. If no pulse is in progress, then one will be scheduled to run the next time the pulse timer fires. If there is already a pulse running, then at least one more pulse after the current pulse will be scheduled. This method may be called on any thread. Since 9

requestNextPulse

back to summary

public static void requestNextPulse()

Requests the Java Runtime to perform a pulse. This will run a pulse even if there are no animation timers, scene graph modifications, or window events that would otherwise cause the pulse to run. If no pulse is in progress, then one will be scheduled to run the next time the pulse timer fires. If there is already a pulse running, then at least one more pulse after the current pulse will be scheduled. This method may be called on any thread.

Since: 9

runLater back to summary

runLater	back to summary
public static void runLater(Runnable runnable) Run the specified Runnable on the JavaFX Application Thread at some unspecified time in the future. This method, which may be called from any thread, will post the Runnable to an event queue and then return immediately to the caller. The Runnables are executed in the order they are posted. A runnable passed into the runLater method will be executed before any Runnable passed into a subsequent call to runLater. If this method is called after the JavaFX runtime has been shutdown, the call will be ignored: the Runnable will not be executed and no exception will be thrown. Note applications should avoid flooding JavaFX with too many pending Runnables. Otherwise, the application may become unresponsive. Applications are encouraged to batch up multiple operations into fewer runLater calls. Additionally, long-running operations should be done on a background thread where possible, freeing up the JavaFX Application Thread for GUI operations. This method must not be called before the FX runtime has been initialized. For standard JavaFX applications that extend `Application`, and use either the Java launcher or one of the launch methods in the Application class to launch the application, the FX runtime is initialized by the launcher before the Application class is loaded. For Swing applications that use JFXPanel to display FX content, the FX runtime is initialized when the first JFXPanel instance is constructed. For SWT application that use FXCanvas to display FX content, the FX runtime is initialized when the first FXCanvas instance is constructed. For applications that do not follow any of these approaches, then it is necessary to manually start the JavaFX runtime by calling `startup(Runnable)` once. Memory consistency effects: Actions in a thread prior to submitting a `runnable` to this method happen-before actions performed by the runnable in the JavaFX Application Thread. Parameters runnable:Runnable the Runnable whose run method will be executed on the JavaFX Application Thread Exceptions IllegalStateException: if the FX runtime has not been initialized See Also `Application`

public static void runLater(Runnable runnable)

Run the specified Runnable on the JavaFX Application Thread at some unspecified time in the future. This method, which may be called from any thread, will post the Runnable to an event queue and then return immediately to the caller. The Runnables are executed in the order they are posted. A runnable passed into the runLater method will be executed before any Runnable passed into a subsequent call to runLater. If this method is called after the JavaFX runtime has been shutdown, the call will be ignored: the Runnable will not be executed and no exception will be thrown.

Note

applications should avoid flooding JavaFX with too many pending Runnables. Otherwise, the application may become unresponsive. Applications are encouraged to batch up multiple operations into fewer runLater calls. Additionally, long-running operations should be done on a background thread where possible, freeing up the JavaFX Application Thread for GUI operations.

This method must not be called before the FX runtime has been initialized. For standard JavaFX applications that extend Application, and use either the Java launcher or one of the launch methods in the Application class to launch the application, the FX runtime is initialized by the launcher before the Application class is loaded. For Swing applications that use JFXPanel to display FX content, the FX runtime is initialized when the first JFXPanel instance is constructed. For SWT application that use FXCanvas to display FX content, the FX runtime is initialized when the first FXCanvas instance is constructed. For applications that do not follow any of these approaches, then it is necessary to manually start the JavaFX runtime by calling startup(Runnable) once.

Memory consistency effects: Actions in a thread prior to submitting a runnable to this method happen-before actions performed by the runnable in the JavaFX Application Thread.

Parameters

runnable:Runnable: the Runnable whose run method will be executed on the JavaFX Application Thread

Exceptions

IllegalStateException:: if the FX runtime has not been initialized

See Also

Application

setImplicitExit back to summary

setImplicitExit	back to summary
public static void setImplicitExit(boolean implicitExit) Sets the implicitExit attribute to the specified value. If this attribute is true, the JavaFX runtime will implicitly shutdown when the last window is closed; the JavaFX launcher will call the `Application#stop` method and terminate the JavaFX application thread. If this attribute is false, the application will continue to run normally even after the last window is closed, until the application calls `exit`. The default value is true. This method may be called from any thread. Parameters implicitExit:boolean a flag indicating whether or not to implicitly exit when the last window is closed. Since JavaFX 2.2

public static void setImplicitExit(boolean implicitExit)

Sets the implicitExit attribute to the specified value. If this attribute is true, the JavaFX runtime will implicitly shutdown when the last window is closed; the JavaFX launcher will call the Application#stop method and terminate the JavaFX application thread. If this attribute is false, the application will continue to run normally even after the last window is closed, until the application calls exit. The default value is true.

This method may be called from any thread.

Parameters

implicitExit:boolean: a flag indicating whether or not to implicitly exit when the last window is closed.

Since

JavaFX 2.2

startup back to summary

startup	back to summary
public static void startup(Runnable runnable) This method starts the JavaFX runtime. The specified Runnable will then be called on the JavaFX Application Thread. In general it is not necessary to explicitly call this method, since it is invoked as a consequence of how most JavaFX applications are built. However there are valid use cases for calling this method directly. Because this method starts the JavaFX runtime, there is not yet any JavaFX Application Thread, so it is normal that this method is called directly on the main thread of the application. This method may or may not return to the caller before the run method of the specified Runnable has been called. In any case, this method is not blocked on the specified Runnable being executed. Once this method returns, you may call `runLater(Runnable)` with additional Runnables. Those Runnables will be called, also on the JavaFX Application Thread, after the Runnable passed into this method has been called. As noted, it is normally the case that the JavaFX Application Thread is started automatically. It is important that this method only be called when the JavaFX runtime has not yet been initialized. Situations where the JavaFX runtime is started automatically include: For standard JavaFX applications that extend `Application`, and use either the Java launcher or one of the launch methods in the Application class to launch the application, the FX runtime is initialized automatically by the launcher before the `Application` class is loaded. For Swing applications that use `javafx.embed.swing.JFXPanel` to display FX content, the FX runtime is initialized when the first `JFXPanel` instance is constructed. For SWT application that use `FXCanvas` to display FX content, the FX runtime is initialized when the first `FXCanvas` instance is constructed. When an application does not follow any of these common approaches, then it becomes the responsibility of the developer to manually start the JavaFX runtime by calling this startup method. Calling this method when the JavaFX runtime is already running will result in an `IllegalStateException` being thrown - it is only valid to request that the JavaFX runtime be started once. Note The JavaFX classes must be loaded from a set of named `javafx.` modules on the module path*. Loading the JavaFX classes from the classpath is not supported. A warning is logged when the JavaFX runtime is started if the JavaFX classes are not loaded from the expected named module. This warning is logged regardless of whether the JavaFX runtime was started by calling this method or automatically as described above. Parameters runnable:Runnable the Runnable whose run method will be executed on the JavaFX Application Thread once it has been started Exceptions IllegalStateException: if the JavaFX runtime is already running Since 9 See Also `Application`

public static void startup(Runnable runnable)

This method starts the JavaFX runtime. The specified Runnable will then be called on the JavaFX Application Thread. In general it is not necessary to explicitly call this method, since it is invoked as a consequence of how most JavaFX applications are built. However there are valid use cases for calling this method directly. Because this method starts the JavaFX runtime, there is not yet any JavaFX Application Thread, so it is normal that this method is called directly on the main thread of the application.

This method may or may not return to the caller before the run method of the specified Runnable has been called. In any case, this method is not blocked on the specified Runnable being executed. Once this method returns, you may call runLater(Runnable) with additional Runnables. Those Runnables will be called, also on the JavaFX Application Thread, after the Runnable passed into this method has been called.

As noted, it is normally the case that the JavaFX Application Thread is started automatically. It is important that this method only be called when the JavaFX runtime has not yet been initialized. Situations where the JavaFX runtime is started automatically include:

For standard JavaFX applications that extend Application, and use either the Java launcher or one of the launch methods in the Application class to launch the application, the FX runtime is initialized automatically by the launcher before the Application class is loaded.
For Swing applications that use javafx.embed.swing.JFXPanel to display FX content, the FX runtime is initialized when the first JFXPanel instance is constructed.
For SWT application that use FXCanvas to display FX content, the FX runtime is initialized when the first FXCanvas instance is constructed.

When an application does not follow any of these common approaches, then it becomes the responsibility of the developer to manually start the JavaFX runtime by calling this startup method.

Calling this method when the JavaFX runtime is already running will result in an IllegalStateException being thrown - it is only valid to request that the JavaFX runtime be started once.

Note

The JavaFX classes must be loaded from a set of named javafx.* modules on the module path. Loading the JavaFX classes from the classpath is not supported. A warning is logged when the JavaFX runtime is started if the JavaFX classes are not loaded from the expected named module. This warning is logged regardless of whether the JavaFX runtime was started by calling this method or automatically as described above.

Parameters

runnable:Runnable: the Runnable whose run method will be executed on the JavaFX Application Thread once it has been started

Exceptions

IllegalStateException:: if the JavaFX runtime is already running

Since

See Also

Application

javafx.application back to summary

public sealed Interface Platform.Preferences

Known Direct Implementers: com.sun.javafx.application.preferences.PlatformPreferences

Contains preferences of the current platform.

Preferences extends ObservableMap to expose platform preferences as key-value pairs. The map is unmodifiable, which means that keys and values cannot be added, removed, or updated. Calling any mutator method on the map will always cause UnsupportedOperationException to be thrown. However, the mappings will be updated by JavaFX when the operating system reports that a platform preference has changed.

For convenience, getInteger, getDouble, getBoolean, getString, getColor, and getValue are provided as typed alternatives to the untyped get method.

The preferences that are reported by the platform may be dependent on the operating system version and its current configuration, so applications should not assume that a particular preference is always available.

The following preferences are potentially available on the specified platforms:

Windows
`Windows.SPI.HighContrast`	`Boolean`
`Windows.SPI.HighContrastColorScheme`	`String`
`Windows.SPI.ClientAreaAnimation`	`Boolean`
`Windows.SysColor.COLOR_3DFACE`	`Color`
`Windows.SysColor.COLOR_BTNTEXT`	`Color`
`Windows.SysColor.COLOR_GRAYTEXT`	`Color`
`Windows.SysColor.COLOR_HIGHLIGHT`	`Color`
`Windows.SysColor.COLOR_HIGHLIGHTTEXT`	`Color`
`Windows.SysColor.COLOR_HOTLIGHT`	`Color`
`Windows.SysColor.COLOR_WINDOW`	`Color`
`Windows.SysColor.COLOR_WINDOWTEXT`	`Color`
`Windows.UIColor.Background`	`Color`
`Windows.UIColor.Foreground`	`Color`
`Windows.UIColor.AccentDark3`	`Color`
`Windows.UIColor.AccentDark2`	`Color`
`Windows.UIColor.AccentDark1`	`Color`
`Windows.UIColor.Accent`	`Color`
`Windows.UIColor.AccentLight1`	`Color`
`Windows.UIColor.AccentLight2`	`Color`
`Windows.UIColor.AccentLight3`	`Color`
`Windows.UISettings.AdvancedEffectsEnabled`	`Boolean`
`Windows.UISettings.AutoHideScrollBars`	`Boolean`
`Windows.NetworkInformation.InternetCostType`	`String`

macOS
`macOS.NSColor.labelColor`	`Color`
`macOS.NSColor.secondaryLabelColor`	`Color`
`macOS.NSColor.tertiaryLabelColor`	`Color`
`macOS.NSColor.quaternaryLabelColor`	`Color`
`macOS.NSColor.textColor`	`Color`
`macOS.NSColor.placeholderTextColor`	`Color`
`macOS.NSColor.selectedTextColor`	`Color`
`macOS.NSColor.textBackgroundColor`	`Color`
`macOS.NSColor.selectedTextBackgroundColor`	`Color`
`macOS.NSColor.keyboardFocusIndicatorColor`	`Color`
`macOS.NSColor.unemphasizedSelectedTextColor`	`Color`
`macOS.NSColor.unemphasizedSelectedTextBackgroundColor`	`Color`
`macOS.NSColor.linkColor`	`Color`
`macOS.NSColor.separatorColor`	`Color`
`macOS.NSColor.selectedContentBackgroundColor`	`Color`
`macOS.NSColor.unemphasizedSelectedContentBackgroundColor`	`Color`
`macOS.NSColor.selectedMenuItemTextColor`	`Color`
`macOS.NSColor.gridColor`	`Color`
`macOS.NSColor.headerTextColor`	`Color`
`macOS.NSColor.alternatingContentBackgroundColors`	`Color[]`
`macOS.NSColor.controlAccentColor`	`Color`
`macOS.NSColor.controlColor`	`Color`
`macOS.NSColor.controlBackgroundColor`	`Color`
`macOS.NSColor.controlTextColor`	`Color`
`macOS.NSColor.disabledControlTextColor`	`Color`
`macOS.NSColor.selectedControlColor`	`Color`
`macOS.NSColor.selectedControlTextColor`	`Color`
`macOS.NSColor.alternateSelectedControlTextColor`	`Color`
`macOS.NSColor.currentControlTint`	`String`
`macOS.NSColor.windowBackgroundColor`	`Color`
`macOS.NSColor.windowFrameTextColor`	`Color`
`macOS.NSColor.underPageBackgroundColor`	`Color`
`macOS.NSColor.findHighlightColor`	`Color`
`macOS.NSColor.highlightColor`	`Color`
`macOS.NSColor.shadowColor`	`Color`
`macOS.NSColor.systemBlueColor`	`Color`
`macOS.NSColor.systemBrownColor`	`Color`
`macOS.NSColor.systemGrayColor`	`Color`
`macOS.NSColor.systemGreenColor`	`Color`
`macOS.NSColor.systemIndigoColor`	`Color`
`macOS.NSColor.systemOrangeColor`	`Color`
`macOS.NSColor.systemPinkColor`	`Color`
`macOS.NSColor.systemPurpleColor`	`Color`
`macOS.NSColor.systemRedColor`	`Color`
`macOS.NSColor.systemTealColor`	`Color`
`macOS.NSColor.systemYellowColor`	`Color`
`macOS.NSWorkspace.accessibilityDisplayShouldReduceMotion`	`Boolean`
`macOS.NSWorkspace.accessibilityDisplayShouldReduceTransparency`	`Boolean`
`macOS.NSScroller.preferredScrollerStyle`	`String`
`macOS.NWPathMonitor.currentPathConstrained`	`Boolean`
`macOS.NWPathMonitor.currentPathExpensive`	`Boolean`

Linux
`GTK.theme_name`	`String`
`GTK.theme_fg_color`	`Color`
`GTK.theme_bg_color`	`Color`
`GTK.theme_base_color`	`Color`
`GTK.theme_selected_bg_color`	`Color`
`GTK.theme_selected_fg_color`	`Color`
`GTK.theme_unfocused_fg_color`	`Color`
`GTK.theme_unfocused_bg_color`	`Color`
`GTK.theme_unfocused_base_color`	`Color`
`GTK.theme_unfocused_selected_bg_color`	`Color`
`GTK.theme_unfocused_selected_fg_color`	`Color`
`GTK.insensitive_bg_color`	`Color`
`GTK.insensitive_fg_color`	`Color`
`GTK.insensitive_base_color`	`Color`
`GTK.borders`	`Color`
`GTK.unfocused_borders`	`Color`
`GTK.warning_color`	`Color`
`GTK.error_color`	`Color`
`GTK.success_color`	`Color`
`GTK.enable_animations`	`Boolean`
`GTK.overlay_scrolling`	`Boolean`
`GTK.network_metered`	`Boolean`

Since: 22

Method Summary

Modifier and Type	Method and Description
public ReadOnlyObjectProperty<Color>	Returns: the `accentColor` property accentColorProperty() The accent color, which can be used to highlight the active or important part of a control and make it stand out from the rest of the user interface.
public ReadOnlyObjectProperty<Color>	Returns: the `backgroundColor` property backgroundColorProperty() The color used for background regions.
public ReadOnlyObjectProperty<ColorScheme>	Returns: the `colorScheme` property colorSchemeProperty() The platform color scheme, which specifies whether applications should prefer light text on dark backgrounds, or dark text on light backgrounds.
public ReadOnlyObjectProperty<Color>	Returns: the `foregroundColor` property foregroundColorProperty() The color used for foreground elements like text.
public Color	getAccentColor()
public Color	getBackgroundColor()
public Optional<Boolean>	Returns: the optional `Boolean` to which the key is mapped getBoolean(String the key key) Returns an optional `Boolean` to which the specified key is mapped.
public Optional<Color>	Returns: the optional `Color` instance to which the key is mapped getColor(String the key key) Returns an optional `Color` to which the specified key is mapped.
public ColorScheme	getColorScheme()
public Optional<Double>	Returns: the optional `Double` to which the key is mapped getDouble(String the key key) Returns an optional `Double` to which the specified key is mapped.
public Color	getForegroundColor()
public Optional<Integer>	Returns: the optional `Integer` to which the key is mapped getInteger(String the key key) Returns an optional `Integer` to which the specified key is mapped.
public Optional<String>	Returns: the optional `String` to which the key is mapped getString(String the key key) Returns an optional `String` to which the specified key is mapped.
public < the type of the value T> Optional<T>	Returns: the optional value to which the key is mapped getValue(String the key key, Class<T> the type of the value type) Returns an optional value to which the specified key is mapped.
public boolean	isPersistentScrollBars()
public boolean	isReducedData()
public boolean	isReducedMotion()
public boolean	isReducedTransparency()
public ReadOnlyBooleanProperty	Returns: the `persistentScrollBars` property persistentScrollBarsProperty() Specifies whether applications should always show scroll bars.
public ReadOnlyBooleanProperty	Returns: the `reducedData` property reducedDataProperty() Specifies whether applications should minimize the amount of internet traffic, which users might request because they are on a metered network or a limited data plan.
public ReadOnlyBooleanProperty	Returns: the `reducedMotion` property reducedMotionProperty() Specifies whether applications should minimize the amount of non-essential animations, reducing discomfort for users who experience motion sickness or vertigo.
public ReadOnlyBooleanProperty	Returns: the `reducedTransparency` property reducedTransparencyProperty() Specifies whether applications should minimize the amount of transparent or translucent layer effects, which can help to increase contrast and readability for some users.

Inherited from javafx.collections.ObservableMap:: addListener removeListener

Method Detail

accentColorProperty back to summary

accentColorProperty	back to summary
public ReadOnlyObjectProperty<Color> accentColorProperty() The accent color, which can be used to highlight the active or important part of a control and make it stand out from the rest of the user interface. It is usually a vivid color that contrasts with the foreground and background colors. Returns:ReadOnlyObjectProperty<Color> the `accentColor` property Default Value `#157EFB`

public ReadOnlyObjectProperty<Color> accentColorProperty()

The accent color, which can be used to highlight the active or important part of a control and make it stand out from the rest of the user interface. It is usually a vivid color that contrasts with the foreground and background colors.

Returns:ReadOnlyObjectProperty<Color>: the accentColor property
Default Value: #157EFB

backgroundColorProperty back to summary

backgroundColorProperty	back to summary
public ReadOnlyObjectProperty<Color> backgroundColorProperty() The color used for background regions. Returns:ReadOnlyObjectProperty<Color> the `backgroundColor` property Default Value `Color#WHITE`

public ReadOnlyObjectProperty<Color> backgroundColorProperty()

The color used for background regions.

Returns:ReadOnlyObjectProperty<Color>: the backgroundColor property
Default Value: Color#WHITE

colorSchemeProperty back to summary

colorSchemeProperty	back to summary
public ReadOnlyObjectProperty<ColorScheme> colorSchemeProperty() The platform color scheme, which specifies whether applications should prefer light text on dark backgrounds, or dark text on light backgrounds. This property corresponds to the `prefers-color-scheme` media feature. Returns:ReadOnlyObjectProperty<ColorScheme> the `colorScheme` property Default Value `ColorScheme#LIGHT`

public ReadOnlyObjectProperty<ColorScheme> colorSchemeProperty()

The platform color scheme, which specifies whether applications should prefer light text on dark backgrounds, or dark text on light backgrounds.

This property corresponds to the prefers-color-scheme media feature.

Returns:ReadOnlyObjectProperty<ColorScheme>: the colorScheme property
Default Value: ColorScheme#LIGHT

foregroundColorProperty back to summary

foregroundColorProperty	back to summary
public ReadOnlyObjectProperty<Color> foregroundColorProperty() The color used for foreground elements like text. Returns:ReadOnlyObjectProperty<Color> the `foregroundColor` property Default Value `Color#BLACK`

public ReadOnlyObjectProperty<Color> foregroundColorProperty()

The color used for foreground elements like text.

Returns:ReadOnlyObjectProperty<Color>: the foregroundColor property
Default Value: Color#BLACK

getAccentColor	back to summary
public Color getAccentColor()

getBackgroundColor	back to summary
public Color getBackgroundColor()

getBoolean back to summary

getBoolean	back to summary
public Optional<Boolean> getBoolean(String key) Returns an optional `Boolean` to which the specified key is mapped. Parameters key:String the key Returns:Optional<Boolean> the optional `Boolean` to which the key is mapped Exceptions NullPointerException: if `key` is null IllegalArgumentException: if the key is not mappable to a `Boolean`

public Optional<Boolean> getBoolean(String key)

Returns an optional Boolean to which the specified key is mapped.

Parameters

key:String: the key

Returns:Optional<Boolean>

the optional Boolean to which the key is mapped

Exceptions

NullPointerException:: if key is null
IllegalArgumentException:: if the key is not mappable to a Boolean

getColor back to summary

getColor	back to summary
public Optional<Color> getColor(String key) Returns an optional `Color` to which the specified key is mapped. Parameters key:String the key Returns:Optional<Color> the optional `Color` instance to which the key is mapped Exceptions NullPointerException: if `key` is null IllegalArgumentException: if the key is not mappable to a `Color`

public Optional<Color> getColor(String key)

Returns an optional Color to which the specified key is mapped.

Parameters

key:String: the key

Returns:Optional<Color>

the optional Color instance to which the key is mapped

Exceptions

NullPointerException:: if key is null
IllegalArgumentException:: if the key is not mappable to a Color

getColorScheme	back to summary
public ColorScheme getColorScheme()

getDouble back to summary

getDouble	back to summary
public Optional<Double> getDouble(String key) Returns an optional `Double` to which the specified key is mapped. Parameters key:String the key Returns:Optional<Double> the optional `Double` to which the key is mapped Exceptions NullPointerException: if `key` is null IllegalArgumentException: if the key is not mappable to a `Double`

public Optional<Double> getDouble(String key)

Returns an optional Double to which the specified key is mapped.

Parameters

key:String: the key

Returns:Optional<Double>

the optional Double to which the key is mapped

Exceptions

NullPointerException:: if key is null
IllegalArgumentException:: if the key is not mappable to a Double

getForegroundColor	back to summary
public Color getForegroundColor()

getInteger back to summary

getInteger	back to summary
public Optional<Integer> getInteger(String key) Returns an optional `Integer` to which the specified key is mapped. Parameters key:String the key Returns:Optional<Integer> the optional `Integer` to which the key is mapped Exceptions NullPointerException: if `key` is null IllegalArgumentException: if the key is not mappable to an `Integer`

public Optional<Integer> getInteger(String key)

Returns an optional Integer to which the specified key is mapped.

Parameters

key:String: the key

Returns:Optional<Integer>

the optional Integer to which the key is mapped

Exceptions

NullPointerException:: if key is null
IllegalArgumentException:: if the key is not mappable to an Integer

getString back to summary

getString	back to summary
public Optional<String> getString(String key) Returns an optional `String` to which the specified key is mapped. Parameters key:String the key Returns:Optional<String> the optional `String` to which the key is mapped Exceptions NullPointerException: if `key` is null IllegalArgumentException: if the key is not mappable to a `String`

public Optional<String> getString(String key)

Returns an optional String to which the specified key is mapped.

Parameters

key:String: the key

Returns:Optional<String>

the optional String to which the key is mapped

Exceptions

NullPointerException:: if key is null
IllegalArgumentException:: if the key is not mappable to a String

getValue back to summary

getValue	back to summary
public <T> Optional<T> getValue(String key, Class<T> type) Returns an optional value to which the specified key is mapped. Parameters <T> the type of the value key:String the key type:Class<T> the type of the value Returns:Optional<T> the optional value to which the key is mapped Exceptions NullPointerException: if `key` or `type` is null IllegalArgumentException: if the key is not mappable to a value of type `T`

public <T> Optional<T> getValue(String key, Class<T> type)

Returns an optional value to which the specified key is mapped.

Parameters

<T>: the type of the value
key:String: the key
type:Class<T>: the type of the value

Returns:Optional<T>

the optional value to which the key is mapped

Exceptions

NullPointerException:: if key or type is null
IllegalArgumentException:: if the key is not mappable to a value of type T

isPersistentScrollBars	back to summary
public boolean isPersistentScrollBars()

isReducedData	back to summary
public boolean isReducedData()

isReducedMotion	back to summary
public boolean isReducedMotion()

isReducedTransparency	back to summary
public boolean isReducedTransparency()

persistentScrollBarsProperty back to summary

persistentScrollBarsProperty	back to summary
public ReadOnlyBooleanProperty persistentScrollBarsProperty() Specifies whether applications should always show scroll bars. If not set, an application may choose to hide scroll bars that are not actively used, or make them smaller or less noticeable. This property corresponds to the `-fx-prefers-persistent-scrollbars` media feature. Returns:ReadOnlyBooleanProperty the `persistentScrollBars` property Default Value `false` Since 24

public ReadOnlyBooleanProperty persistentScrollBarsProperty()

Specifies whether applications should always show scroll bars. If not set, an application may choose to hide scroll bars that are not actively used, or make them smaller or less noticeable.

This property corresponds to the -fx-prefers-persistent-scrollbars media feature.

Returns:ReadOnlyBooleanProperty: the persistentScrollBars property
Default Value: false
Since: 24

reducedDataProperty back to summary

reducedDataProperty	back to summary
public ReadOnlyBooleanProperty reducedDataProperty() Specifies whether applications should minimize the amount of internet traffic, which users might request because they are on a metered network or a limited data plan. This property corresponds to the `prefers-reduced-data` media feature. Returns:ReadOnlyBooleanProperty the `reducedData` property Default Value `false` Since 24

public ReadOnlyBooleanProperty reducedDataProperty()

Specifies whether applications should minimize the amount of internet traffic, which users might request because they are on a metered network or a limited data plan.

This property corresponds to the prefers-reduced-data media feature.

Returns:ReadOnlyBooleanProperty: the reducedData property
Default Value: false
Since: 24

reducedMotionProperty back to summary

reducedMotionProperty	back to summary
public ReadOnlyBooleanProperty reducedMotionProperty() Specifies whether applications should minimize the amount of non-essential animations, reducing discomfort for users who experience motion sickness or vertigo. This property corresponds to the `prefers-reduced-motion` media feature. Returns:ReadOnlyBooleanProperty the `reducedMotion` property Default Value `false` Since 24

public ReadOnlyBooleanProperty reducedMotionProperty()

Specifies whether applications should minimize the amount of non-essential animations, reducing discomfort for users who experience motion sickness or vertigo.

This property corresponds to the prefers-reduced-motion media feature.

Returns:ReadOnlyBooleanProperty: the reducedMotion property
Default Value: false
Since: 24

reducedTransparencyProperty back to summary

reducedTransparencyProperty	back to summary
public ReadOnlyBooleanProperty reducedTransparencyProperty() Specifies whether applications should minimize the amount of transparent or translucent layer effects, which can help to increase contrast and readability for some users. This property corresponds to the `prefers-reduced-transparency` media feature. Returns:ReadOnlyBooleanProperty the `reducedTransparency` property Default Value `false` Since 24

public ReadOnlyBooleanProperty reducedTransparencyProperty()

Specifies whether applications should minimize the amount of transparent or translucent layer effects, which can help to increase contrast and readability for some users.

This property corresponds to the prefers-reduced-transparency media feature.

Returns:ReadOnlyBooleanProperty: the reducedTransparency property
Default Value: false
Since: 24

public final Class Platform

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public sealed Interface Platform.Preferences

Method Summary

Method Detail