Top Description Fields Constructors Methods
org.controlsfx.control

public Class MaskerPane

extends ControlsFXControl
Class Inheritance
Imports
impl.org.controlsfx.skin.MaskerPaneSkin, javafx.beans.property.*, javafx.scene.Node, javafx.scene.control.ProgressIndicator, .Skin, javafx.scene.layout.StackPane

MaskerPane is designed to be placed alongside other controls in a StackPane, in order to visually mask these controls, preventing them from being accessed for a short period of time. This comes in handy whenever waiting on asynchronous code to finish, and you do not want the user to be able to modify the state of the UI while waiting.

To use this control, it is necessary to place it as the last child in a StackPane, with the other children being masked by this MaskerPane when visible. Simply use setVisible(boolean) to toggle between visible states.

Field Summary

Modifier and TypeField and Description
private final DoubleProperty
progress

Properties

private final ObjectProperty<Node>
private final BooleanProperty
private final StringProperty

Constructor Summary

AccessConstructor and Description
public
MaskerPane()

Construct a new MaskerPane

Method Summary

Modifier and TypeMethod and Description
protected Skin<?>
createDefaultSkin()

Overrides javafx.scene.control.Control.createDefaultSkin.

Create a new instance of the default skin for this control.

public final double
public final Node
public final boolean
public final String
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 ObjectProperty<Node>
public final DoubleProperty
public final BooleanProperty
public final void
setProgress(double progress)

public final void
setProgressNode(Node progressNode)

public final void
setProgressVisible(boolean progressVisible)

public final void
public final StringProperty
Inherited from org.controlsfx.control.ControlsFXControl:
getUserAgentStylesheet

Field Detail

progressback to summary
private final DoubleProperty progress

Properties

progressNodeback to summary
private final ObjectProperty<Node> progressNode
progressVisibleback to summary
private final BooleanProperty progressVisible
textback to summary
private final StringProperty text

Constructor Detail

MaskerPaneback to summary
public MaskerPane()

Construct a new MaskerPane

Method Detail

createDefaultSkinback to summary
protected Skin<?> createDefaultSkin()

Overrides javafx.scene.control.Control.createDefaultSkin.

Doc from javafx.scene.control.Control.createDefaultSkin.

Create a new instance of the default skin for this control. This is called to create a skin for the control if no skin is provided via CSS -fx-skin or set explicitly in a sub-class with setSkin(...).

Annotations
@Override
getProgressback to summary
public final double getProgress()
getProgressNodeback to summary
public final Node getProgressNode()
getProgressVisibleback to summary
public final boolean getProgressVisible()
getTextback to summary
public final String getText()
getUserAgentStylesheetback 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
progressNodePropertyback to summary
public final ObjectProperty<Node> progressNodeProperty()
progressPropertyback to summary
public final DoubleProperty progressProperty()
progressVisiblePropertyback to summary
public final BooleanProperty progressVisibleProperty()
setProgressback to summary
public final void setProgress(double progress)
setProgressNodeback to summary
public final void setProgressNode(Node progressNode)
setProgressVisibleback to summary
public final void setProgressVisible(boolean progressVisible)
setTextback to summary
public final void setText(String text)
textPropertyback to summary
public final StringProperty textProperty()