com.haulmont.cuba.web

Class WebWindowManager

java.lang.Object

com.haulmont.cuba.gui.WindowManager

com.haulmont.cuba.web.WebWindowManager

@Component(value="cuba_WebWindowManager")
 @Scope(value="prototype")
public class WebWindowManager
extends WindowManager

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	WebWindowManager.TabCloseTask
static interface	WebWindowManager.WorkAreaContext

Nested classes/interfaces inherited from class com.haulmont.cuba.gui.WindowManager

WindowManager.OpenMode, WindowManager.OpenType, WindowManager.WindowCloseListener

Field Summary

Fields

Modifier and Type	Field and Description
static int	HUMANIZED_NOTIFICATION_DELAY_MSEC
static java.lang.String	NAME
static int	WARNING_NOTIFICATION_DELAY_MSEC

Fields inherited from class com.haulmont.cuba.gui.WindowManager

MAIN_MENU_ACTION_ID

Constructor Summary

Constructors

Constructor and Description
WebWindowManager()

Method Summary

Modifier and Type	Method and Description
void	checkModificationsAndCloseAll(java.lang.Runnable runIfOk) Check modifications and close all screens in all main windows.
void	checkModificationsAndCloseAll(java.lang.Runnable runIfOk, java.lang.Runnable runIfCancel) Check modifications and close all screens in all main windows.
void	close(Window window)
void	closeAll() Close all screens in the main window (browser tab) this WindowManager belongs to.
void	closeAllTabbedWindows()
void	closeAllTabbedWindowsExcept(com.vaadin.ui.ComponentContainer keepOpened)
void	closeAllWindows() Close all screens in all main windows (browser tabs).
com.vaadin.event.ShortcutListener	createCloseShortcut(Window.TopLevelWindow topLevelWindow)
com.vaadin.event.ShortcutListener	createNextWindowTabShortcut(Window.TopLevelWindow topLevelWindow)
com.vaadin.event.ShortcutListener	createPreviousWindowTabShortcut(Window.TopLevelWindow topLevelWindow)
void	createTopLevelWindow(WindowInfo windowInfo)
App	getApp()
WindowBreadCrumbs	getBreadCrumbs(com.vaadin.ui.ComponentContainer container)
java.util.Collection<Window>	getOpenWindows()
void	initDebugIds(Frame frame)
boolean	isOpenAsNewTab(WindowManager.OpenType openType)
void	openDefaultScreen() Opens default screen.
Window.Editor	openEditor(WindowInfo windowInfo, Entity item, WindowManager.OpenType openType, java.util.Map<java.lang.String,java.lang.Object> params, Datasource parentDs)
Window.Lookup	openLookup(WindowInfo windowInfo, Window.Lookup.Handler handler, WindowManager.OpenType openType, java.util.Map<java.lang.String,java.lang.Object> params)
Window	openWindow(WindowInfo windowInfo, WindowManager.OpenType openType, java.util.Map<java.lang.String,java.lang.Object> params)
void	selectWindowTab(Window window) Select tab with window in main tabsheet.
void	setUi(AppUI ui)
void	setWindowCaption(Window window, java.lang.String caption, java.lang.String description)
void	showExceptionDialog(java.lang.Throwable throwable) Shows exception dialog with default caption, message and displays stacktrace of given throwable.
void	showExceptionDialog(java.lang.Throwable throwable, java.lang.String caption, java.lang.String message) Shows exception dialog with given caption, message and displays stacktrace of given throwable.
void	showFrame(Component parent, Frame frame)
void	showMessageDialog(java.lang.String title, java.lang.String message, Frame.MessageType messageType) Show message dialog with title and message.
void	showNotification(java.lang.String caption) Show notification with Frame.NotificationType#HUMANIZED.
void	showNotification(java.lang.String caption, Frame.NotificationType type) Show notification.
void	showNotification(java.lang.String caption, java.lang.String description, Frame.NotificationType type) Show notification with caption description.
void	showOptionDialog(java.lang.String title, java.lang.String message, Frame.MessageType messageType, Action[] actions) Show options dialog with title and message.
void	showWebPage(java.lang.String url, java.util.Map<java.lang.String,java.lang.Object> params) Open a web page in browser.

Methods inherited from class com.haulmont.cuba.gui.WindowManager

getDialogParams, openEditor, openEditor, openEditor, openFrame, openFrame, openFrame, openLookup, openWindow, windowExist

Methods inherited from class java.lang.Object

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

Field Detail

NAME

public static final java.lang.String NAME

See Also:

Constant Field Values

HUMANIZED_NOTIFICATION_DELAY_MSEC

public static final int HUMANIZED_NOTIFICATION_DELAY_MSEC

See Also:

Constant Field Values

WARNING_NOTIFICATION_DELAY_MSEC

public static final int WARNING_NOTIFICATION_DELAY_MSEC

See Also:

Constant Field Values

Constructor Detail

WebWindowManager

public WebWindowManager()

Method Detail

setUi

public void setUi(AppUI ui)

getApp

public App getApp()

getOpenWindows

public java.util.Collection<Window> getOpenWindows()

Specified by:

getOpenWindows in class WindowManager

openWindow

public Window openWindow(WindowInfo windowInfo,
                         WindowManager.OpenType openType,
                         java.util.Map<java.lang.String,java.lang.Object> params)

Overrides:

openWindow in class WindowManager

openLookup

public Window.Lookup openLookup(WindowInfo windowInfo,
                                Window.Lookup.Handler handler,
                                WindowManager.OpenType openType,
                                java.util.Map<java.lang.String,java.lang.Object> params)

Overrides:

openLookup in class WindowManager

openEditor

