io.github.palexdev.mfxcomponents.controls.base.MFXSelectable Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of materialfx-all Show documentation
Material Design/Modern components for JavaFX, now packed as a single Jar
There is a newer version: 11.26.0
package io.github.palexdev.mfxcomponents.controls.base;

import io.github.palexdev.mfxcomponents.behaviors.MFXSelectableBehaviorBase;
import io.github.palexdev.mfxcomponents.controls.buttons.MFXIconButton;
import io.github.palexdev.mfxcomponents.theming.enums.PseudoClasses;
import io.github.palexdev.mfxcore.selection.Selectable;
import io.github.palexdev.mfxcore.selection.SelectionGroup;
import io.github.palexdev.mfxcore.selection.SelectionGroupProperty;
import io.github.palexdev.mfxcore.selection.SelectionProperty;
import javafx.scene.Node;

/**
 * Base class for MaterialFX components that are selectables and buttons. Extends {@link MFXButtonBase} since
 * almost every kind of 'selectable' are buttons accompanied by text (checks, radios, switches,...).
 * An exception being {@link MFXIconButton} that only shows an icon.
 * 
 * Implements the selection API/Behavior through the {@link Selectable} interface.
 * Expects behaviors of type {@link MFXSelectableBehaviorBase}.
 *
 * @see SelectionProperty
 * @see SelectionGroupProperty
 * @see SelectionGroup
 */
public abstract class MFXSelectable> extends MFXButtonBase implements Selectable {
    //================================================================================
    // Properties
    //================================================================================
    private final SelectionGroupProperty selectionGroup = new SelectionGroupProperty(this);
    private final SelectionProperty selected = new SelectionProperty(this) {
        @Override
        protected void invalidated() {
            super.invalidated();
            onSelectionChanged(get());
        }
    };

    //================================================================================
    // Constructors
    //================================================================================
    public MFXSelectable() {
    }

    public MFXSelectable(String text) {
        super(text);
    }

    public MFXSelectable(String text, Node graphic) {
        super(text, graphic);
    }

    //================================================================================
    // Methods
    //================================================================================

    /**
     * This is automatically called by {@link #selectedProperty()} after the selection has changed and has become invalid.
     * 
     * Allows to execute any action given the new selection state.
     * 
     * By default, de-/activates the ':selected' pseudo-class on the component.
     */
    protected void onSelectionChanged(boolean selected) {
        PseudoClasses.SELECTED.setOn(this, selected);
    }

    //================================================================================
    // Getters/Setters
    //================================================================================
    @Override
    public SelectionGroup getSelectionGroup() {
        return selectionGroup.get();
    }

    @Override
    public SelectionGroupProperty selectionGroupProperty() {
        return selectionGroup;
    }

    public void setSelectionGroup(SelectionGroup selectionGroup) {
        this.selectionGroup.set(selectionGroup);
    }

    public boolean isSelected() {
        return selected.get();
    }

    @Override
    public SelectionProperty selectedProperty() {
        return selected;
    }

    public void setSelected(boolean selected) {
        this.selected.set(selected);
    }
}