org.controlsfx.control.SegmentedButton Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of controlsfx Show documentation
Show all versions of controlsfx Show documentation
High quality UI controls and other tools to complement the core JavaFX distribution
/**
* Copyright (c) 2013, 2015, ControlsFX
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* * Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* * Neither the name of ControlsFX, any associated website, nor the
* names of its contributors may be used to endorse or promote products
* derived from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL CONTROLSFX BE LIABLE FOR ANY
* DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.controlsfx.control;
import impl.org.controlsfx.skin.SegmentedButtonSkin;
import javafx.beans.property.ObjectProperty;
import javafx.beans.property.SimpleObjectProperty;
import javafx.collections.FXCollections;
import javafx.collections.ObservableList;
import javafx.scene.control.Skin;
import javafx.scene.control.ToggleButton;
import javafx.scene.control.ToggleGroup;
/**
* The SegmentedButton is a simple control that forces together a group of
* {@link ToggleButton} instances such that they appear as one collective button
* (with sub-buttons), rather than as individual buttons. This is better
* clarified with a picture:
*
*
*
* 
*
*
* Code Samples
*
* There is very little API on this control, you essentially create
* {@link ToggleButton} instances as per usual (and don't bother putting them
* into a {@link ToggleGroup}, as this is done by the SegmentedButton itself), and then
* you place these buttons inside the {@link #getButtons() buttons list}. The
* long-hand way to code this is as follows:
*
*
* {@code
* ToggleButton b1 = new ToggleButton("day");
* ToggleButton b2 = new ToggleButton("week");
* ToggleButton b3 = new ToggleButton("month");
* ToggleButton b4 = new ToggleButton("year");
*
* SegmentedButton segmentedButton = new SegmentedButton();
* segmentedButton.getButtons().addAll(b1, b2, b3, b4);}
*
* A slightly shorter way of doing this is to pass the ToggleButton instances
* into the varargs constructor, as such:
*
*
{@code SegmentedButton segmentedButton = new SegmentedButton(b1, b2, b3, b4);}
*
* Custom ToggleGroup
* It is possible to configure the ToggleGroup, which is used internally.
* By setting the ToggleGroup to null, the control will allow multiple selections.
*
*
* {@code
* SegmentedButton segmentedButton = new SegmentedButton();
* segmentedButton.setToggleGroup(null);
* }
*
* Alternative Styling
* As is visible in the screenshot at the top of this class documentation,
* there are two different styles supported by the SegmentedButton control.
* Firstly, there is the default style based on the JavaFX Modena look. The
* alternative style is what is currently referred to as the 'dark' look. To
* enable this functionality, simply do the following:
*
*
* {@code
* SegmentedButton segmentedButton = new SegmentedButton();
* segmentedButton.getStyleClass().add(SegmentedButton.STYLE_CLASS_DARK);
* }
*
* Resizable Range
* By default, the maximum width and height of a SegmentedButton match its
* preferred width and height. Thus, the SegmentedButton only fills the area
* which is necessary to display the contained buttons. To change this behavior,
* the following code can be used:
*
*
* {@code
* SegmentedButton segmentedButton = new SegmentedButton();
* segmentedButton.setMaxSize(Double.MAX_VALUE, Double.MAX_VALUE);
* }
*
* @see ToggleButton
* @see ToggleGroup
*/
public class SegmentedButton extends ControlsFXControl {
/**************************************************************************
*
* Static fields
*
*************************************************************************/
/**
* An alternative styling for the segmented button, with a darker pressed
* color which stands out more than the default modena styling. Refer to
* the class documentation for details on how to use (and screenshots), but
* in short, simply do the following to get the dark styling:
*
*
* {@code
* SegmentedButton segmentedButton = new SegmentedButton();
* segmentedButton.getStyleClass().add(SegmentedButton.STYLE_CLASS_DARK);
* }
*/
public static final String STYLE_CLASS_DARK = "dark"; //$NON-NLS-1$
/**************************************************************************
*
* Private fields
*
*************************************************************************/
private final ObservableList buttons;
private final ObjectProperty toggleGroup = new SimpleObjectProperty<>(new ToggleGroup());
/**************************************************************************
*
* Constructors
*
*************************************************************************/
/**
* Creates a default SegmentedButton instance with no buttons.
*/
public SegmentedButton() {
this((ObservableList)null);
}
/**
* Creates a default SegmentedButton instance with the provided buttons
* inserted into it.
*
* @param buttons A varargs array of buttons to add into the SegmentedButton
* instance.
*/
public SegmentedButton(ToggleButton... buttons) {
this(buttons == null ?
FXCollections.observableArrayList() :
FXCollections.observableArrayList(buttons));
}
/**
* Creates a default SegmentedButton instance with the provided buttons
* inserted into it.
*
* @param buttons A list of buttons to add into the SegmentedButton instance.
*/
public SegmentedButton(ObservableList buttons) {
getStyleClass().add("segmented-button"); //$NON-NLS-1$
this.buttons = buttons == null ? FXCollections.observableArrayList() : buttons;
// Fix for Issue #87:
// https://bitbucket.org/controlsfx/controlsfx/issue/87/segmentedbutton-keyboard-focus-traversal
setFocusTraversable(false);
}
/**************************************************************************
*
* Public API
*
*************************************************************************/
/** {@inheritDoc} */
@Override protected Skin createDefaultSkin() {
return new SegmentedButtonSkin(this);
}
/**
* Returns the list of buttons that this SegmentedButton will draw together
* into one 'grouped button'. It is possible to modify this list to add or
* remove {@link ToggleButton} instances, as shown in the javadoc
* documentation for this class.
*/
public final ObservableList getButtons() {
return buttons;
}
/**
* @return Property of the ToggleGroup used internally
*/
public ObjectProperty toggleGroupProperty() {
return this.toggleGroup;
}
/**
* @return ToggleGroup used internally
*/
public ToggleGroup getToggleGroup() {
return this.toggleGroupProperty().getValue();
}
/**
* @param toggleGroup ToggleGroup to be used internally
*/
public void setToggleGroup(final ToggleGroup toggleGroup) {
this.toggleGroupProperty().setValue(toggleGroup);
}
/**************************************************************************
*
* CSS
*
*************************************************************************/
/** {@inheritDoc} */
@Override public String getUserAgentStylesheet() {
return getUserAgentStylesheet(SegmentedButton.class, "segmentedbutton.css");
}
} © 2015 - 2025 Weber Informatics LLC | Privacy Policy