io.jmix.ui

Interface Screens.OpenedScreens

All Known Implementing Classes:

ScreensImpl.OpenedScreensImpl

Enclosing interface:

Screens

public static interface Screens.OpenedScreens

Provides information about opened screens, does not store state.
Each method obtains current info from UI components tree.

Method Summary

Modifier and Type	Method and Description
java.util.Collection<Screen>	getActiveScreens()
java.util.Collection<Screen>	getActiveWorkAreaScreens()
java.util.Collection<Screen>	getAll()
java.util.Collection<Screen>	getCurrentBreadcrumbs()
java.util.Collection<Screen>	getDialogScreens()
Screen	getRootScreen()
Screen	getRootScreenOrNull()
java.util.Collection<Screen>	getWorkAreaScreens()
java.util.Collection<Screens.WindowStack>	getWorkAreaStacks()

Method Detail

getRootScreen

Screen getRootScreen()

Returns:

the root screen of UI

Throws:

java.lang.IllegalStateException - in case there is no root screen in UI

getRootScreenOrNull

@Nullable
Screen getRootScreenOrNull()

Returns:

the root screen or null

getAll

java.util.Collection<Screen> getAll()

Returns:

all opened screens excluding the root screen or empty collection if there is no root screen or root screen does not have AppWorkArea

getWorkAreaScreens

java.util.Collection<Screen> getWorkAreaScreens()

Returns:

all opened screens excluding the root screen and dialogs or empty collection if there is no root screen or root screen does not have AppWorkArea

getActiveScreens

java.util.Collection<Screen> getActiveScreens()

Returns:

top screens from work area tabs and all dialog windows or empty collection if there is no root screen or root screen does not have AppWorkArea

getActiveWorkAreaScreens

java.util.Collection<Screen> getActiveWorkAreaScreens()

Returns:

top screens from work area tabs or empty collection if there is no root screen or root screen does not have AppWorkArea

getDialogScreens

java.util.Collection<Screen> getDialogScreens()

Returns:

all dialog screens

getCurrentBreadcrumbs

java.util.Collection<Screen> getCurrentBreadcrumbs()

Returns:

screens of the currently opened tab of work area in descending order (first element is active screen) or empty collection if there is no root screen or root screen does not have AppWorkArea

getWorkAreaStacks

java.util.Collection<Screens.WindowStack> getWorkAreaStacks()

Returns:

tab containers or single window container with access to breadcrumbs or empty collection if there is no root screen or root screen does not have AppWorkArea