com.gwidgets.api.leaflet.options

Class PopupOptions.Builder

java.lang.Object

com.gwidgets.api.leaflet.options.PopupOptions.Builder

Enclosing class:

PopupOptions

public static class PopupOptions.Builder
extends Object

The Class Builder.

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
PopupOptions.Builder	attribution(String attribution)
PopupOptions.Builder	autoClose(Boolean autoClose) 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).
PopupOptions.Builder	autoPan(Boolean autoPan) Set it to false if you don't want the map to do panning animation to fit the opened popup.
PopupOptions.Builder	autoPanPadding(Point autoPanPadding) Equivalent of setting both top left and bottom right autopan padding to the same value.
PopupOptions.Builder	autoPanPaddingBottomRight(Point autoPanPaddingBottomRight) The margin between the popup and the bottom right corner of the map view after autopanning was performed.
PopupOptions.Builder	autoPanPaddingTopLeft(Point autoPanPaddingTopLeft) The margin between the popup and the top left corner of the map view after autopanning was performed.
PopupOptions	build() Builds the PopupOptions
PopupOptions.Builder	className(String className) A custom class name to assign to the popup.
PopupOptions.Builder	closeButton(Boolean closeButton) Controls the presence of a close button in the popup.
PopupOptions.Builder	keepInView(Boolean keepInView) Set it to true if you want to prevent users from panning the popup off of the screen while it is open.
PopupOptions.Builder	maxHeight(Double maxHeight) If set, creates a scrollable container of the given height inside a popup if its content exceeds it.
PopupOptions.Builder	maxWidth(Double maxWidth) Max width of the popup.
PopupOptions.Builder	minWidth(Double minWidth) Min width of the popup.
PopupOptions.Builder	offset(Point offset) The offset of the popup position.
PopupOptions.Builder	pane(String pane)

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

maxWidth

public PopupOptions.Builder maxWidth(Double maxWidth)

Max width of the popup.

Parameters:

maxWidth - the max width

Returns:

the builder

minWidth

public PopupOptions.Builder minWidth(Double minWidth)

Min width of the popup.

Parameters:

minWidth - the min width

Returns:

the builder

maxHeight

public PopupOptions.Builder maxHeight(Double maxHeight)

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

Parameters:

maxHeight - the max height

Returns:

the builder

autoPan

public PopupOptions.Builder autoPan(Boolean autoPan)

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

Parameters:

autoPan - the auto pan

Returns:

the builder

keepInView

public PopupOptions.Builder keepInView(Boolean keepInView)

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

Parameters:

keepInView - the keep in view

Returns:

the builder

closeButton

public PopupOptions.Builder closeButton(Boolean closeButton)

Controls the presence of a close button in the popup.

Parameters:

closeButton - the close button

Returns:

the builder

offset

public PopupOptions.Builder offset(Point offset)

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

Parameters:

offset - the offset

Returns:

the builder

autoPanPaddingTopLeft

public PopupOptions.Builder autoPanPaddingTopLeft(Point autoPanPaddingTopLeft)

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

Parameters:

autoPanPaddingTopLeft - the auto pan padding top left

Returns:

the builder

autoPanPaddingBottomRight

public PopupOptions.Builder autoPanPaddingBottomRight(Point autoPanPaddingBottomRight)

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

Parameters:

autoPanPaddingBottomRight - the auto pan padding bottom right

Returns:

the builder

autoPanPadding

public PopupOptions.Builder autoPanPadding(Point autoPanPadding)

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

Parameters:

autoPanPadding - the auto pan padding

Returns:

the builder

autoClose

public PopupOptions.Builder autoClose(Boolean autoClose)

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).

Parameters:

closeOnClick - the close on click

Returns:

the builder

className

public PopupOptions.Builder className(String className)

A custom class name to assign to the popup.

Parameters:

className - the class name

Returns:

the builder

pane

public PopupOptions.Builder pane(String pane)

attribution

public PopupOptions.Builder attribution(String attribution)

build

public PopupOptions build()

Builds the PopupOptions

Returns:

the popup options