Modifier and Type	Class and Description
private class	LoadingPane.CommitStatusThread A thread runnable used to delay the actual status change.
public static enum	LoadingPane.Size The possible sizes for the pane.
public static enum	LoadingPane.Status The possible states that the loading pane can be in.

Modifier and Type	Field and Description
private final LongProperty	commitDelay
private LoadingPane.CommitStatusThread	commitStatusThread
private final ReadOnlyObjectWrapper<LoadingPane.Status>	committedStatus
private final ObjectProperty<Node>	content
private final StringProperty	error
private final ObjectProperty<Node>	errorNode
private final StackPane	indicatorWrapper
private final DoubleProperty	progress
private final ObjectProperty<ProgressIndicator>	progressIndicator
private final ObjectProperty<LoadingPane.Size>	size
private final ObjectProperty<LoadingPane.Status>	status

Access	Constructor and Description
public	LoadingPane() Constructs a new loading pane.
public	LoadingPane(Node the wrapped node node) Constructs a new loading pane.

Method Summary

Modifier and Type	Method and Description
public final LongProperty	Returns: the delay duration in milliseconds commitDelayProperty() The commit delay duration that will be applied before the control does change to a new state.
public final ReadOnlyObjectProperty<LoadingPane.Status>	Returns: the read-only property storing the committed status committedStatusProperty() A read-only property that contains the "committed" status value.
public final ObjectProperty<Node>	Returns: the node / the view wrapped by the loading pane, e.g. a list or a table view contentProperty() The wrapped content node.
public final void	error(String message) Convenience method to change the status of the pane to `Status#ERROR`.
public final void	error(Throwable ex) Convenience method to change the status of the pane to `Status#ERROR`.
public final void	error() Convenience method to change the status of the pane to `Status#ERROR`.
public final ObjectProperty<Node>	Returns: the error node errorNodeProperty() The node that will be shown when the loading pane is in status `Status#ERROR`.
public final StringProperty	Returns: the error message errorProperty() The error text that will be shown if the pane is in status `Status#ERROR`.
public final long	getCommitDelay()
public final LoadingPane.Status	getCommittedStatus()
public final Node	getContent()
public final String	getError()
public final Node	getErrorNode()
public final double	getProgress()
public final ProgressIndicator	getProgressIndicator()
public final LoadingPane.Size	getSize()
public final LoadingPane.Status	getStatus()
public String	getUserAgentStylesheet() Overrides javafx.scene.layout.Region.getUserAgentStylesheet. An implementation may specify its own user-agent styles for this Region, and its children, by overriding this method.
public final void	load() Convenience method to change the status of the pane to `Status#LOADING`.
public final void	ok() Convenience method to change the status of the pane to `Status#OK`.
public final ObjectProperty<ProgressIndicator>	Returns: the progress indicator progressIndicatorProperty() The progress indicator that will be used to display percentage progress or the indeterminate state of the loading progress.
public final DoubleProperty	Returns: the progress of the loading process progressProperty() The progress (value between 0 and 1).
public final void	setCommitDelay(long commitDelay)
public final void	setContent(Node content)
public final void	setError(String error)
public final void	setErrorNode(Node errorNode)
public final void	setProgress(double progress)
public final void	setProgressIndicator(ProgressIndicator progressIndicator)
public final void	setSize(LoadingPane.Size size)
public final void	setStatus(LoadingPane.Status status)
public final ObjectProperty<LoadingPane.Size>	Returns: the size of the progress indicator sizeProperty() The size of the progress indicator.
public final ObjectProperty<LoadingPane.Status>	Returns: the status of the loading pane statusProperty() The current status of the loading pane.
private void	toggleIndicator()
private void	updatePseudoClass(Enum<?> oldValue, Enum<?> newValue)
private void	updateView()
private Node	wrapErrorNode(Node errorNode)

Inherited from javafx.scene.layout.StackPane:: alignmentProperty clearConstraints computeMinHeight computeMinWidth computePrefHeight computePrefWidth getAlignment getAlignment getClassCssMetaData getContentBias getCssMetaData getMargin layoutChildren requestLayout setAlignment setAlignment setMargin

Field Detail

commitDelay	back to summary
private final LongProperty commitDelay

commitStatusThread	back to summary
private LoadingPane.CommitStatusThread commitStatusThread

committedStatus	back to summary
private final ReadOnlyObjectWrapper<LoadingPane.Status> committedStatus

content	back to summary
private final ObjectProperty<Node> content

error	back to summary
private final StringProperty error

errorNode	back to summary
private final ObjectProperty<Node> errorNode

indicatorWrapper	back to summary
private final StackPane indicatorWrapper

progress	back to summary
private final DoubleProperty progress

