net.java.html.leaflet

Class PopupOptions

java.lang.Object

net.java.html.leaflet.PopupOptions

public final class PopupOptions
extends Object

Options for configuring a Popup.

Constructor Summary

Constructors

Constructor and Description
PopupOptions() Creates a PopupOptions configuration object

Method Summary

Modifier and Type	Method and Description
PopupOptions	setAutoPan(boolean autoPan) Sets autoPan option
PopupOptions	setAutoPanPadding(Point autoPanPadding) Sets autoPanPadding option
PopupOptions	setAutoPanPaddingBottomRight(Point autoPanPaddingBottomRight) Sets autoPanPaddingBottomRight option
PopupOptions	setAutoPanPaddingTopLeft(Point autoPanPaddingTopLeft) Sets autoPanPaddingTopLeft option
PopupOptions	setClassName(String className) Sets className option
PopupOptions	setCloseButton(boolean closeButton) Sets closeButton option
PopupOptions	setCloseOnClick(boolean closeOnClick) Sets closeOnClick option
PopupOptions	setKeepInView(boolean keepInView) Sets keepInView option
PopupOptions	setMaxHeight(int maxHeight) Sets maxHeight option
PopupOptions	setMaxWidth(int maxWidth) Sets maxWidth option
PopupOptions	setMinWidth(int minWidth) Sets minWidth option
PopupOptions	setOffset(Point offset) Sets offset option
PopupOptions	setZoomAnimation(boolean zoomAnimation) Sets zoomAnimation option

Methods inherited from class java.lang.Object

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

Constructor Detail

PopupOptions

public PopupOptions()

Creates a PopupOptions configuration object

Method Detail

setMaxWidth

public PopupOptions setMaxWidth(int maxWidth)

Sets maxWidth option

Parameters:

maxWidth - Max width of the popup.

Returns:

updated options

setMinWidth

public PopupOptions setMinWidth(int minWidth)

Sets minWidth option

Parameters:

minWidth - Min width of the popup.

Returns:

updated options

setMaxHeight

public PopupOptions setMaxHeight(int maxHeight)

Sets maxHeight option

Parameters:

maxHeight - If set, creates a scrollable container of the given height inside a popup if its content exceeds it.

Returns:

updated options

setAutoPan

public PopupOptions setAutoPan(boolean autoPan)

Sets autoPan option

Parameters:

autoPan - Set it to false if you don't want the map to do panning animation to fit the opened popup.

Returns:

updated options

setKeepInView

public PopupOptions setKeepInView(boolean keepInView)

Sets keepInView option

Parameters:

keepInView - Set it to true if you want to prevent users from panning the popup off of the screen while it is open.

Returns:

updated options

setCloseButton

public PopupOptions setCloseButton(boolean closeButton)

Sets closeButton option

Parameters:

closeButton - Controls the presense of a close button in the popup.

Returns:

updated options

setOffset

public PopupOptions setOffset(Point offset)

Sets offset option

Parameters:

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

Returns:

updated options

setAutoPanPaddingTopLeft

public PopupOptions setAutoPanPaddingTopLeft(Point autoPanPaddingTopLeft)

Sets autoPanPaddingTopLeft option

Parameters:

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

Returns:

updated options

setAutoPanPaddingBottomRight

public PopupOptions setAutoPanPaddingBottomRight(Point autoPanPaddingBottomRight)

Sets autoPanPaddingBottomRight option

Parameters:

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

Returns:

updated options

setAutoPanPadding

public PopupOptions setAutoPanPadding(Point autoPanPadding)

Sets autoPanPadding option

Parameters:

autoPanPadding - Equivalent of setting both top left and bottom right autopan padding to the same value.

Returns:

updated options

setZoomAnimation

public PopupOptions setZoomAnimation(boolean zoomAnimation)

Sets zoomAnimation option

Parameters:

zoomAnimation - Whether to animate the popup on zoom. Disable it if you have problems with Flash content inside popups.

Returns:

updated options

setCloseOnClick

public PopupOptions setCloseOnClick(boolean closeOnClick)

Sets closeOnClick option

Parameters:

closeOnClick - Set it to false if you want to override the default behavior of the popup closing when user clicks the map (set globally by the Map closePopupOnClick option).

Returns:

updated options

setClassName

public PopupOptions setClassName(String className)

Sets className option

Parameters:

className - A custom class name to assign to the popup.

Returns:

updated options