ControlsFX 11.2.2 · org.controlsfx.control.ToggleSwitch

public Class ToggleSwitch

Much like a Toggle Button this control allows the user to toggle between one of two states. It has been popularized in touch based devices where its usage is particularly useful because unlike a checkbox the finger touch of a user doesn't obscure the control.

Shown below is a screenshot of the ToggleSwitch control in its on and off state:

Field Summary

Modifier and Type	Field and Description
private static final String	DEFAULT_STYLE_CLASS * Stylesheet Handling * *
private static final PseudoClass	PSEUDO_CLASS_SELECTED
private BooleanProperty	selected Indicates whether this ToggleSwitch is selected.

Constructor Summary

Access	Constructor and Description
public	ToggleSwitch() Creates a toggle switch with empty string for its label.
public	ToggleSwitch(String The label string of the control. text) Creates a toggle switch with the specified label.

Modifier and Type	Method and Description
protected Skin<?>	createDefaultSkin() Overrides javafx.scene.control.Control.createDefaultSkin. Create a new instance of the default skin for this control.
public void	fire() Toggles the state of the `ToggleSwitch`.
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.
private void	initialize()
public final boolean	isSelected() Returns whether this Toggle Switch is selected
public final BooleanProperty	selectedProperty() Returns the selected property
public final void	setSelected(boolean value) Sets the selected value of this Toggle Switch

Modifier and Type

Method and Description

protected Skin<?>

createDefaultSkin()

Overrides javafx.scene.control.Control.createDefaultSkin.

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

public void

fire()

Toggles the state of the ToggleSwitch.

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.

private void

initialize()

public final boolean

isSelected()

Returns whether this Toggle Switch is selected

public final BooleanProperty

selectedProperty()

Returns the selected property

public final void

setSelected(boolean value)

Sets the selected value of this Toggle Switch

Field Detail

DEFAULT_STYLE_CLASS	back to summary
private static final String DEFAULT_STYLE_CLASS * Stylesheet Handling * *

PSEUDO_CLASS_SELECTED	back to summary
private static final PseudoClass PSEUDO_CLASS_SELECTED

selected	back to summary
private BooleanProperty selected Indicates whether this ToggleSwitch is selected.

Constructor Detail

ToggleSwitch	back to summary
public ToggleSwitch() Creates a toggle switch with empty string for its label.

ToggleSwitch	back to summary
public ToggleSwitch(String text) Creates a toggle switch with the specified label. Parameters text:String The label string of the control.

ToggleSwitch

back to summary

public ToggleSwitch(String text)

Creates a toggle switch with the specified label.

Parameters

text:String: The label string of the control.

Method Detail

createDefaultSkin back to summary

createDefaultSkin	back 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

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

fire	back to summary
public void fire() Toggles the state of the `ToggleSwitch`. The `ToggleSwitch` will cycle through the selected and unselected states.

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.