public abstract class WindowManager
extends java.lang.Object
Modifier and Type | Class and Description |
---|---|
static class |
WindowManager.OpenMode |
static class |
WindowManager.OpenType
|
static interface |
WindowManager.WindowCloseListener |
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
MAIN_MENU_ACTION_ID
Constant that is passed to
Window.close(String) and Window.close(String, boolean) methods when
the screen is closed by window manager. |
Modifier and Type | Method and Description |
---|---|
abstract void |
close(Window window) |
DialogParams |
getDialogParams()
Deprecated.
|
abstract java.util.Collection<Window> |
getOpenWindows() |
abstract void |
openDefaultScreen()
Opens default screen.
|
Window.Editor |
openEditor(WindowInfo windowInfo,
Entity item,
WindowManager.OpenType openType) |
Window.Editor |
openEditor(WindowInfo windowInfo,
Entity item,
WindowManager.OpenType openType,
Datasource parentDs) |
Window.Editor |
openEditor(WindowInfo windowInfo,
Entity item,
WindowManager.OpenType openType,
java.util.Map<java.lang.String,java.lang.Object> params) |
Window.Editor |
openEditor(WindowInfo windowInfo,
Entity item,
WindowManager.OpenType openType,
java.util.Map<java.lang.String,java.lang.Object> params,
Datasource parentDs) |
Frame |
openFrame(Frame parentFrame,
Component parent,
java.lang.String id,
WindowInfo windowInfo,
java.util.Map<java.lang.String,java.lang.Object> params) |
Frame |
openFrame(Frame parentFrame,
Component parent,
WindowInfo windowInfo) |
Frame |
openFrame(Frame parentFrame,
Component parent,
WindowInfo windowInfo,
java.util.Map<java.lang.String,java.lang.Object> params) |
Window.Lookup |
openLookup(WindowInfo windowInfo,
Window.Lookup.Handler handler,
WindowManager.OpenType openType) |
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) |
Window |
openWindow(WindowInfo windowInfo,
WindowManager.OpenType openType,
java.util.Map<java.lang.String,java.lang.Object> params) |
abstract void |
selectWindowTab(Window window)
Select tab with window in main tabsheet.
|
abstract void |
setWindowCaption(Window window,
java.lang.String caption,
java.lang.String description)
Deprecated.
Please use
Component.HasCaption.setCaption(String) ()} and Component.HasCaption.setDescription(String) ()} methods. |
abstract void |
showExceptionDialog(java.lang.Throwable throwable)
Shows exception dialog with default caption, message and displays stacktrace of given throwable.
|
abstract 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.
|
abstract void |
showMessageDialog(java.lang.String title,
java.lang.String message,
Frame.MessageType messageType)
Show message dialog with title and message.
|
abstract void |
showNotification(java.lang.String caption)
Show notification with
Frame.NotificationType#HUMANIZED . |
abstract void |
showNotification(java.lang.String caption,
Frame.NotificationType type)
Show notification.
|
abstract void |
showNotification(java.lang.String caption,
java.lang.String description,
Frame.NotificationType type)
Show notification with caption description.
|
abstract void |
showOptionDialog(java.lang.String title,
java.lang.String message,
Frame.MessageType messageType,
Action[] actions)
Show options dialog with title and message.
|
abstract void |
showWebPage(java.lang.String url,
java.util.Map<java.lang.String,java.lang.Object> params)
Open a web page in browser.
|
boolean |
windowExist(WindowInfo windowInfo,
java.util.Map<java.lang.String,java.lang.Object> params) |
public static final java.lang.String MAIN_MENU_ACTION_ID
Window.close(String)
and Window.close(String, boolean)
methods when
the screen is closed by window manager. Propagated to Window.CloseListener#windowClosed
.public abstract java.util.Collection<Window> getOpenWindows()
public abstract void selectWindowTab(Window window)
@Deprecated public abstract void setWindowCaption(Window window, java.lang.String caption, java.lang.String description)
Component.HasCaption.setCaption(String)
()} and Component.HasCaption.setDescription(String)
()} methods.public boolean windowExist(WindowInfo windowInfo, java.util.Map<java.lang.String,java.lang.Object> params)
public Window openWindow(WindowInfo windowInfo, WindowManager.OpenType openType, java.util.Map<java.lang.String,java.lang.Object> params)
public Window openWindow(WindowInfo windowInfo, WindowManager.OpenType openType)
public Window.Editor openEditor(WindowInfo windowInfo, Entity item, WindowManager.OpenType openType, Datasource parentDs)
public Window.Editor openEditor(WindowInfo windowInfo, Entity item, WindowManager.OpenType openType)
public Window.Editor openEditor(WindowInfo windowInfo, Entity item, WindowManager.OpenType openType, java.util.Map<java.lang.String,java.lang.Object> params)
public Window.Editor openEditor(WindowInfo windowInfo, Entity item, WindowManager.OpenType openType, java.util.Map<java.lang.String,java.lang.Object> params, Datasource parentDs)
public Window.Lookup openLookup(WindowInfo windowInfo, Window.Lookup.Handler handler, WindowManager.OpenType openType, java.util.Map<java.lang.String,java.lang.Object> params)
public Window.Lookup openLookup(WindowInfo windowInfo, Window.Lookup.Handler handler, WindowManager.OpenType openType)
public Frame openFrame(Frame parentFrame, Component parent, WindowInfo windowInfo)
public Frame openFrame(Frame parentFrame, Component parent, WindowInfo windowInfo, java.util.Map<java.lang.String,java.lang.Object> params)
public Frame openFrame(Frame parentFrame, Component parent, @Nullable java.lang.String id, WindowInfo windowInfo, java.util.Map<java.lang.String,java.lang.Object> params)
@Deprecated public DialogParams getDialogParams()
public abstract void close(Window window)
public abstract void openDefaultScreen()
Default screen can be defined with the cuba.web.defaultScreenId
application property.
public abstract void showNotification(java.lang.String caption)
Frame.NotificationType#HUMANIZED
. \n
).caption
- textpublic abstract void showNotification(java.lang.String caption, Frame.NotificationType type)
\n
).caption
- texttype
- defines how to display the notification.
Don't forget to escape data from the database in case of *_HTML
types!public abstract void showNotification(java.lang.String caption, java.lang.String description, Frame.NotificationType type)
\n
).caption
- captiondescription
- texttype
- defines how to display the notification.
Don't forget to escape data from the database in case of *_HTML
types!public abstract void showMessageDialog(java.lang.String title, java.lang.String message, Frame.MessageType messageType)
\n
) for non HTML messageType.title
- dialog titlemessage
- textmessageType
- defines how to display the dialog.
Don't forget to escape data from the database in case of *_HTML
types!public abstract void showOptionDialog(java.lang.String title, java.lang.String message, Frame.MessageType messageType, Action[] actions)
\n
) for non HTML messageType.title
- dialog titlemessage
- textmessageType
- defines how to display the dialog.
Don't forget to escape data from the database in case of *_HTML
types!actions
- available actionspublic abstract void showExceptionDialog(java.lang.Throwable throwable)
throwable
- throwablepublic abstract void showExceptionDialog(java.lang.Throwable throwable, @Nullable java.lang.String caption, @Nullable java.lang.String message)
throwable
- throwablecaption
- dialog captionmessage
- dialog messagepublic abstract void showWebPage(java.lang.String url, @Nullable java.util.Map<java.lang.String,java.lang.Object> params)
url
- URL of the pageparams
- optional parameters.
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 pixelsheight
- Integer value specifying the height of the browser window in pixelsborder
- String value specifying the border style of the window of the browser window.
Possible values are "DEFAULT", "MINIMAL", "NONE".