public Window.Editor openEditor(WindowInfo windowInfo,
                                Entity item,
                                WindowManager.OpenType openType,
                                java.util.Map<java.lang.String,java.lang.Object> params,
                                Datasource parentDs)

Overrides:

openEditor in class WindowManager

selectWindowTab

public void selectWindowTab(Window window)

Description copied from class: WindowManager

Select tab with window in main tabsheet.

Specified by:

selectWindowTab in class WindowManager

setWindowCaption

public void setWindowCaption(Window window,
                             java.lang.String caption,
                             java.lang.String description)

Specified by:

setWindowCaption in class WindowManager

isOpenAsNewTab

public boolean isOpenAsNewTab(WindowManager.OpenType openType)

close

public void close(Window window)

Specified by:

close in class WindowManager

checkModificationsAndCloseAll

public void checkModificationsAndCloseAll(java.lang.Runnable runIfOk)

Check modifications and close all screens in all main windows.

Parameters:

runIfOk - a closure to run after all screens are closed

checkModificationsAndCloseAll

public void checkModificationsAndCloseAll(java.lang.Runnable runIfOk,
                                          @Nullable
                                          java.lang.Runnable runIfCancel)

Check modifications and close all screens in all main windows.

Parameters:

runIfOk - a closure to run after all screens are closed

runIfCancel - a closure to run if there were modifications and a user canceled the operation

closeAllTabbedWindows

public void closeAllTabbedWindows()

closeAllTabbedWindowsExcept

public void closeAllTabbedWindowsExcept(@Nullable
                                        com.vaadin.ui.ComponentContainer keepOpened)

closeAllWindows

public void closeAllWindows()

Close all screens in all main windows (browser tabs).

closeAll

public void closeAll()

Close all screens in the main window (browser tab) this WindowManager belongs to.

showFrame

public void showFrame(Component parent,
                      Frame frame)

showNotification

public void showNotification(java.lang.String caption)

Description copied from class: WindowManager

Show notification with Frame.NotificationType#HUMANIZED.
Supports line breaks (\n).

Specified by:

showNotification in class WindowManager

Parameters:

caption - text

showNotification

public void showNotification(java.lang.String caption,
                             Frame.NotificationType type)

Description copied from class: WindowManager

Show notification.
Supports line breaks (\n).

Specified by:

showNotification in class WindowManager

Parameters:

caption - text

type - defines how to display the notification. Don't forget to escape data from the database in case of *_HTML types!

showNotification

public void showNotification(java.lang.String caption,
                             java.lang.String description,
                             Frame.NotificationType type)

Description copied from class: WindowManager

Show notification with caption description.
Supports line breaks (\n).

Specified by:

showNotification in class WindowManager

Parameters:

caption - caption

description - text

type - defines how to display the notification. Don't forget to escape data from the database in case of *_HTML types!

showMessageDialog

public void showMessageDialog(java.lang.String title,
                              java.lang.String message,
                              Frame.MessageType messageType)

Description copied from class: WindowManager

Show message dialog with title and message.
Supports line breaks (\n) for non HTML messageType.

Specified by:

showMessageDialog in class WindowManager

Parameters:

title - dialog title

message - text

messageType - defines how to display the dialog. Don't forget to escape data from the database in case of *_HTML types!

showOptionDialog

public void showOptionDialog(java.lang.String title,
                             java.lang.String message,
                             Frame.MessageType messageType,
                             Action[] actions)

Description copied from class: WindowManager

Show options dialog with title and message.
Supports line breaks (\n) for non HTML messageType.

Specified by:

showOptionDialog in class WindowManager

Parameters:

title - dialog title

message - text

messageType - defines how to display the dialog. Don't forget to escape data from the database in case of *_HTML types!

actions - available actions

showExceptionDialog

public void showExceptionDialog(java.lang.Throwable throwable)

Description copied from class: WindowManager

Shows exception dialog with default caption, message and displays stacktrace of given throwable.

Specified by:

showExceptionDialog in class WindowManager

Parameters:

throwable - throwable

showExceptionDialog

public void showExceptionDialog(java.lang.Throwable throwable,
                                @Nullable
                                java.lang.String caption,
                                @Nullable
                                java.lang.String message)

Description copied from class: WindowManager

Shows exception dialog with given caption, message and displays stacktrace of given throwable.

Specified by:

showExceptionDialog in class WindowManager

Parameters:

throwable - throwable

caption - dialog caption

message - dialog message

getBreadCrumbs

public WindowBreadCrumbs getBreadCrumbs(com.vaadin.ui.ComponentContainer container)

showWebPage

public void showWebPage(java.lang.String url,
                        @Nullable
                        java.util.Map<java.lang.String,java.lang.Object> params)

Description copied from class: WindowManager

Open a web page in browser.

Specified by:

showWebPage in class WindowManager

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.

initDebugIds

public void initDebugIds(Frame frame)

createTopLevelWindow

public void createTopLevelWindow(WindowInfo windowInfo)

createCloseShortcut

public com.vaadin.event.ShortcutListener createCloseShortcut(Window.TopLevelWindow topLevelWindow)

openDefaultScreen

public void openDefaultScreen()

Description copied from class: WindowManager

Opens default screen. Implemented only for the web module.

Default screen can be defined with the cuba.web.defaultScreenId application property.

Specified by:

openDefaultScreen in class WindowManager

createNextWindowTabShortcut

public com.vaadin.event.ShortcutListener createNextWindowTabShortcut(Window.TopLevelWindow topLevelWindow)

createPreviousWindowTabShortcut

public com.vaadin.event.ShortcutListener createPreviousWindowTabShortcut(Window.TopLevelWindow topLevelWindow)