com.sothawo.mapjfx.event.MapLabelEvent Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of mapjfx Show documentation

a JavaFX map component build by using OpenLayers

There is a newer version: 3.1.0

/*
 Copyright 2016-2020 Peter-Josef Meisch ([email protected])

   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
   You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.
*/
package com.sothawo.mapjfx.event;

import com.sothawo.mapjfx.MapLabel;
import javafx.event.Event;
import javafx.event.EventType;

import static java.util.Objects.requireNonNull;

/**
 * Event class for events concerning markers.
 *
 * @author P.J. Meisch ([email protected]).
 */
public class MapLabelEvent extends Event {

    /** base event type */
    public static final EventType ANY = new EventType<>("MAPLABEL_EVENT_ANY");

    /** label clicked in map */
    public static final EventType MAPLABEL_CLICKED = new EventType<>(ANY, "MAPLABEL_CLICKED");

    /** label double clicked in map */
    public static final EventType MAPLABEL_DOUBLECLICKED = new EventType<>(ANY,
            "MAPLABEL_DOUBLECLICKED");

    /** label right clicked in map */
    public static final EventType MAPLABEL_RIGHTCLICKED = new EventType<>(ANY,
            "MAPLABEL_RIGHTCLICKED");

    /** label mouse down in map */
    public static final EventType MAPLABEL_MOUSEDOWN = new EventType<>(ANY,
            "MAPLABEL_MOUSEDOWN");

    /** label mouse up in map */
    public static final EventType MAPLABEL_MOUSEUP = new EventType<>(ANY,
            "MAPLABEL_MOUSEUP");

    /** label entered in map */
    public static final EventType MAPLABEL_ENTERED = new EventType<>(ANY,
            "MAPLABEL_ENTERED");

    /** label exited in map */
    public static final EventType MAPLABEL_EXITED = new EventType<>(ANY,
            "MAPLABEL_EXITED");

    /** the MapLabel for this event. */
    private final MapLabel mapLabel;

    public MapLabelEvent(EventType eventType, MapLabel mapLabel) {
        super(eventType);
        this.mapLabel = requireNonNull(mapLabel);
    }

    public MapLabel getMapLabel() {
        return mapLabel;
    }

}