All Downloads are FREE. Search and download functionalities are using the official Maven repository.

javafx.scene.input.EventBinding Maven / Gradle / Ivy

There is a newer version: 18-ea+1
Show newest version
/*
 * Copyright (c) 2020 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 or later,
 * as published by the Free Software Foundation. This particular file is
 * designated 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.input;

import javafx.beans.property.ObjectProperty;
import javafx.beans.property.SimpleObjectProperty;
import javafx.event.Event;
import javafx.event.EventHandler;
import javafx.event.EventType;
import javafx.scene.Node;

/**
 * An event binding listens for events on a {@link Node} and executes a command if a specified event was received.
 *
 * @param  the event type
 */
public abstract class EventBinding implements EventHandler {

    private final EventType eventType;
    private final ObjectProperty> command = new SimpleObjectProperty<>(this, "command");
    private final ObjectProperty commandParameter = new SimpleObjectProperty<>(this, "commandParameter");

    protected EventBinding(EventType eventType) {
        this.eventType = eventType;
    }

    public EventType getEventType() {
        return eventType;
    }

    public ObjectProperty> commandProperty() {
        return command;
    }

    public Command getCommand() {
        return command.get();
    }

    public void setCommand(Command command) {
        this.command.set(command);
    }

    public ObjectProperty commandParameterProperty() {
        return commandParameter;
    }

    public Object getCommandParameter() {
        return commandParameter.get();
    }

    public void setCommandParameter(Object commandParameter) {
        this.commandParameter.set(commandParameter);
    }

    @SuppressWarnings({"unchecked", "rawtypes"})
    protected void fireCommand() {
        Command command = getCommand();
        if (command != null && command.isExecutable()) {
            command.execute(getCommandParameter());
        }
    }

}