ol.events.condition.Condition Maven / Gradle / Ivy
/*******************************************************************************
* Copyright 2014, 2017 gwt-ol3
*
* 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 ol.events.condition;
import jsinterop.annotations.JsOverlay;
import jsinterop.annotations.JsProperty;
import jsinterop.annotations.JsType;
import ol.GenericFunction;
import ol.MapBrowserEvent;
/**
*
* @author Tino Desjardins
*
*/
@JsType(isNative = true)
public class Condition {
@JsOverlay
private static final String PACKAGE_CONDITION = "ol.events.condition";
/**
* @return function that returns true if only the alt-key is pressed, false otherwise (e.g. when additionally the shift-key is pressed)
*/
@JsProperty(name = "altKeyOnly", namespace = PACKAGE_CONDITION)
public static native GenericFunction getAltKeyOnly();
/**
* @return function that returns true if only the alt-key and shift-key is pressed, false otherwise (e.g. when additionally the
* platform-modifier-key is pressed).
*/
@JsProperty(name = "altShiftKeysOnly", namespace = PACKAGE_CONDITION)
public static native GenericFunction getAltShiftKeysOnly();
/**
* @return function that returns always true .
*/
@JsProperty(name = "always", namespace = PACKAGE_CONDITION)
public static native GenericFunction getAlways();
/**
* @return function that returns true if the event is a click event
*/
@JsProperty(name = "click", namespace = PACKAGE_CONDITION)
public static native GenericFunction getClick();
/**
* @return function that returns true if the event is a dblclick event
*/
@JsProperty(name = "doubleClick", namespace = PACKAGE_CONDITION)
public static native GenericFunction getDoubleClick();
/**
* @return function that returns true if the event is a dblclick event
*/
@JsProperty(name = "mouseOnly", namespace = PACKAGE_CONDITION)
public static native GenericFunction getMouseOnly();
/**
* @return function that always returns false
*/
@JsProperty(name = "never", namespace = PACKAGE_CONDITION)
public static native GenericFunction getNever();
/**
* @return function that returns true if no modifier key (alt-, shift- or platform-modifier-key) is pressed.
*/
@JsProperty(name = "noModifierKeys", namespace = PACKAGE_CONDITION)
public static native GenericFunction getNoModifierKeys();
/**
* @return function that returns true if the browser event is a pointermove event
*/
@JsProperty(name = "platformModifierKeyOnly", namespace = PACKAGE_CONDITION)
public static native GenericFunction getPlatformModifierKeyOnly();
/**
* @return function that returns true if the browser event is a pointermove event
*/
@JsProperty(name = "pointerMove", namespace = PACKAGE_CONDITION)
public static native GenericFunction getPointerMove();
/**
* @return function that returns true if the event originates from a primary pointer in contact with the surface or if the left mouse button is pressed.
*/
@JsProperty(name = "primaryAction", namespace = PACKAGE_CONDITION)
public static native GenericFunction getPrimaryAction();
/**
* @return function that returns true if only the shift-key is pressed, false otherwise (e.g. when additionally the alt-key is pressed).
*/
@JsProperty(name = "shiftKeyOnly", namespace = PACKAGE_CONDITION)
public static native GenericFunction getShiftKeyOnly();
/**
* @return function that returns true if the event is a map singleclick event, false otherwise.
*/
@JsProperty(name = "singleClick", namespace = PACKAGE_CONDITION)
public static native GenericFunction getSingleClick();
/**
* @return function that returns true if the target element is not editable, i.e. not a {@literal }-, {@literal