Package io.jmix.ui.component.impl

Class EditorScreenFacetImpl<E,S extends Screen & EditorScreen<E>>

java.lang.Object

io.jmix.ui.component.impl.AbstractFacet

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

io.jmix.ui.component.impl.AbstractEntityAwareScreenFacet<E,S>

io.jmix.ui.component.impl.EditorScreenFacetImpl<E,S>

All Implemented Interfaces:

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

public class EditorScreenFacetImpl<E,S extends Screen & EditorScreen<E>>
extends AbstractEntityAwareScreenFacet<E,S>
implements EditorScreenFacet<E,S>

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	addFirst
protected EditMode	editMode
protected Supplier<E>	entityProvider
protected Consumer<E>	initializer
protected Supplier<DataContext>	parentDataContextProvider
protected Function<E,E>	transformation

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

container, entityClass, entityPicker, listComponent

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

actionId, afterCloseListeners, afterShowListeners, applicationContext, buttonId, openMode, optionsProvider, properties, screen, screenClass, screenConfigurer, screenId

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

id, owner

Constructor Summary

Constructors

Constructor	Description
EditorScreenFacetImpl()

Method Summary

Modifier and Type	Method	Description
S	create()
protected EditorBuilder<E>	createEditorBuilder(Frame owner, E entityToEdit)
protected S	createScreen(EditorBuilder<E> builder)
boolean	getAddFirst()
EditMode	getEditMode()
Supplier<E>	getEntityProvider()
protected E	getEntityToEdit()
Consumer<E>	getInitializer()
protected DataContext	getParentDataContext()
Supplier<DataContext>	getParentDataContextProvider()
void	setAddFirst(boolean addFirst)	Defines whether a new item will be added to the beginning or to the end of collection.
void	setEditMode(EditMode editMode)	Sets EditMode to use in editor.
void	setEntityProvider(Supplier<E> entityProvider)	Sets entity provider.
void	setInitializer(Consumer<E> initializer)	Sets code to initialize a new entity instance.
void	setParentDataContextProvider(Supplier<DataContext> parentDataContextProvider)	Sets parent DataContext supplier for the editor screen.
void	setTransformation(Function<E,E> transformation)	Sets code to transform the edited entity after editor commit.
S	show()	Shows and returns screen.

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

getContainer, getEntityClass, getEntityPicker, getListComponent, setContainer, setEntityClass, setEntityPicker, setListComponent

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

addAfterCloseEventListener, addAfterShowEventListener, applyScreenConfigurer, getActionTarget, getButtonTarget, getOpenMode, getOptionsProvider, getProperties, getScreenClass, getScreenConfigurer, getScreenId, getScreenOptions, initScreenListeners, injectScreenProperties, internalRemoveAfterCloseEventListener, internalRemoveAfterShowEventListener, setActionTarget, setApplicationContext, setButtonTarget, setOpenMode, setOptionsProvider, setOwner, setProperties, setScreenClass, setScreenConfigurer, setScreenId, subscribe, subscribeOnAction, subscribeOnButton

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 org.springframework.context.ApplicationContextAware

setApplicationContext

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

getContainer, getEntityClass, getEntityPicker, getListComponent, setContainer, setEntityClass, setEntityPicker, setListComponent

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

getId, getOwner, setId, setOwner

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

addAfterCloseEventListener, addAfterShowEventListener, getActionTarget, getButtonTarget, getOpenMode, getOptionsProvider, getProperties, getScreenClass, getScreenConfigurer, getScreenId, setActionTarget, setButtonTarget, setOpenMode, setOptionsProvider, setProperties, setScreenClass, setScreenConfigurer, setScreenId

Field Details

entityProvider

protected Supplier<E> entityProvider

parentDataContextProvider

protected Supplier<DataContext> parentDataContextProvider

initializer

protected Consumer<E> initializer

transformation

protected Function<E,E> transformation

editMode

protected EditMode editMode

