Package org.vaadin.addons.componentfactory.leaflet.layer.map.options

Interface KeyboardNavigationOptions

All Superinterfaces:
Serializable
All Known Subinterfaces:
MapOptions
All Known Implementing Classes:
DefaultMapOptions
public interface KeyboardNavigationOptions extends Serializable
Leaflet map keyboard navigation options
Since:
2020-03-14
Version:
1.0
Author:
Gabor Kokeny Email: kokeny19@gmail.com

  • Method Summary

    Modifier and Type
    Method
    Description
    double
    getKeyboardPanDelta()
    Returns the amount of pixels the map pans when pressing an arrow key.
    boolean
    isKeyboard()
    Returns whether keyboard navigation of the map is enabled.
    void
    setKeyboard(boolean keyboard)
    Makes the map focusable and allows users to navigate the map with keyboard arrows and +/- keys.
    void
    setKeyboardPanDelta(double keyboardPanDelta)
    Amount of pixels to pan when pressing an arrow key.

  • Method Details

    • isKeyboard

      boolean isKeyboard()
      Returns whether keyboard navigation of the map is enabled.
      Returns:
      true if keyboard navigation is enabled

    • setKeyboard

      void setKeyboard(boolean keyboard)
      Makes the map focusable and allows users to navigate the map with keyboard arrows and +/- keys.
      Parameters:
      keyboard - set true to enable keyboard navigation

    • getKeyboardPanDelta

      double getKeyboardPanDelta()
      Returns the amount of pixels the map pans when pressing an arrow key.
      Returns:
      the amount of pixels to pan when pressing an arrow key

    • setKeyboardPanDelta

      void setKeyboardPanDelta(double keyboardPanDelta)
      Amount of pixels to pan when pressing an arrow key.
      Parameters:
      keyboardPanDelta - amount of pixels