io.github.palexdev.mfxcomponents.skins.MFXCheckboxSkin Maven / Gradle / Ivy
Show all versions of materialfx-all Show documentation
/*
* Copyright (C) 2023 Parisi Alessandro - [email protected]
* This file is part of MaterialFX (https://github.com/palexdev/MaterialFX)
*
* MaterialFX is free software: you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public License
* as published by the Free Software Foundation; either version 3 of the License,
* or (at your option) any later version.
*
* MaterialFX is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
* See the GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with MaterialFX. If not, see
* It is allowed to change the checkbox state by clicking on the label too, as the handlers are added on the entire
* checkbox rather than just the box. However, the {@link MFXRippleGenerator} resides in the {@link MaterialSurface},
* when events come from outside the surface area, it's desirable to still show the ripple effect, as a 'fallback' they are
* generated at the center of the box/surface.
*/
public class MFXCheckboxSkin extends MFXLabeledSkin {
//================================================================================
// Properties
//================================================================================
private final MaterialSurface surface;
private final MFXIconWrapper icon;
private Animation scaleAnimation;
//================================================================================
// Constructors
//================================================================================
public MFXCheckboxSkin(MFXCheckbox checkBox) {
super(checkBox);
initTextMeasurementCache();
// Init icon
icon = new MFXIconWrapper();
icon.setCacheShape(false);
icon.animatedProperty().bind(checkBox.animatedProperty());
// Init surface
surface = new MaterialSurface(checkBox)
.initRipple(rg -> {
rg.setMeToPosConverter(me -> {
if (rg.canGenerateAt(me.getX(), me.getY())) return Position.of(me.getX(), me.getY());
Bounds b = icon.getBoundsInParent();
return Position.of(b.getCenterX(), b.getCenterY());
});
rg.setRippleColor(Color.web("#d7d1e7"));
});
// Finalize init
getChildren().addAll(surface, icon);
if (checkBox.getContentDisplay() != ContentDisplay.GRAPHIC_ONLY) getChildren().add(label);
addListeners();
}
//================================================================================
// Methods
//================================================================================
/**
* Adds the following listeners:
* - A listener on the {@link MFXCheckbox#contentDisplayProperty()} to add/remove the label node
* when the value is/is not {@link ContentDisplay#GRAPHIC_ONLY}.
*/
private void addListeners() {
MFXCheckbox checkBox = getSkinnable();
listeners(
onChanged(checkBox.contentDisplayProperty())
.then((o, n) -> {
if (n == ContentDisplay.GRAPHIC_ONLY) {
getChildren().remove(label);
return;
}
getChildren().add(label);
}),
onInvalidated(checkBox.stateProperty())
.then(s -> {
if (s == TriState.SELECTED) {
icon.setIcon(checkBox.getSelectedIcon());
return;
}
if (s == TriState.INDETERMINATE) {
icon.setIcon(checkBox.getIndeterminateIcon());
return;
}
icon.setIcon((MFXFontIcon) null);
})
.executeNow(),
onInvalidated(checkBox.selectedIconProperty())
.condition(s -> checkBox.isSelected())
.then(icon::setIcon),
onInvalidated(checkBox.indeterminateIconProperty())
.condition(s -> checkBox.isIndeterminate())
.then(icon::setIcon)
);
}
/**
* This is responsible for scaling down and up the box node when the state transitions from:
*
- UNSELECTED to SELECTED (and vice-versa)
*
- INDETERMINATE to UNSELECTED (if indeterminate enabled)
*/
protected void scale() {
MFXCheckbox checkbox = getSkinnable();
TriState state = checkbox.getState();
if (state == TriState.SELECTED || state == TriState.UNSELECTED) {
if (scaleAnimation == null) {
Duration d = Duration.millis(125);
Interpolator i = M3Motion.LINEAR;
Timeline down = TimelineBuilder.build()
.add(KeyFrames.of(d, icon.scaleXProperty(), 0.9, i))
.add(KeyFrames.of(d, icon.scaleYProperty(), 0.9, i))
.getAnimation();
Timeline up = TimelineBuilder.build()
.add(KeyFrames.of(d, icon.scaleXProperty(), 1.0, i))
.add(KeyFrames.of(d, icon.scaleYProperty(), 1.0, i))
.getAnimation();
scaleAnimation = SequentialBuilder.build()
.add(down)
.add(up)
.setOnFinished(e -> {
icon.setScaleX(1.0);
icon.setScaleY(1.0);
})
.getAnimation();
}
scaleAnimation.playFromStart();
}
}
//================================================================================
// Overridden Methods
//================================================================================
/**
* Initializes the given {@link MFXCheckboxBehavior} to handle events such as: {@link MouseEvent#MOUSE_PRESSED},
* {@link MouseEvent#MOUSE_RELEASED}, {@link MouseEvent#MOUSE_CLICKED}, {@link MouseEvent#MOUSE_EXITED} and
* {@link KeyEvent#KEY_PRESSED}.
*/
@Override
protected void initBehavior(MFXCheckboxBehavior behavior) {
MFXCheckbox checkBox = getSkinnable();
MFXRippleGenerator rg = surface.getRippleGenerator();
behavior.init();
events(
intercept(checkBox, MouseEvent.MOUSE_PRESSED)
.process(e -> behavior.mousePressed(e, c -> rg.generate(e))),
intercept(checkBox, MouseEvent.MOUSE_RELEASED)
.process(e -> behavior.mouseReleased(e, c -> rg.release())),
intercept(checkBox, MouseEvent.MOUSE_CLICKED)
.process(e -> behavior.mouseClicked(e, c -> scale())),
intercept(checkBox, MouseEvent.MOUSE_EXITED)
.process(e -> behavior.mouseExited(e, c -> rg.release())),
intercept(checkBox, KeyEvent.KEY_PRESSED)
.process(e -> behavior.keyPressed(e, c -> {
Bounds b = icon.getLayoutBounds();
rg.generate(b.getCenterX(), b.getCenterY());
}))
);
}
@Override
public double computePrefWidth(double height, double topInset, double rightInset, double bottomInset, double leftInset) {
MFXCheckbox checkBox = getSkinnable();
double gap = checkBox.getGraphicTextGap();
double insets = leftInset + rightInset;
double tW = getCachedTextWidth();
if (checkBox.getContentDisplay() == ContentDisplay.GRAPHIC_ONLY) {
tW = 0;
gap = 0;
}
double gW = Math.max(
LayoutUtils.boundWidth(surface),
icon.getSize()
);
return insets + gap + tW + gW;
}
@Override
public double computePrefHeight(double width, double topInset, double rightInset, double bottomInset, double leftInset) {
MFXCheckbox checkBox = getSkinnable();
double insets = topInset + bottomInset;
double tH = getCachedTextHeight();
if (checkBox.getContentDisplay() == ContentDisplay.GRAPHIC_ONLY) tH = 0;
double gH = Math.max(LayoutUtils.boundHeight(surface), icon.getSize());
return Math.max(tH, gH) + insets;
}
@Override
public double computeMaxWidth(double height, double topInset, double rightInset, double bottomInset, double leftInset) {
return getSkinnable().prefWidth(height);
}
@Override
public double computeMaxHeight(double width, double topInset, double rightInset, double bottomInset, double leftInset) {
return getSkinnable().prefHeight(width);
}
@Override
protected void layoutChildren(double x, double y, double w, double h) {
MFXCheckbox checkBox = getSkinnable();
double gap = checkBox.getGraphicTextGap();
layoutInArea(surface, x, y, w, h, 0, HPos.LEFT, VPos.CENTER);
layoutInArea(icon, x, y, surface.getWidth(), surface.getHeight(), 0, HPos.CENTER, VPos.CENTER);
if (checkBox.getContentDisplay() != ContentDisplay.GRAPHIC_ONLY)
layoutInArea(label, x + surface.getWidth() + gap, y, w, h, 0, HPos.LEFT, VPos.CENTER);
}
@Override
public void dispose() {
surface.dispose();
super.dispose();
}
}