progressIndicator	back to summary
private final ObjectProperty<ProgressIndicator> progressIndicator

size	back to summary
private final ObjectProperty<LoadingPane.Size> size

status	back to summary
private final ObjectProperty<LoadingPane.Status> status

Constructor Detail

LoadingPane	back to summary
public LoadingPane() Constructs a new loading pane.

LoadingPane	back to summary
public LoadingPane(Node node) Constructs a new loading pane. Parameters node:Node the wrapped node

LoadingPane

back to summary

public LoadingPane(Node node)

Constructs a new loading pane.

Parameters

node:Node: the wrapped node

Method Detail

commitDelayProperty	back to summary
public final LongProperty commitDelayProperty() The commit delay duration that will be applied before the control does change to a new state. The default is 200 milliseconds. Returns:LongProperty the delay duration in milliseconds

commitDelayProperty

back to summary

public final LongProperty commitDelayProperty()

The commit delay duration that will be applied before the control does change to a new state. The default is 200 milliseconds.

Returns:LongProperty: the delay duration in milliseconds

committedStatusProperty back to summary

committedStatusProperty	back to summary
public final ReadOnlyObjectProperty<LoadingPane.Status> committedStatusProperty() A read-only property that contains the "committed" status value. Applications request a status property change via the `statusProperty()` which will be delayed via the `commitDelayProperty()`. Once the delay has passed the control will updated this property. Returns:ReadOnlyObjectProperty<LoadingPane.Status> the read-only property storing the committed status

public final ReadOnlyObjectProperty<LoadingPane.Status> committedStatusProperty()

A read-only property that contains the "committed" status value. Applications request a status property change via the statusProperty() which will be delayed via the commitDelayProperty(). Once the delay has passed the control will updated this property.

Returns:ReadOnlyObjectProperty<LoadingPane.Status>: the read-only property storing the committed status

contentProperty	back to summary
public final ObjectProperty<Node> contentProperty() The wrapped content node. Returns:ObjectProperty<Node> the node / the view wrapped by the loading pane, e.g. a list or a table view

contentProperty

back to summary

public final ObjectProperty<Node> contentProperty()

The wrapped content node.

Returns:ObjectProperty<Node>: the node / the view wrapped by the loading pane, e.g. a list or a table view

error	back to summary
public final void error(String message) Convenience method to change the status of the pane to `Status#ERROR`. Also changes the error text to the given value. This method is thread-safe.

error	back to summary
public final void error(Throwable ex) Convenience method to change the status of the pane to `Status#ERROR`. Also changes the error text to the message provided by the throwable. This method is thread-safe.

error	back to summary
public final void error() Convenience method to change the status of the pane to `Status#ERROR`. There will be no error message shown. This method is thread-safe.

errorNodeProperty back to summary

errorNodeProperty	back to summary
public final ObjectProperty<Node> errorNodeProperty() The node that will be shown when the loading pane is in status `Status#ERROR`. The default node for this is a simple label which binds to the `errorProperty()`. Returns:ObjectProperty<Node> the error node

public final ObjectProperty<Node> errorNodeProperty()

The node that will be shown when the loading pane is in status Status#ERROR. The default node for this is a simple label which binds to the errorProperty().

Returns:ObjectProperty<Node>: the error node

errorProperty back to summary

errorProperty	back to summary
public final StringProperty errorProperty() The error text that will be shown if the pane is in status `Status#ERROR`. Returns:StringProperty the error message

public final StringProperty errorProperty()

The error text that will be shown if the pane is in status Status#ERROR.

Returns:StringProperty: the error message

getCommitDelay	back to summary
public final long getCommitDelay()

getCommittedStatus	back to summary
public final LoadingPane.Status getCommittedStatus()

getContent	back to summary
public final Node getContent()

getError	back to summary
public final String getError()

getErrorNode	back to summary
public final Node getErrorNode()

getProgress	back to summary
public final double getProgress()

getProgressIndicator	back to summary
public final ProgressIndicator getProgressIndicator()

getSize	back to summary
public final LoadingPane.Size getSize()

getStatus	back to summary
public final LoadingPane.Status getStatus()

getUserAgentStylesheet back to summary

