com.haulmont.cuba.gui.components

Interface ScreenFacet<S extends Screen>

All Superinterfaces:

BeanLocatorAware, Facet

All Known Subinterfaces:

EditorScreenFacet<E,S>, LookupScreenFacet<E,S>

@StudioFacet(xmlElement="screen",
             caption="Screen",
             description="Prepares and shows screens",
             defaultProperty="screenId",
             category="Facets",
             icon="icon/screen.svg",
             documentationURL="https://doc.cuba-platform.com/manual-%VERSION%/gui_ScreenFacet.html")
public interface ScreenFacet<S extends Screen>
extends Facet, BeanLocatorAware

Prepares and shows screens.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ScreenFacet.AfterCloseEvent Event that is fired when screen is closed.
static class	ScreenFacet.AfterShowEvent Event that is fired after screen show.

Method Summary

Modifier and Type	Method and Description
Subscription	addAfterCloseEventListener(java.util.function.Consumer<ScreenFacet.AfterCloseEvent> listener) Adds the given Consumer as screen after close event listener.
Subscription	addAfterShowEventListener(java.util.function.Consumer<ScreenFacet.AfterShowEvent> listener) Adds the given Consumer as screen after show event listener.
S	create()
java.lang.String	getActionTarget()
java.lang.String	getButtonTarget()
Screens.LaunchMode	getLaunchMode()
java.util.function.Supplier<ScreenOptions>	getOptionsProvider()
java.util.Collection<UiControllerProperty>	getProperties()
java.lang.Class<S>	getScreenClass()
java.lang.String	getScreenId()
void	setActionTarget(java.lang.String actionId) Sets that screen should be shown when action with id actionId is performed.
void	setButtonTarget(java.lang.String buttonId) Sets that screen should be shown when button with id actionId is clicked.
void	setLaunchMode(Screens.LaunchMode launchMode) Sets screen Screens.LaunchMode.
void	setOptionsProvider(java.util.function.Supplier<ScreenOptions> optionsProvider) Sets the given Supplier as screen options provider.
void	setProperties(java.util.Collection<UiControllerProperty> properties) Sets properties that will be injected into opened screen via public setters.
void	setScreenClass(java.lang.Class<S> screenClass) Sets class of screen to open.
void	setScreenId(java.lang.String screenId) Sets the id of screen to open.
S	show() Shows and returns screen.

Methods inherited from interface com.haulmont.cuba.gui.components.Facet

getId, getOwner, setId, setOwner

Methods inherited from interface com.haulmont.cuba.core.sys.BeanLocatorAware

setBeanLocator

Method Detail

setScreenId

@StudioProperty(type=STRING)
void setScreenId(java.lang.String screenId)

Sets the id of screen to open.

Parameters:

screenId - screen id

getScreenId

java.lang.String getScreenId()

Returns:

screen id

setScreenClass

@StudioProperty(type=SCREEN_CLASS_NAME,
                typeParameter="S")
void setScreenClass(java.lang.Class<S> screenClass)

Sets class of screen to open.

Parameters:

screenClass - screen class

getScreenClass

java.lang.Class<S> getScreenClass()

Returns:

class of screen to open

setLaunchMode

@StudioProperty(name="openMode",
                type=SCREEN_OPEN_MODE,
                defaultValue="NEW_TAB")
void setLaunchMode(Screens.LaunchMode launchMode)

Sets screen Screens.LaunchMode.

Parameters:

launchMode - launch mode

getLaunchMode

Screens.LaunchMode getLaunchMode()

Returns:

screen Screens.LaunchMode

setOptionsProvider

void setOptionsProvider(java.util.function.Supplier<ScreenOptions> optionsProvider)

Sets the given Supplier as screen options provider.

Parameters:

optionsProvider - screen options provider

getOptionsProvider

java.util.function.Supplier<ScreenOptions> getOptionsProvider()

Returns:

ScreenOptions provider

setProperties

@StudioElementsGroup(xmlElement="properties")
void setProperties(java.util.Collection<UiControllerProperty> properties)

Sets properties that will be injected into opened screen via public setters.

Parameters:

properties - screen properties

getProperties

java.util.Collection<UiControllerProperty> getProperties()

Returns:

properties that will be injected into opened screen via public setters.

getActionTarget

java.lang.String getActionTarget()

Returns:

id of action that triggers screen

setActionTarget

@StudioProperty(name="onAction",
                type=COMPONENT_REF,
                options="com.haulmont.cuba.gui.components.Action")
void setActionTarget(java.lang.String actionId)

Sets that screen should be shown when action with id actionId is performed.

Parameters:

actionId - action id

getButtonTarget

java.lang.String getButtonTarget()

Returns:

id of button that triggers screen

setButtonTarget

@StudioProperty(name="onButton",
                type=COMPONENT_REF,
                options="com.haulmont.cuba.gui.components.Button")
void setButtonTarget(java.lang.String buttonId)

Sets that screen should be shown when button with id actionId is clicked.

Parameters:

buttonId - button id

create

S create()

Returns:

new screen instance

show

S show()

Shows and returns screen.

addAfterShowEventListener

Subscription addAfterShowEventListener(java.util.function.Consumer<ScreenFacet.AfterShowEvent> listener)

Adds the given Consumer as screen after show event listener.

Parameters:

listener - listener

Returns:

after show event subscription

addAfterCloseEventListener

Subscription addAfterCloseEventListener(java.util.function.Consumer<ScreenFacet.AfterCloseEvent> listener)

Adds the given Consumer as screen after close event listener.

Parameters:

listener - listener

Returns:

after close event subscription