com.jfoenix.controls.JFXSlider Maven / Gradle / Ivy
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
package com.jfoenix.controls;
import com.jfoenix.converters.IndicatorPositionConverter;
import com.jfoenix.skins.JFXSliderSkin;
import javafx.beans.binding.StringBinding;
import javafx.beans.property.ObjectProperty;
import javafx.beans.property.SimpleObjectProperty;
import javafx.css.*;
import javafx.scene.control.Control;
import javafx.scene.control.Skin;
import javafx.scene.control.Slider;
import javafx.util.Callback;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
/**
* JFXSlider is the material design implementation of a slider.
*
* @author Bashir Elias & Shadi Shaheen
* @version 1.0
* @since 2016-03-09
*/
public class JFXSlider extends Slider {
/**
* {@inheritDoc}
*/
public JFXSlider() {
super(0, 100, 50);
initialize();
}
/**
* {@inheritDoc}
*/
public JFXSlider(double min, double max, double value) {
super(min, max, value);
initialize();
}
/**
* {@inheritDoc}
*/
@Override
protected Skin createDefaultSkin() {
return new JFXSliderSkin(this);
}
/**
* {@inheritDoc}
*/
@Override
public String getUserAgentStylesheet() {
return JFXSlider.class.getResource("/css/controls/jfx-slider.css").toExternalForm();
}
private void initialize() {
getStyleClass().add(DEFAULT_STYLE_CLASS);
}
public enum IndicatorPosition {
LEFT, RIGHT
}
/***************************************************************************
* *
* Properties *
* *
**************************************************************************/
/**
* String binding factory for the slider value.
* Sets a custom string for the value text (by default, it shows the value rounded to the nearest whole number).
*
*
For example, to have the value displayed as a percentage (assuming the slider has a range of (0, 100)):
*
* JFXSlider mySlider = ...
* mySlider.setValueFactory(slider ->
* Bindings.createStringBinding(
* () -> ((int) slider.getValue()) + "%",
* slider.valueProperty()
* )
* );
*
*
* NOTE: might be replaced later with a call back to create the animated thumb node
*
* @param callback a callback to create the string value binding
*/
private ObjectProperty> valueFactory;
public final ObjectProperty> valueFactoryProperty() {
if (valueFactory == null) {
valueFactory = new SimpleObjectProperty<>(this, "valueFactory");
}
return valueFactory;
}
/**
* @return the current slider value factory
*/
public final Callback getValueFactory() {
return valueFactory == null ? null : valueFactory.get();
}
/**
* sets custom string binding for the slider text value
*
* @param valueFactory a callback to create the string value binding
*/
public final void setValueFactory(final Callback valueFactory) {
this.valueFactoryProperty().set(valueFactory);
}
/***************************************************************************
* *
* Stylesheet Handling *
* *
**************************************************************************/
/**
* Initialize the style class to 'jfx-slider'.
*
* This is the selector class from which CSS can be used to style
* this control.
*/
private static final String DEFAULT_STYLE_CLASS = "jfx-slider";
/**
* indicates the position of the slider indicator, can be
* either LEFT or RIGHT
*/
private StyleableObjectProperty indicatorPosition = new SimpleStyleableObjectProperty<>(
StyleableProperties.INDICATOR_POSITION,
JFXSlider.this,
"indicatorPosition",
IndicatorPosition.LEFT);
public IndicatorPosition getIndicatorPosition() {
return indicatorPosition == null ? IndicatorPosition.LEFT : indicatorPosition.get();
}
public StyleableObjectProperty indicatorPositionProperty() {
return this.indicatorPosition;
}
public void setIndicatorPosition(IndicatorPosition pos) {
this.indicatorPosition.set(pos);
}
private static class StyleableProperties {
private static final CssMetaData INDICATOR_POSITION = new CssMetaData(
"-jfx-indicator-position",
IndicatorPositionConverter.getInstance(),
IndicatorPosition.LEFT) {
@Override
public boolean isSettable(JFXSlider control) {
return control.indicatorPosition == null || !control.indicatorPosition.isBound();
}
@Override
public StyleableProperty getStyleableProperty(JFXSlider control) {
return control.indicatorPositionProperty();
}
};
private static final List> CHILD_STYLEABLES;
static {
final List> styleables = new ArrayList<>(
Control.getClassCssMetaData());
Collections.addAll(styleables, INDICATOR_POSITION);
CHILD_STYLEABLES = Collections.unmodifiableList(styleables);
}
}
// inherit the styleable properties from parent
private List> STYLEABLES;
@Override
public List> getControlCssMetaData() {
if (STYLEABLES == null) {
final List> styleables = new ArrayList<>(
Control.getClassCssMetaData());
styleables.addAll(getClassCssMetaData());
styleables.addAll(Slider.getClassCssMetaData());
STYLEABLES = Collections.unmodifiableList(styleables);
}
return STYLEABLES;
}
public static List> getClassCssMetaData() {
return StyleableProperties.CHILD_STYLEABLES;
}
}