io.jmix.mapsui.component

Class PopupWindowOptions

java.lang.Object

io.jmix.mapsui.component.PopupWindowOptions

public class PopupWindowOptions
extends java.lang.Object

Options for a PopupWindow.

Constructor Summary

Constructors

Constructor and Description
PopupWindowOptions()

Method Summary

Modifier and Type	Method and Description
int	getMaxWidth() Returns max width of the popup, in pixels.
int	getMinWidth() Returns min width of the popup, in pixels.
boolean	isCloseButtonEnabled()
boolean	isCloseOnClick() Whether popup should be closed when user clicks on the map.
PopupWindowOptions	setCloseButtonEnabled(boolean closeButtonEnabled) Defines whether close button is enabled in a popup window.
PopupWindowOptions	setCloseOnClick(boolean closeOnClick) Defines whether popup should be closed when user clicks on the map.
PopupWindowOptions	setMaxWidth(int maxWidth) Sets max width of the popup window, in pixels.
PopupWindowOptions	setMinWidth(int minWidth) Sets min width of the popup, in pixels.

Methods inherited from class java.lang.Object

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

Constructor Detail

PopupWindowOptions

public PopupWindowOptions()

Method Detail

isCloseButtonEnabled

public boolean isCloseButtonEnabled()

setCloseButtonEnabled

public PopupWindowOptions setCloseButtonEnabled(boolean closeButtonEnabled)

Defines whether close button is enabled in a popup window.

Default value: true.

Parameters:

closeButtonEnabled -

Returns:

the instance of PopupWindowOptions on which this method was called. Useful for a fluent API.

isCloseOnClick

public boolean isCloseOnClick()

Whether popup should be closed when user clicks on the map.

setCloseOnClick

public PopupWindowOptions setCloseOnClick(boolean closeOnClick)

Defines whether popup should be closed when user clicks on the map.

Default value: true.

Parameters:

closeOnClick -

Returns:

the instance of PopupWindowOptions on which this method was called. Useful for a fluent API.

getMaxWidth

public int getMaxWidth()

Returns max width of the popup, in pixels.

setMaxWidth

public PopupWindowOptions setMaxWidth(int maxWidth)

Sets max width of the popup window, in pixels.

Default value: 300.

Parameters:

maxWidth -

Returns:

the instance of PopupWindowOptions on which this method was called. Useful for a fluent API.

getMinWidth

public int getMinWidth()

Returns min width of the popup, in pixels.

setMinWidth

public PopupWindowOptions setMinWidth(int minWidth)

Sets min width of the popup, in pixels.

Default value: 50.

Parameters:

minWidth -

Returns:

the instance of PopupWindowOptions on which this method was called. Useful for a fluent API.