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

Go to download

Show more of this group Show more artifacts with this name
Show all versions of javafx-graphics Show documentation

There is a newer version: 24-ea+15

/*
 * Copyright (c) 2008, 2018, Oracle and/or its affiliates. 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.  Oracle designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Oracle 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.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */

package javafx.scene.input;

/**
 * Mapping for Button Names
 * @since JavaFX 2.0
 */
public enum MouseButton {

    /**
     * Represents no button.
     */
    NONE,

    /**
     * Represents primary (button 1, usually the left) mouse button.
     */
    PRIMARY,

    /**
     * Represents middle (button 2) mouse button.
     */
    MIDDLE,

    /**
     * Represents secondary (button 3, usually the right) mouse button.
     */
    SECONDARY,

    /**
     * Represents back (button 4) mouse button.
     *
     * @since 12
     */
    BACK,

    /**
     * Represents forward (button 5) mouse button.
     *
     * @since 12
     */
    FORWARD;
}