io.jmix.ui.screen

Class Screen

java.lang.Object

io.jmix.ui.screen.Screen

All Implemented Interfaces:

FrameOwner

Direct Known Subclasses:

BackgroundWorkDialog, BulkEditorWindow, DateIntervalDialog, FileUploadDialog, InputDialog, JmxConsoleScreen, LayoutAnalyzerScreen, MBeanOperationResultScreen, NotFoundScreen, PivotTableScreen, SelectValueDialog, StandardEditor, StandardLookup, TestMainScreen, ThemeSettingsScreen

public abstract class Screen
extends java.lang.Object
implements FrameOwner

Base class for all screen controllers.

See Also:

Window

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Screen.AfterCloseEvent Event sent after the screen is closed by its close(CloseAction) method and after Screen.AfterDetachEvent.
static class	Screen.AfterDetachEvent Event sent after the screen is removed from the application UI when it is closed by the user or when the user logs out.
static class	Screen.AfterInitEvent Event sent when the screen controller and all its declaratively defined components are created, dependency injection is completed, and all components have completed their internal initialization procedures.
static class	Screen.AfterShowEvent Event sent right after the screen is shown, i.e.
static class	Screen.BeforeCloseEvent Event sent right before the screen is closed by its close(CloseAction) method.
static class	Screen.BeforeShowEvent Event sent right before the screen is shown, i.e.
static class	Screen.InitEvent Event sent when the screen controller and all its declaratively defined components are created, and dependency injection is completed.

Field Summary

Fields inherited from interface io.jmix.ui.screen.FrameOwner

NO_OPTIONS, WINDOW_CLOSE_ACTION, WINDOW_COMMIT_AND_CLOSE_ACTION, WINDOW_DISCARD_AND_CLOSE_ACTION

Constructor Summary

Constructors

Constructor and Description
Screen()

Method Summary

Modifier and Type	Method and Description
io.jmix.core.common.event.Subscription	addAfterCloseListener(java.util.function.Consumer<Screen.AfterCloseEvent> listener) Adds Screen.AfterCloseEvent listener.
protected io.jmix.core.common.event.Subscription	addAfterDetachListener(java.util.function.Consumer<Screen.AfterDetachEvent> listener) Adds Screen.AfterDetachEvent listener.
protected io.jmix.core.common.event.Subscription	addAfterInitListener(java.util.function.Consumer<Screen.AfterInitEvent> listener) Adds Screen.AfterInitEvent listener.
io.jmix.core.common.event.Subscription	addAfterShowListener(java.util.function.Consumer<Screen.AfterShowEvent> listener) Adds Screen.AfterShowEvent listener.
protected io.jmix.core.common.event.Subscription	addBeforeCloseListener(java.util.function.Consumer<Screen.BeforeCloseEvent> listener) Adds Screen.BeforeCloseEvent listener.
protected io.jmix.core.common.event.Subscription	addBeforeShowListener(java.util.function.Consumer<Screen.BeforeShowEvent> listener) Adds Screen.BeforeShowEvent listener.
protected io.jmix.core.common.event.Subscription	addInitListener(java.util.function.Consumer<Screen.InitEvent> listener) Adds Screen.InitEvent listener.
protected io.jmix.core.common.event.Subscription	addUrlParamsChangeListener(java.util.function.Consumer<UrlParamsChangedEvent> listener) Adds UrlParamsChangedEvent listener.
OperationResult	close(CloseAction action) Requests closing of the screen caused by the given action.
OperationResult	close(StandardOutcome outcome) Requests closing of the screen with the given outcome.
OperationResult	closeWithDefaultAction() Closes the screen with FrameOwner.WINDOW_CLOSE_ACTION action.
protected <E> void	fireEvent(java.lang.Class<E> eventType, E event)
protected org.springframework.context.ApplicationContext	getApplicationContext()
protected io.jmix.core.common.event.EventHub	getEventHub()
protected java.util.Map<java.lang.Class<?>,java.lang.Object>	getExtensions()
java.lang.String	getId()
protected ScreenData	getScreenData()
protected java.util.List<org.springframework.context.ApplicationListener>	getUiEventListeners()
Window	getWindow()
protected boolean	isMultipleOpen()
protected boolean	isSameScreen(Screen openedScreen) Compares this screen with an already opened screen.
protected void	setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
protected void	setExtensions(java.util.Map<java.lang.Class<?>,java.lang.Object> extensions)
protected void	setId(java.lang.String id) Sets id of the screen.
protected void	setScreenData(ScreenData data)
protected void	setUiEventListeners(java.util.List<org.springframework.context.ApplicationListener> listeners)
protected void	setWindow(Window window)
Screen	show() Shows this screen.

Methods inherited from class java.lang.Object

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

Constructor Detail

Screen

public Screen()

Method Detail

getApplicationContext

protected org.springframework.context.ApplicationContext getApplicationContext()

setApplicationContext

@Autowired
protected void setApplicationContext(org.springframework.context.ApplicationContext applicationContext)

getEventHub

protected io.jmix.core.common.event.EventHub getEventHub()

getExtensions

@Nullable
protected java.util.Map<java.lang.Class<?>,java.lang.Object> getExtensions()

setExtensions

protected void setExtensions(@Nullable
                             java.util.Map<java.lang.Class<?>,java.lang.Object> extensions)

getId

@Nullable
public java.lang.String getId()

setId

protected void setId(@Nullable
                     java.lang.String id)

Sets id of the screen. Called by the framework during screen init to assign screen id.

Parameters:

id - screen id

getScreenData

protected ScreenData getScreenData()

setScreenData

protected void setScreenData(ScreenData data)

fireEvent

protected <E> void fireEvent(java.lang.Class<E> eventType,
                             E event)

getWindow

public Window getWindow()

Returns:

screen UI component

setWindow

protected void setWindow(Window window)

getUiEventListeners

@Nullable
protected java.util.List<org.springframework.context.ApplicationListener> getUiEventListeners()

setUiEventListeners

protected void setUiEventListeners(@Nullable
                                   java.util.List<org.springframework.context.ApplicationListener> listeners)

addInitListener

protected io.jmix.core.common.event.Subscription addInitListener(java.util.function.Consumer<Screen.InitEvent> listener)

Adds Screen.InitEvent listener.

You can also add an event listener declaratively using a controller method annotated with Subscribe:

    @Subscribe
    protected void onInit(InitEvent event) {
       // handle event here
    }
 

Parameters:

listener - listener

Returns:

subscription

addAfterInitListener

protected io.jmix.core.common.event.Subscription addAfterInitListener(java.util.function.Consumer<Screen.AfterInitEvent> listener)

Adds Screen.AfterInitEvent listener.

You can also add an event listener declaratively using a controller method annotated with Subscribe:

    @Subscribe
    protected void onAfterInit(AfterInitEvent event) {
       // handle event here
    }
 

Parameters:

listener - listener

Returns:

subscription

addBeforeCloseListener

protected io.jmix.core.common.event.Subscription addBeforeCloseListener(java.util.function.Consumer<Screen.BeforeCloseEvent> listener)

Adds Screen.BeforeCloseEvent listener.

You can also add an event listener declaratively using a controller method annotated with Subscribe:

    @Subscribe
    protected void onBeforeClose(BeforeCloseEvent event) {
       // handle event here
    }
 

Parameters:

listener - listener

Returns:

subscription

addBeforeShowListener

protected io.jmix.core.common.event.Subscription addBeforeShowListener(java.util.function.Consumer<Screen.BeforeShowEvent> listener)

Adds Screen.BeforeShowEvent listener.

You can also add an event listener declaratively using a controller method annotated with Subscribe:

    @Subscribe
    protected void onBeforeShow(BeforeShowEvent event) {
       // handle event here
    }
 

Parameters:

listener - listener

Returns:

subscription

addAfterShowListener

public io.jmix.core.common.event.Subscription addAfterShowListener(java.util.function.Consumer<Screen.AfterShowEvent> listener)

Adds Screen.AfterShowEvent listener.

You can also add an event listener declaratively using a controller method annotated with Subscribe:

    @Subscribe
    protected void onAfterShow(AfterShowEvent event) {
       // handle event here
    }
 

Parameters:

listener - listener

Returns:

subscription

addAfterCloseListener

public io.jmix.core.common.event.Subscription addAfterCloseListener(java.util.function.Consumer<Screen.AfterCloseEvent> listener)

Adds Screen.AfterCloseEvent listener.

You can also add an event listener declaratively using a controller method annotated with Subscribe:

    @Subscribe
    protected void onAfterClose(AfterCloseEvent event) {
       // handle event here
    }
 

Parameters:

listener - listener

Returns:

subscription

addAfterDetachListener

protected io.jmix.core.common.event.Subscription addAfterDetachListener(java.util.function.Consumer<Screen.AfterDetachEvent> listener)

Adds Screen.AfterDetachEvent listener.

You can also add an event listener declaratively using a controller method annotated with Subscribe:

    @Subscribe
    protected void onAfterDetach(AfterDetachEvent event) {
       // handle event here
    }
 

Parameters:

listener - listener

Returns:

subscription

addUrlParamsChangeListener

protected io.jmix.core.common.event.Subscription addUrlParamsChangeListener(java.util.function.Consumer<UrlParamsChangedEvent> listener)

Adds UrlParamsChangedEvent listener.

You can also add an event listener declaratively using a controller method annotated with Subscribe:

    @Subscribe
    protected void onUrlParamsChanged(UrlParamsChangedEvent event) {
       // handle event here
    }
 

Parameters:

listener - listener

Returns:

subscription

show

public Screen show()

Shows this screen.

See Also:

Screens.show(Screen)

close

public OperationResult close(CloseAction action)

Requests closing of the screen caused by the given action.

Parameters:

action - close action which is propagated to Screen.BeforeCloseEvent and Screen.AfterCloseEvent

Returns:

result of operation

closeWithDefaultAction

public OperationResult closeWithDefaultAction()

Closes the screen with FrameOwner.WINDOW_CLOSE_ACTION action.

Returns:

result of close request

close

public OperationResult close(StandardOutcome outcome)

Requests closing of the screen with the given outcome.

Parameters:

outcome - StandardOutcome

Returns:

result of operation

isMultipleOpen

protected boolean isMultipleOpen()

Returns:

true if screen can be opened multiple times from a navigation menu

isSameScreen

protected boolean isSameScreen(Screen openedScreen)

Compares this screen with an already opened screen.

Parameters:

openedScreen - already opened screen

Returns:

true if screens are the same