getUserAgentStylesheet	back to summary
public String getUserAgentStylesheet() Overrides javafx.scene.layout.Region.getUserAgentStylesheet. Doc from javafx.scene.layout.Region.getUserAgentStylesheet. An implementation may specify its own user-agent styles for this Region, and its children, by overriding this method. These styles are used in addition to whatever user-agent stylesheets are in use. This provides a mechanism for third parties to introduce styles for custom controls. The URL is a hierarchical URI of the form [scheme:][//authority][path]. If the URL does not have a [scheme:] component, the URL is considered to be the [path] component only. Any leading '/' character of the [path] is ignored and the [path] is treated as a path relative to the root of the application's classpath. Subclasses overriding this method should not assume any particular implementation approach as to the number and frequency with which it is called. For this reason, attempting any kind of dynamic implementation (i.e. returning different user agent stylesheet values) based on some state change is highly discouraged, as there is no guarantee when, or even if, this method will be called. Some JavaFX CSS implementations may choose to cache this response for an indefinite period of time, and therefore there should be no expectation around when this method is called. `package com.example.javafx.app; import javafx.application.Application; import javafx.scene.Group; import javafx.scene.Scene; import javafx.stage.Stage; public class MyApp extends Application { @Override public void start(Stage stage) { Scene scene = new Scene(new Group()); scene.getStylesheets().add("/com/example/javafx/app/mystyles.css"); stage.setScene(scene); stage.show(); } public static void main(String[] args) { launch(args); } }` For additional information about using CSS with the scene graph, see the CSS Reference Guide. Annotations @Override

public String getUserAgentStylesheet()

Overrides javafx.scene.layout.Region.getUserAgentStylesheet.

Doc from javafx.scene.layout.Region.getUserAgentStylesheet.

An implementation may specify its own user-agent styles for this Region, and its children, by overriding this method. These styles are used in addition to whatever user-agent stylesheets are in use. This provides a mechanism for third parties to introduce styles for custom controls.

The URL is a hierarchical URI of the form [scheme:][//authority][path]. If the URL does not have a [scheme:] component, the URL is considered to be the [path] component only. Any leading '/' character of the [path] is ignored and the [path] is treated as a path relative to the root of the application's classpath.

Subclasses overriding this method should not assume any particular implementation approach as to the number and frequency with which it is called. For this reason, attempting any kind of dynamic implementation (i.e. returning different user agent stylesheet values) based on some state change is highly discouraged, as there is no guarantee when, or even if, this method will be called. Some JavaFX CSS implementations may choose to cache this response for an indefinite period of time, and therefore there should be no expectation around when this method is called.



package com.example.javafx.app;

import javafx.application.Application;
import javafx.scene.Group;
import javafx.scene.Scene;
import javafx.stage.Stage;

public class MyApp extends Application {

    @Override public void start(Stage stage) {
        Scene scene = new Scene(new Group());
        scene.getStylesheets().add("/com/example/javafx/app/mystyles.css");
        stage.setScene(scene);
        stage.show();
    }

    public static void main(String[] args) {
        launch(args);
    }
}

For additional information about using CSS with the scene graph, see the CSS Reference Guide.

Annotations

@Override

load	back to summary
public final void load() Convenience method to change the status of the pane to `Status#LOADING`. Automatically clears the error text. This method is thread-safe.

ok	back to summary
public final void ok() Convenience method to change the status of the pane to `Status#OK`. Automatically clears the error text. This method is thread-safe.

progressIndicatorProperty	back to summary
public final ObjectProperty<ProgressIndicator> progressIndicatorProperty() The progress indicator that will be used to display percentage progress or the indeterminate state of the loading progress. Returns:ObjectProperty<ProgressIndicator> the progress indicator

progressIndicatorProperty

back to summary

public final ObjectProperty<ProgressIndicator> progressIndicatorProperty()

The progress indicator that will be used to display percentage progress or the indeterminate state of the loading progress.

Returns:ObjectProperty<ProgressIndicator>: the progress indicator

progressProperty	back to summary
public final DoubleProperty progressProperty() The progress (value between 0 and 1). Returns:DoubleProperty the progress of the loading process

progressProperty

back to summary

public final DoubleProperty progressProperty()

The progress (value between 0 and 1).

Returns:DoubleProperty: the progress of the loading process

setCommitDelay	back to summary
public final void setCommitDelay(long commitDelay)

setContent	back to summary
public final void setContent(Node content)

setError	back to summary
public final void setError(String error)

setErrorNode	back to summary
public final void setErrorNode(Node errorNode)

setProgress	back to summary
public final void setProgress(double progress)

setProgressIndicator	back to summary
public final void setProgressIndicator(ProgressIndicator progressIndicator)

setSize	back to summary
public final void setSize(LoadingPane.Size size)

setStatus	back to summary
public final void setStatus(LoadingPane.Status status)

sizeProperty	back to summary
public final ObjectProperty<LoadingPane.Size> sizeProperty() The size of the progress indicator. The size should match the size of the wrapped node. Returns:ObjectProperty<LoadingPane.Size> the size of the progress indicator

sizeProperty

back to summary

public final ObjectProperty<LoadingPane.Size> sizeProperty()

The size of the progress indicator. The size should match the size of the wrapped node.

Returns:ObjectProperty<LoadingPane.Size>: the size of the progress indicator

statusProperty back to summary

statusProperty	back to summary
public final ObjectProperty<LoadingPane.Status> statusProperty() The current status of the loading pane. Returns:ObjectProperty<LoadingPane.Status> the status of the loading pane See Also `Status`

public final ObjectProperty<LoadingPane.Status> statusProperty()

The current status of the loading pane.

Returns:ObjectProperty<LoadingPane.Status>: the status of the loading pane
See Also: Status

toggleIndicator	back to summary
private void toggleIndicator()

updatePseudoClass	back to summary
private void updatePseudoClass(Enum<?> oldValue, Enum<?> newValue)

updateView	back to summary
private void updateView()

wrapErrorNode	back to summary
private Node wrapErrorNode(Node errorNode)

com.dlsc.gemsfx back to summary

private Class LoadingPane.CommitStatusThread

Class Inheritance

extends Object
implements Runnable

java.lang.Object
com.dlsc.gemsfx.LoadingPane.CommitStatusThread

All Implemented Interfaces

java.lang.Runnable

A thread runnable used to delay the actual status change. Delaying is important so that a fast loading process does not cause a quick flicker inside the UI.

Field Summary

Modifier and Type	Field and Description
private final LoadingPane.Status	status
private boolean	stopped

Constructor Summary

Access	Constructor and Description
pack-priv	CommitStatusThread(LoadingPane.Status status)

Method Summary

Modifier and Type	Method and Description
public void	abort()
public void	run() Implements java.lang.Runnable.run. Runs this operation.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

status	back to summary
private final LoadingPane.Status status

stopped	back to summary
private boolean stopped

Constructor Detail

CommitStatusThread	back to summary
pack-priv CommitStatusThread(LoadingPane.Status status)

Method Detail

abort	back to summary
public void abort()

run

back to summary

public void run()

Implements java.lang.Runnable.run.

Doc from java.lang.Runnable.run.

Runs this operation.

Annotations

@Override

com.dlsc.gemsfx back to summary

public final Enum LoadingPane.Size

Class Inheritance

extends Enum<LoadingPane.Size>

java.lang.Object
java.lang.Enum
com.dlsc.gemsfx.LoadingPane.Size

The possible sizes for the pane. Sizes will also be reflected by matching pseudo-classes.

See Also: sizeProperty()

Field Summary

Modifier and Type	Field and Description
public static final LoadingPane.Size	LARGE
public static final LoadingPane.Size	MEDIUM
public static final LoadingPane.Size	SMALL

Constructor Summary

Access	Constructor and Description
private	Size()

Method Summary

Modifier and Type	Method and Description
public static LoadingPane.Size	valueOf(String name)
public static LoadingPane.Size[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

LARGE	back to summary
public static final LoadingPane.Size LARGE

MEDIUM	back to summary
public static final LoadingPane.Size MEDIUM

SMALL	back to summary
public static final LoadingPane.Size SMALL

Constructor Detail

Size	back to summary
private Size()

Method Detail

valueOf	back to summary
public static LoadingPane.Size valueOf(String name)

values	back to summary
public static LoadingPane.Size[] values()

com.dlsc.gemsfx back to summary

public final Enum LoadingPane.Status

Class Inheritance

extends Enum<LoadingPane.Status>

java.lang.Object
java.lang.Enum
com.dlsc.gemsfx.LoadingPane.Status

The possible states that the loading pane can be in.

See Also: statusProperty()

Field Summary

Modifier and Type	Field and Description
public static final LoadingPane.Status	ERROR The pane will show the error message.
public static final LoadingPane.Status	LOADING The pane will show the progress indicator.
public static final LoadingPane.Status	OK The pane will show the wrapped node.

Constructor Summary

Access	Constructor and Description
private	Status()

Method Summary

Modifier and Type	Method and Description
public static LoadingPane.Status	valueOf(String name)
public static LoadingPane.Status[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

ERROR	back to summary
public static final LoadingPane.Status ERROR The pane will show the error message.

LOADING	back to summary
public static final LoadingPane.Status LOADING The pane will show the progress indicator.

OK	back to summary
public static final LoadingPane.Status OK The pane will show the wrapped node.

Constructor Detail

Status	back to summary
private Status()

Method Detail

valueOf	back to summary
public static LoadingPane.Status valueOf(String name)

values	back to summary
public static LoadingPane.Status[] values()

public Class LoadingPane

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class LoadingPane.CommitStatusThread

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Enum LoadingPane.Size

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Enum LoadingPane.Status

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail