io.jmix.ui.component.impl

Class AbstractScreenFacet<S extends Screen>

java.lang.Object

io.jmix.ui.component.impl.AbstractFacet

io.jmix.ui.component.impl.AbstractScreenFacet<S>

All Implemented Interfaces:

Facet, ScreenFacet<S>, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware

Direct Known Subclasses:

AbstractEntityAwareScreenFacet, ScreenFacetImpl

public abstract class AbstractScreenFacet<S extends Screen>
extends AbstractFacet
implements ScreenFacet<S>

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	actionId
protected java.util.List<java.util.function.Consumer<Screen.AfterCloseEvent>>	afterCloseListeners
protected java.util.List<java.util.function.Consumer<Screen.AfterShowEvent>>	afterShowListeners
protected org.springframework.context.ApplicationContext	applicationContext
protected java.lang.String	buttonId
protected OpenMode	openMode
protected java.util.function.Supplier<ScreenOptions>	optionsProvider
protected java.util.Collection<UiControllerProperty>	properties
protected S	screen
protected java.lang.Class<S>	screenClass
protected java.lang.String	screenId

Fields inherited from class io.jmix.ui.component.impl.AbstractFacet

id, owner

Constructor Summary

Constructors

Constructor and Description
AbstractScreenFacet()

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.
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()
protected ScreenOptions	getScreenOptions()
protected void	initScreenListeners(Screen screen)
protected void	injectScreenProperties(S screen, java.util.Collection<UiControllerProperty> properties)
protected void	internalRemoveAfterCloseEventListener(java.util.function.Consumer<Screen.AfterCloseEvent> listener)
protected void	internalRemoveAfterShowEventListener(java.util.function.Consumer<Screen.AfterShowEvent> listener)
void	setActionTarget(java.lang.String actionId) Sets that screen should be shown when action with id actionId is performed.
void	setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
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	setOwner(Frame owner) Sets owner frame (Window or Fragment) to the facet.
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.
protected void	subscribe()
protected void	subscribeOnAction(Frame owner)
protected void	subscribeOnButton(Frame owner)

Methods inherited from class io.jmix.ui.component.impl.AbstractFacet

getEventHub, getId, getOwner, hasSubscriptions, publish, setId, unsubscribe

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.jmix.ui.component.ScreenFacet

create, show

Methods inherited from interface io.jmix.ui.component.Facet

getId, getOwner, setId

Field Detail

applicationContext

protected org.springframework.context.ApplicationContext applicationContext

screenId

protected java.lang.String screenId

screenClass

protected java.lang.Class<S extends Screen> screenClass

openMode

protected OpenMode openMode

optionsProvider

protected java.util.function.Supplier<ScreenOptions> optionsProvider

properties

protected java.util.Collection<UiControllerProperty> properties

actionId

protected java.lang.String actionId

buttonId

protected java.lang.String buttonId

afterShowListeners

protected java.util.List<java.util.function.Consumer<Screen.AfterShowEvent>> afterShowListeners

afterCloseListeners

protected java.util.List<java.util.function.Consumer<Screen.AfterCloseEvent>> afterCloseListeners

screen

protected S extends Screen screen

Constructor Detail

AbstractScreenFacet

public AbstractScreenFacet()

Method Detail

setApplicationContext

public void setApplicationContext(org.springframework.context.ApplicationContext applicationContext)

Specified by:

setApplicationContext in interface org.springframework.context.ApplicationContextAware

setScreenId

public void setScreenId(@Nullable
                        java.lang.String screenId)

Description copied from interface: ScreenFacet

Sets the id of screen to open.

Specified by:

setScreenId in interface ScreenFacet<S extends Screen>

Parameters:

screenId - screen id

getScreenId

@Nullable
public java.lang.String getScreenId()

Specified by:

getScreenId in interface ScreenFacet<S extends Screen>

Returns:

screen id

setScreenClass

public void setScreenClass(@Nullable
                           java.lang.Class<S> screenClass)

