javafx.scene.command.MouseEventBinding Maven / Gradle / Ivy

Go to download
/*
 * Copyright (c) 2022, JFXcore. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.  JFXcore designates this
 * particular file as subject to the "Classpath" exception as provided
 * in the LICENSE file that accompanied this code.
 *
 * This code 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 General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 */

package javafx.scene.command;

import javafx.beans.NamedArg;
import javafx.beans.property.ObjectProperty;
import javafx.beans.property.SimpleObjectProperty;
import javafx.scene.input.MouseButton;
import javafx.scene.input.MouseEvent;
import javafx.util.Incubating;

/**
 * Binds a {@link Command} to {@link MouseEvent}.
 * 
 * By default, {@code MouseEventBinding} handles all mouse events.
 * It can also be configured to filter mouse events with the following filter properties:
 * 

 *     {@link #buttonProperty() button}
 *     
{@link #clickCountProperty() clickCount}
 *     
{@link #shiftDownProperty() shiftDown}
 *     
{@link #controlDownProperty() controlDown}
 *     
{@link #altDownProperty() altDown}
 *     
{@link #metaDownProperty() metaDown}
 *     
{@link #primaryButtonDownProperty() primaryButtonDown}
 *     
{@link #secondaryButtonDownProperty() secondaryButtonDown}
 *     
{@link #middleButtonDownProperty() middleButtonDown}
 *     
{@link #backButtonDownProperty() backButtonDown}
 *     
{@link #forwardButtonDownProperty() forwardButtonDown}
 * 
 * If a value other than {@code null} is specified for any of these filter properties,
 * {@code MouseEventBinding} will only handle events that match the specified value.
 *
 * @since JFXcore 18
 */
@Incubating
public class MouseEventBinding extends InputEventBinding {

    /**
     * Initializes a new {@code MouseEventBinding} instance.
     */
    public MouseEventBinding() {}

    /**
     * Initializes a new {@code MouseEventBinding} instance.
     *
     * @param command the command that is bound to the {@code MouseEvent}
     */
    public MouseEventBinding(@NamedArg("command") Command command) {
        super(command);
    }

    /**
     * Initializes a new {@code MouseEventBinding} instance.
     *
     * @param command the command that is bound to the {@code MouseEvent}
     * @param parameter the parameter that is passed to the command
     */
    public MouseEventBinding(@NamedArg("command") Command command, @NamedArg("parameter") Object parameter) {
        super(command, parameter);
    }

    /**
     * Specifies a filter for the {@link MouseEvent#getButton() button} value.
     */
    private ObjectProperty button;

    public final ObjectProperty buttonProperty() {
        return button != null ? button :
            (button = new SimpleObjectProperty<>(this, "button"));
    }

    public final MouseButton getButton() {
        return button != null ? button.get() : null;
    }

    public final void setButton(MouseButton button) {
        buttonProperty().set(button);
    }

    /**
     * Specifies a filter for the {@link MouseEvent#getClickCount() clickCount} value.
     */
    private ObjectProperty clickCount;

    public final ObjectProperty clickCountProperty() {
        return clickCount != null ? clickCount :
            (clickCount = new SimpleObjectProperty<>(this, "clickCount"));
    }

    public final Integer getClickCount() {
        return clickCount != null ? clickCount.get() : null;
    }

    public final void setClickCount(Integer clickCount) {
        clickCountProperty().set(clickCount);
    }

    /**
     * Specifies a filter for the {@link MouseEvent#isShiftDown() shiftDown} value.
     */
    private ObjectProperty shiftDown;

    public final ObjectProperty shiftDownProperty() {
        return shiftDown != null ? shiftDown :
            (shiftDown = new SimpleObjectProperty<>(this, "shiftDown"));
    }

    public final Boolean isShiftDown() {
        return shiftDown != null ? shiftDown.get() : null;
    }

    public final void setShiftDown(Boolean shiftDown) {
        shiftDownProperty().set(shiftDown);
    }

    /**
     * Specifies a filter for the {@link MouseEvent#isControlDown() controlDown} value.
     */
    private ObjectProperty controlDown;

    public final ObjectProperty controlDownProperty() {
        return controlDown != null ? controlDown :
            (controlDown = new SimpleObjectProperty<>(this, "controlDown"));
    }

    public final Boolean isControlDown() {
        return controlDown != null ? controlDown.get() : null;
    }

    public final void setControlDown(Boolean controlDown) {
        controlDownProperty().set(controlDown);
    }

    /**
     * Specifies a filter for the {@link MouseEvent#isAltDown() altDown} value.
     */
    private ObjectProperty altDown;

    public final ObjectProperty altDownProperty() {
        return altDown != null ? altDown :
            (altDown = new SimpleObjectProperty<>(this, "altDown"));
    }

