io.jmix.ui.sys

Class ScreensImpl.OpenedScreensImpl

java.lang.Object

io.jmix.ui.sys.ScreensImpl.OpenedScreensImpl

All Implemented Interfaces:

Screens.OpenedScreens

Enclosing class:

ScreensImpl

protected class ScreensImpl.OpenedScreensImpl
extends java.lang.Object
implements Screens.OpenedScreens

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	OpenedScreensImpl()

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()

Methods inherited from class java.lang.Object

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

Constructor Detail

OpenedScreensImpl

protected OpenedScreensImpl()

Method Detail

getRootScreen

public Screen getRootScreen()

Specified by:

getRootScreen in interface Screens.OpenedScreens

Returns:

the root screen of UI

getRootScreenOrNull

@Nullable
public Screen getRootScreenOrNull()

Specified by:

getRootScreenOrNull in interface Screens.OpenedScreens

Returns:

the root screen or null

getAll

public java.util.Collection<Screen> getAll()

Specified by:

getAll in interface Screens.OpenedScreens

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

public java.util.Collection<Screen> getWorkAreaScreens()

Specified by:

getWorkAreaScreens in interface Screens.OpenedScreens

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

public java.util.Collection<Screen> getActiveScreens()

Specified by:

getActiveScreens in interface Screens.OpenedScreens

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

public java.util.Collection<Screen> getActiveWorkAreaScreens()

Specified by:

getActiveWorkAreaScreens in interface Screens.OpenedScreens

Returns:

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

getDialogScreens

public java.util.Collection<Screen> getDialogScreens()

Specified by:

getDialogScreens in interface Screens.OpenedScreens

Returns:

all dialog screens

getCurrentBreadcrumbs

public java.util.Collection<Screen> getCurrentBreadcrumbs()

Specified by:

getCurrentBreadcrumbs in interface Screens.OpenedScreens

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

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

Specified by:

getWorkAreaStacks in interface Screens.OpenedScreens

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