addFirst

protected boolean addFirst

Constructor Details

EditorScreenFacetImpl

public EditorScreenFacetImpl()

Method Details

setEntityProvider

public void setEntityProvider(@Nullable
 Supplier<E> entityProvider)

Description copied from interface: EditorScreenFacet

Sets entity provider.

Specified by:

setEntityProvider in interface EditorScreenFacet<E,S extends Screen & EditorScreen<E>>

Parameters:

entityProvider - entity provider

getEntityProvider

@Nullable
public Supplier<E> getEntityProvider()

Specified by:

getEntityProvider in interface EditorScreenFacet<E,S extends Screen & EditorScreen<E>>

Returns:

entity provider

setInitializer

public void setInitializer(@Nullable
 Consumer<E> initializer)

Description copied from interface: EditorScreenFacet

Sets code to initialize a new entity instance.

The initializer is invoked only when EditMode is CREATE.

Specified by:

setInitializer in interface EditorScreenFacet<E,S extends Screen & EditorScreen<E>>

getInitializer

@Nullable
public Consumer<E> getInitializer()

Specified by:

getInitializer in interface EditorScreenFacet<E,S extends Screen & EditorScreen<E>>

Returns:

entity initializer

setParentDataContextProvider

public void setParentDataContextProvider(@Nullable
 Supplier<DataContext> parentDataContextProvider)

Description copied from interface: EditorScreenFacet

Sets parent DataContext supplier for the editor screen.

The screen will commit data to the parent context instead of directly to DataManager.

Specified by:

setParentDataContextProvider in interface EditorScreenFacet<E,S extends Screen & EditorScreen<E>>

getParentDataContextProvider

@Nullable
public Supplier<DataContext> getParentDataContextProvider()

Specified by:

getParentDataContextProvider in interface EditorScreenFacet<E,S extends Screen & EditorScreen<E>>

Returns:

parent DataContext provider

setTransformation

public void setTransformation(Function<E,E> transformation)

Description copied from interface: EditorScreenFacet

Sets code to transform the edited entity after editor commit.

Applied only if either field or container or listComponent is assigned.

Specified by:

setTransformation in interface EditorScreenFacet<E,S extends Screen & EditorScreen<E>>

Parameters:

transformation - transformation

setEditMode

public void setEditMode(EditMode editMode)

Description copied from interface: EditorScreenFacet

Sets EditMode to use in editor.

Specified by:

setEditMode in interface EditorScreenFacet<E,S extends Screen & EditorScreen<E>>

Parameters:

editMode - edit mode

setAddFirst

public void setAddFirst(boolean addFirst)

Description copied from interface: EditorScreenFacet

Defines whether a new item will be added to the beginning or to the end of collection. Affects only standalone containers, for nested containers new items are always added to the end.

Specified by:

setAddFirst in interface EditorScreenFacet<E,S extends Screen & EditorScreen<E>>

Parameters:

addFirst - add first

getEditMode

public EditMode getEditMode()

Specified by:

getEditMode in interface EditorScreenFacet<E,S extends Screen & EditorScreen<E>>

Returns:

editor edit mode

getAddFirst

public boolean getAddFirst()

Specified by:

getAddFirst in interface EditorScreenFacet<E,S extends Screen & EditorScreen<E>>

Returns:

whether a new item will be added to the beginning or to the end

create

public S create()

Specified by:

create in interface ScreenFacet<E>

Returns:

new screen instance

show

public S show()

Description copied from interface: ScreenFacet

Shows and returns screen.

Specified by:

show in interface ScreenFacet<E>

createScreen

protected S createScreen(EditorBuilder<E> builder)

createEditorBuilder

protected EditorBuilder<E> createEditorBuilder(Frame owner,
 @Nullable
 E entityToEdit)

getEntityToEdit

@Nullable
protected E getEntityToEdit()

getParentDataContext

@Nullable
protected DataContext getParentDataContext()