    public final Boolean isAltDown() {
        return altDown != null ? altDown.get() : null;
    }

    public final void setAltDown(Boolean altDown) {
        altDownProperty().set(altDown);
    }

    /**
     * Specifies a filter for the {@link MouseEvent#isMetaDown() metaDown} value.
     */
    private ObjectProperty metaDown;

    public final ObjectProperty metaDownProperty() {
        return metaDown != null ? metaDown :
            (metaDown = new SimpleObjectProperty<>(this, "metaDown"));
    }

    public final Boolean isMetaDown() {
        return metaDown != null ? metaDown.get() : null;
    }

    public final void setMetaDown(Boolean metaDown) {
        metaDownProperty().set(metaDown);
    }

    /**
     * Specifies a filter for the {@link MouseEvent#isPrimaryButtonDown() primaryButtonDown} value.
     */
    private ObjectProperty primaryButtonDown;

    public final ObjectProperty primaryButtonDownProperty() {
        return primaryButtonDown != null ? primaryButtonDown :
            (primaryButtonDown = new SimpleObjectProperty<>(this, "primaryButtonDown"));
    }

    public final Boolean isPrimaryButtonDown() {
        return primaryButtonDown != null ? primaryButtonDown.get() : null;
    }

    public final void setPrimaryButtonDown(Boolean primaryButtonDown) {
        primaryButtonDownProperty().set(primaryButtonDown);
    }

    /**
     * Specifies a filter for the {@link MouseEvent#isMiddleButtonDown() middleButtonDown} value.
     */
    private ObjectProperty middleButtonDown;

    public final ObjectProperty middleButtonDownProperty() {
        return middleButtonDown != null ? middleButtonDown :
            (middleButtonDown = new SimpleObjectProperty<>(this, "middleButtonDown"));
    }

    public final Boolean isMiddleButtonDown() {
        return middleButtonDown != null ? middleButtonDown.get() : null;
    }

    public final void setMiddleButtonDown(Boolean middleButtonDown) {
        middleButtonDownProperty().set(middleButtonDown);
    }

    /**
     * Specifies a filter for the {@link MouseEvent#isSecondaryButtonDown() secondaryButtonDown} value.
     */
    private ObjectProperty secondaryButtonDown;

    public final ObjectProperty secondaryButtonDownProperty() {
        return secondaryButtonDown != null ? secondaryButtonDown :
            (secondaryButtonDown = new SimpleObjectProperty<>(this, "secondaryButtonDown"));
    }

    public final Boolean isSecondaryButtonDown() {
        return secondaryButtonDown != null ? secondaryButtonDown.get() : null;
    }

    public final void setSecondaryButtonDown(Boolean secondaryButtonDown) {
        secondaryButtonDownProperty().set(secondaryButtonDown);
    }

    /**
     * Specifies a filter for the {@link MouseEvent#isBackButtonDown() backButtonDown} value.
     */
    private ObjectProperty backButtonDown;

    public final ObjectProperty backButtonDownProperty() {
        return backButtonDown != null ? backButtonDown :
            (backButtonDown = new SimpleObjectProperty<>(this, "backButtonDown"));
    }

    public final Boolean isBackButtonDown() {
        return backButtonDown != null ? backButtonDown.get() : null;
    }

    public final void setBackButtonDown(Boolean backButtonDown) {
        backButtonDownProperty().set(backButtonDown);
    }

    /**
     * Specifies a filter for the {@link MouseEvent#isForwardButtonDown() forwardButtonDown} value.
     */
    private ObjectProperty forwardButtonDown;

    public final ObjectProperty forwardButtonDownProperty() {
        return forwardButtonDown != null ? forwardButtonDown :
                (forwardButtonDown = new SimpleObjectProperty<>(this, "forwardButtonDown"));
    }

    public final Boolean isForwardButtonDown() {
        return forwardButtonDown != null ? forwardButtonDown.get() : null;
    }

    public final void setForwardButtonDown(Boolean forwardButtonDown) {
        forwardButtonDownProperty().set(forwardButtonDown);
    }

    @Override
    protected boolean handleEvent(MouseEvent event) {
        return super.handleEvent(event)
            && matches(button, event.getButton())
            && matches(clickCount, event.getClickCount())
            && matches(shiftDown, event.isShiftDown())
            && matches(controlDown, event.isControlDown())
            && matches(altDown, event.isAltDown())
            && matches(metaDown, event.isMetaDown())
            && matches(primaryButtonDown, event.isPrimaryButtonDown())
            && matches(middleButtonDown, event.isMiddleButtonDown())
            && matches(secondaryButtonDown, event.isSecondaryButtonDown())
            && matches(backButtonDown, event.isBackButtonDown())
            && matches(forwardButtonDown, event.isForwardButtonDown());
    }

}