io.jmix.ui.component

Interface ScreenFacet<S extends Screen>

All Superinterfaces:

org.springframework.context.ApplicationContextAware, org.springframework.beans.factory.Aware, Facet

All Known Subinterfaces:

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

All Known Implementing Classes:

AbstractEntityAwareScreenFacet, AbstractScreenFacet, EditorScreenFacetImpl, LookupScreenFacetImpl, ScreenFacetImpl

@StudioFacet(xmlElement="screen",
             caption="Screen",
             description="Prepares and shows screens",
             defaultProperty="screenId",
             category="Facets",
             icon="io/jmix/ui/icon/facet/screen.svg")
public interface ScreenFacet<S extends Screen>
extends Facet, org.springframework.context.ApplicationContextAware

Prepares and shows screens.

Method Summary

Modifier and Type	Method and Description
io.jmix.core.common.event.Subscription	addAfterCloseEventListener(java.util.function.Consumer<Screen.AfterCloseEvent> listener) Adds the given Consumer as screen after close event listener.
io.jmix.core.common.event.Subscription	addAfterShowEventListener(java.util.function.Consumer<Screen.AfterShowEvent> listener) Adds the given Consumer as screen after show event listener.
S	create()
java.lang.String	getActionTarget()
java.lang.String	getButtonTarget()
OpenMode	getOpenMode()
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	setOpenMode(OpenMode openMode) Sets screen OpenMode.
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 io.jmix.ui.component.Facet

getId, getOwner, setId, setOwner

Methods inherited from interface org.springframework.context.ApplicationContextAware

setApplicationContext

Method Detail

setScreenId

@StudioProperty(type=SCREEN_ID,
                typeParameter="S")
void setScreenId(@Nullable
                                                                                    java.lang.String screenId)

Sets the id of screen to open.

Parameters:

screenId - screen id

getScreenId

@Nullable
java.lang.String getScreenId()

Returns:

screen id

setScreenClass

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

Sets class of screen to open.

Parameters:

screenClass - screen class

getScreenClass

@Nullable
java.lang.Class<S> getScreenClass()

Returns:

class of screen to open

getOpenMode

OpenMode getOpenMode()

Returns:

screen OpenMode

setOpenMode

@StudioProperty(name="openMode",
                type=SCREEN_OPEN_MODE,
                defaultValue="NEW_TAB")
void setOpenMode(OpenMode openMode)

Sets screen OpenMode.

Parameters:

openMode - an open mode to set

setOptionsProvider

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

Sets the given Supplier as screen options provider.

Parameters:

optionsProvider - screen options provider

getOptionsProvider

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

Returns:

ScreenOptions provider

setProperties

@StudioElementsGroup(caption="Properties",
                     xmlElement="properties",
                     icon="io/jmix/ui/icon/element/properties.svg")
void setProperties(java.util.Collection<UiControllerProperty> properties)

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

Parameters:

properties - screen properties

getProperties

@Nullable
java.util.Collection<UiControllerProperty> getProperties()

Returns:

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

getActionTarget

@Nullable
java.lang.String getActionTarget()

Returns:

id of action that triggers screen

setActionTarget

@StudioProperty(name="onAction",
                type=COMPONENT_REF,
                options="io.jmix.ui.action.Action")
void setActionTarget(@Nullable
                                                                                                                                              java.lang.String actionId)

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

Parameters:

actionId - action id

getButtonTarget

@Nullable
java.lang.String getButtonTarget()

Returns:

id of button that triggers screen

setButtonTarget

@StudioProperty(name="onButton",
                type=COMPONENT_REF,
                options="io.jmix.ui.component.Button")
void setButtonTarget(@Nullable
                                                                                                                                                 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

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

Adds the given Consumer as screen after show event listener.

Parameters:

listener - listener

Returns:

after show event subscription

addAfterCloseEventListener

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

Adds the given Consumer as screen after close event listener.

Parameters:

listener - listener

Returns:

after close event subscription