Package io.jmix.ui.sys

Class WebBrowserToolsImpl

java.lang.Object

io.jmix.ui.sys.WebBrowserToolsImpl

All Implemented Interfaces:

WebBrowserTools

@UIScope
@Component("ui_WebBrowserTools")
public class WebBrowserToolsImpl
extends Object
implements WebBrowserTools

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BEFORE_UNLOAD_LISTENER
protected AppUI	ui

Constructor Summary

Constructors

Constructor	Description
WebBrowserToolsImpl()

Method Summary

Modifier and Type	Method	Description
void	allowBrowserTabClosing()	Removes 'onbeforeunload' listener.
void	preventBrowserTabClosing()	Adds 'onbeforeunload' listener that prevents browser tab from closing.
void	setAppUi(AppUI ui)
void	showWebPage(String url, Map<String,Object> params)	Open a web page in browser.

Methods inherited from class java.lang.Object

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

Field Details

BEFORE_UNLOAD_LISTENER

public static final String BEFORE_UNLOAD_LISTENER

See Also:

• Constant Field Values

ui

protected AppUI ui

Constructor Details

WebBrowserToolsImpl

public WebBrowserToolsImpl()

Method Details

setAppUi

@Autowired
public void setAppUi(AppUI ui)

showWebPage

public void showWebPage(String url,
 @Nullable
 Map<String,Object> params)

Description copied from interface: WebBrowserTools

Open a web page in browser.

Specified by:

showWebPage in interface WebBrowserTools

Parameters:

url - URL of the page

params - optional parameters.
The following parameters are recognized by Web client:

• target - String value used as the target name in a window.open call in the client. This means that special values such as "_blank", "_self", "_top", "_parent" have special meaning. If not specified, "_blank" is used.
• width - Integer value specifying the width of the browser window in pixels
• height - Integer value specifying the height of the browser window in pixels
• border - String value specifying the border style of the window of the browser window. Possible values are "DEFAULT", "MINIMAL", "NONE".

Desktop client doesn't support any parameters and just ignores them.

preventBrowserTabClosing

public void preventBrowserTabClosing()

Description copied from interface: WebBrowserTools

Adds 'onbeforeunload' listener that prevents browser tab from closing.

Specified by:

preventBrowserTabClosing in interface WebBrowserTools

allowBrowserTabClosing

public void allowBrowserTabClosing()

Description copied from interface: WebBrowserTools

Removes 'onbeforeunload' listener.

Specified by:

allowBrowserTabClosing in interface WebBrowserTools