public interface Screens
ScreenBuilders
Modifier and Type | Interface and Description |
---|---|
static interface |
Screens.LaunchMode
Marker interface for screen launch modes.
|
static interface |
Screens.OpenedScreens
Provides information about opened screens, does not store state.
|
static interface |
Screens.WindowStack
Represents single tab / window stack in
AppWorkArea . |
Modifier and Type | Field and Description |
---|---|
static CloseAction |
NAVIGATION_CLOSE_ACTION
Constant that is passed to
Screen.close(CloseAction) when the screen is closed by screens manager. |
static java.lang.String |
NAVIGATION_CLOSE_ACTION_ID |
Modifier and Type | Method and Description |
---|---|
default <T extends Screen> |
create(java.lang.Class<T> screenClass)
Creates a screen by its controller class.
|
default <T extends Screen> |
create(java.lang.Class<T> screenClass,
Screens.LaunchMode launchMode)
Creates a screen by its controller class.
|
<T extends Screen> |
create(java.lang.Class<T> screenClass,
Screens.LaunchMode launchMode,
ScreenOptions options)
Creates a screen by its controller class.
|
default Screen |
create(java.lang.String screenId,
Screens.LaunchMode launchMode)
Creates a screen by its screen id.
|
Screen |
create(java.lang.String screenId,
Screens.LaunchMode launchMode,
ScreenOptions options)
Creates a screen by its screen id.
|
Screens.OpenedScreens |
getOpenedScreens() |
boolean |
hasUnsavedChanges()
Check if there are screens that have unsaved changes.
|
void |
remove(Screen screen)
Removes screen from UI and releases all the resources of screen.
|
void |
removeAll()
Removes all child screens (screens of work area and dialog screens) from the root screen and releases their resources.
|
void |
show(Screen screen)
Displays the given screen according to its
Screens.LaunchMode . |
OperationResult |
showFromNavigation(Screen screen)
Displays the given screen taking into account already opened screens and multipleOpen option.
|
static final java.lang.String NAVIGATION_CLOSE_ACTION_ID
static final CloseAction NAVIGATION_CLOSE_ACTION
Screen.close(CloseAction)
when the screen is closed by screens manager.default <T extends Screen> T create(java.lang.Class<T> screenClass)
By default, the screen will be opened in the current tab of the main window (OpenMode.THIS_TAB
).
screenClass
- screen controller classdefault <T extends Screen> T create(java.lang.Class<T> screenClass, Screens.LaunchMode launchMode)
screenClass
- screen controller classlaunchMode
- how the screen should be openeddefault Screen create(java.lang.String screenId, Screens.LaunchMode launchMode)
screenId
- screen idlaunchMode
- how the screen should be opened<T extends Screen> T create(java.lang.Class<T> screenClass, Screens.LaunchMode launchMode, ScreenOptions options)
screenClass
- screen controller classlaunchMode
- how the screen should be openedoptions
- screen parametersScreen create(java.lang.String screenId, Screens.LaunchMode launchMode, ScreenOptions options)
screenId
- screen idlaunchMode
- how the screen should be openedoptions
- screen parametersvoid show(Screen screen)
Screens.LaunchMode
.screen
- screenOperationResult showFromNavigation(Screen screen)
screen
- screenvoid remove(Screen screen)
screen
- screenvoid removeAll()
boolean hasUnsavedChanges()
Screens.OpenedScreens getOpenedScreens()