Description copied from interface: ScreenFacet

Sets class of screen to open.

Specified by:

setScreenClass in interface ScreenFacet<S extends Screen>

Parameters:

screenClass - screen class

getScreenClass

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

Specified by:

getScreenClass in interface ScreenFacet<S extends Screen>

Returns:

class of screen to open

getOpenMode

public OpenMode getOpenMode()

Specified by:

getOpenMode in interface ScreenFacet<S extends Screen>

Returns:

screen OpenMode

setOpenMode

public void setOpenMode(OpenMode openMode)

Description copied from interface: ScreenFacet

Sets screen OpenMode.

Specified by:

setOpenMode in interface ScreenFacet<S extends Screen>

Parameters:

openMode - an open mode to set

setOptionsProvider

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

Description copied from interface: ScreenFacet

Sets the given Supplier as screen options provider.

Specified by:

setOptionsProvider in interface ScreenFacet<S extends Screen>

Parameters:

optionsProvider - screen options provider

getOptionsProvider

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

Specified by:

getOptionsProvider in interface ScreenFacet<S extends Screen>

Returns:

ScreenOptions provider

setProperties

public void setProperties(java.util.Collection<UiControllerProperty> properties)

Description copied from interface: ScreenFacet

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

Specified by:

setProperties in interface ScreenFacet<S extends Screen>

Parameters:

properties - screen properties

getProperties

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

Specified by:

getProperties in interface ScreenFacet<S extends Screen>

Returns:

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

getActionTarget

@Nullable
public java.lang.String getActionTarget()

Specified by:

getActionTarget in interface ScreenFacet<S extends Screen>

Returns:

id of action that triggers screen

setActionTarget

public void setActionTarget(@Nullable
                            java.lang.String actionId)

Description copied from interface: ScreenFacet

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

Specified by:

setActionTarget in interface ScreenFacet<S extends Screen>

Parameters:

actionId - action id

getButtonTarget

@Nullable
public java.lang.String getButtonTarget()

Specified by:

getButtonTarget in interface ScreenFacet<S extends Screen>

Returns:

id of button that triggers screen

setButtonTarget

public void setButtonTarget(@Nullable
                            java.lang.String buttonId)

Description copied from interface: ScreenFacet

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

Specified by:

setButtonTarget in interface ScreenFacet<S extends Screen>

Parameters:

buttonId - button id

setOwner

public void setOwner(@Nullable
                     Frame owner)

Description copied from interface: Facet

Sets owner frame (Window or Fragment) to the facet.

Specified by:

setOwner in interface Facet

Overrides:

setOwner in class AbstractFacet

Parameters:

owner - owner frame

addAfterShowEventListener

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

Description copied from interface: ScreenFacet

Adds the given Consumer as screen after show event listener.

Specified by:

addAfterShowEventListener in interface ScreenFacet<S extends Screen>

Parameters:

listener - listener

Returns:

after show event subscription

internalRemoveAfterShowEventListener

protected void internalRemoveAfterShowEventListener(java.util.function.Consumer<Screen.AfterShowEvent> listener)

addAfterCloseEventListener

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

Description copied from interface: ScreenFacet

Adds the given Consumer as screen after close event listener.

Specified by:

addAfterCloseEventListener in interface ScreenFacet<S extends Screen>

Parameters:

listener - listener

Returns:

after close event subscription

internalRemoveAfterCloseEventListener

protected void internalRemoveAfterCloseEventListener(java.util.function.Consumer<Screen.AfterCloseEvent> listener)

initScreenListeners

protected void initScreenListeners(Screen screen)

subscribe

protected void subscribe()

subscribeOnAction

protected void subscribeOnAction(Frame owner)

subscribeOnButton

protected void subscribeOnButton(Frame owner)

injectScreenProperties

protected void injectScreenProperties(S screen,
                                      java.util.Collection<UiControllerProperty> properties)

getScreenOptions

protected ScreenOptions getScreenOptions()