Package org.vaadin.addons.componentfactory.leaflet.controls

Class LayersControlOptions

java.lang.Object
org.vaadin.addons.componentfactory.leaflet.controls.LayersControlOptions
All Implemented Interfaces:
Serializable
public class LayersControlOptions extends Object implements Serializable
Configuration options for a LayersControl.
See Also:

  • Constructor Summary

    Constructors
    Constructor
    Description
    LayersControlOptions()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    isAutoZIndex()
    Gets whether the z-index of the layers is set automatically based on their order in the control.
    boolean
    isCollapsed()
    Gets whether the control is initially collapsed into an icon and expanded on mouse hover or touch.
    boolean
    isHideSingleBase()
    Gets whether the base layers section is hidden when there is only a single base layer.
    boolean
    isSortLayers()
    Gets whether the layers are sorted by name in the control.
    void
    setAutoZIndex(boolean autoZIndex)
    Sets whether the z-index of the layers is set automatically based on their order in the control, enabling a correct display order for overlays.
    void
    setCollapsed(boolean collapsed)
    Sets whether the control is initially collapsed into an icon and expanded on mouse hover or touch.
    void
    setHideSingleBase(boolean hideSingleBase)
    Sets whether the base layers section is hidden when there is only a single base layer.
    void
    setSortLayers(boolean sortLayers)
    Sets whether the layers are sorted by name in the control.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • LayersControlOptions

      public LayersControlOptions()

  • Method Details

    • isCollapsed

      public boolean isCollapsed()
      Gets whether the control is initially collapsed into an icon and expanded on mouse hover or touch.
      Returns:
      true if the control is collapsed, false otherwise

    • setCollapsed

      public void setCollapsed(boolean collapsed)
      Sets whether the control is initially collapsed into an icon and expanded on mouse hover or touch.
      Parameters:
      collapsed - true to collapse the control, false otherwise

    • isAutoZIndex

      public boolean isAutoZIndex()
      Gets whether the z-index of the layers is set automatically based on their order in the control.
      Returns:
      true if the z-index is set automatically, false otherwise

    • setAutoZIndex

      public void setAutoZIndex(boolean autoZIndex)
      Sets whether the z-index of the layers is set automatically based on their order in the control, enabling a correct display order for overlays.
      Parameters:
      autoZIndex - true to set the z-index automatically, false otherwise

    • isHideSingleBase

      public boolean isHideSingleBase()
      Gets whether the base layers section is hidden when there is only a single base layer.
      Returns:
      true if a single base layer is hidden, false otherwise

    • setHideSingleBase

      public void setHideSingleBase(boolean hideSingleBase)
      Sets whether the base layers section is hidden when there is only a single base layer.
      Parameters:
      hideSingleBase - true to hide a single base layer, false otherwise

    • isSortLayers

      public boolean isSortLayers()
      Gets whether the layers are sorted by name in the control.
      Returns:
      true if the layers are sorted, false otherwise

    • setSortLayers

      public void setSortLayers(boolean sortLayers)
      Sets whether the layers are sorted by name in the control.
      Parameters:
      sortLayers - true to sort the layers, false otherwise