com.gwidgets.api.leaflet.options

Class PopupOptions

java.lang.Object

com.gwidgets.api.leaflet.options.PopupOptions

@JsType(isNative=true,
        namespace="<global>",
        name="Object")
public class PopupOptions
extends Object

The Class PopupOptions.

Author:

Zakaria Amine

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PopupOptions.Builder The Class Builder.

Method Summary

Modifier and Type	Method and Description
String	getAttribution()
boolean	getAutoClose() Gets whether to override the default behavior of the popup closing when user clicks the map (set globally by the Map closePopupOnClick option).
boolean	getAutoPan() Gets the auto pan of the popup
Point	getAutoPanPadding() Gets whether top left and bottom right autopan padding are set to the same value.
Point	getAutoPanPaddingBottomRight() Gets The margin between the popup and the bottom right corner of the map view after autopanning was performed.
Point	getAutoPanPaddingTopLeft() Gets The margin between the popup and the top left corner of the map view after autopanning was performed.
String	getClassName() Gets the custom class name to assign to the popup.
boolean	getCloseButton() Gets whether to display a close button on the popup
boolean	getKeepInView() Gets whether to prevent users from panning the popup off of the screen while it is open.
double	getMaxHeight() Gets the max height of the popup
double	getMaxWidth() Gets the max width of the popup
double	getMinWidth() Gets the min width of the popup.
Point	getOffset() Gets The offset of the popup position.
String	getPane()

Methods inherited from class java.lang.Object

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

Method Detail

getMaxWidth

@JsOverlay
public final double getMaxWidth()

Gets the max width of the popup

Returns:

the max width

getMinWidth

@JsOverlay
public final double getMinWidth()

Gets the min width of the popup.

Returns:

the min width

getMaxHeight

@JsOverlay
public final double getMaxHeight()

Gets the max height of the popup

Returns:

the max height

getAutoPan

@JsOverlay
public final boolean getAutoPan()

Gets the auto pan of the popup

Returns:

the auto pan

getKeepInView

@JsOverlay
public final boolean getKeepInView()

Gets whether to prevent users from panning the popup off of the screen while it is open.

Returns:

the keep in view

getCloseButton

@JsOverlay
public final boolean getCloseButton()

Gets whether to display a close button on the popup

Returns:

the close button

getOffset

@JsOverlay
public final Point getOffset()

Gets The offset of the popup position. Useful to control the anchor of the popup when opening it on some overlays.

Returns:

the offset

getAutoPanPaddingTopLeft

@JsOverlay
public final Point getAutoPanPaddingTopLeft()

Gets The margin between the popup and the top left corner of the map view after autopanning was performed.

Returns:

the auto pan padding top left

getAutoPanPaddingBottomRight

@JsOverlay
public final Point getAutoPanPaddingBottomRight()

Gets The margin between the popup and the bottom right corner of the map view after autopanning was performed.

Returns:

the auto pan padding bottom right

getAutoPanPadding

@JsOverlay
public final Point getAutoPanPadding()

Gets whether top left and bottom right autopan padding are set to the same value.

Returns:

the auto pan padding

getAutoClose

@JsOverlay
public final boolean getAutoClose()

Gets whether to override the default behavior of the popup closing when user clicks the map (set globally by the Map closePopupOnClick option).

Returns:

the close on click

getClassName

@JsOverlay
public final String getClassName()

Gets the custom class name to assign to the popup.

Returns:

the class name

getPane

@JsOverlay
public final String getPane()

getAttribution

@JsOverlay
public final String getAttribution()