io.jmix.ui.presentation.facet

Class PresentationsFacetImpl

java.lang.Object

io.jmix.ui.component.impl.AbstractFacet

io.jmix.ui.presentation.facet.PresentationsFacetImpl

All Implemented Interfaces:

Facet, PresentationsFacet, ScreenSettingsFacetResolver.AfterShowEventHandler, ScreenSettingsFacetResolver.PostAfterShowEventHandler

public class PresentationsFacetImpl
extends AbstractFacet
implements PresentationsFacet, ScreenSettingsFacetResolver.AfterShowEventHandler, ScreenSettingsFacetResolver.PostAfterShowEventHandler

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	auto
protected java.util.Set<java.lang.String>	componentIds
protected boolean	isAfterShowHandled
protected boolean	isPostAfterShowHandled
protected PresentationsManager	presentationsManager
protected ScreenSettingsFacetResolver	settingsFacetResolver

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

id, owner

Constructor Summary

Constructors

Constructor and Description
PresentationsFacetImpl()

Method Summary

Modifier and Type	Method and Description
void	addComponentIds(java.lang.String... ids) Adds component ids that should be handled when PresentationsFacet.isAuto() returns false.
protected void	applyDefaultPresentation(java.util.Collection<Component> components)
protected void	checkAttachedFrame()
protected void	commitPresentations(java.util.Collection<Component> components)
protected java.util.Collection<Component>	fillComponents(java.util.Collection<Component> components)
protected java.util.Collection<Component>	fillWithInnerComponents(java.util.Collection<Component> components, HasInnerComponents hasInnerComponents)
java.util.Set<java.lang.String>	getComponentIds()
java.util.Collection<Component>	getComponents() Collection depends on PresentationsFacet.isAuto() property.
protected Screen	getScreenOwner()
boolean	isAuto()
protected boolean	isPresentationsEnabled()
void	onAfterShowEvent(Screen.AfterShowEvent event)
void	onPostAfterShow()
void	setAuto(boolean auto) Set to true if facet should apply and save presentations for all supported component in the screen.
void	setOwner(Frame owner) Sets owner frame (Window or Fragment) to the facet.
protected void	setupDefaultSettings(java.util.Collection<Component> components)
protected void	subscribe()
protected void	unsubscribe()

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.Facet

getId, getOwner, setId

Field Detail

settingsFacetResolver

@Autowired
protected ScreenSettingsFacetResolver settingsFacetResolver

presentationsManager

@Autowired(required=false)
protected PresentationsManager presentationsManager

auto

protected boolean auto

componentIds

protected java.util.Set<java.lang.String> componentIds

isAfterShowHandled

protected boolean isAfterShowHandled

isPostAfterShowHandled

protected boolean isPostAfterShowHandled

Constructor Detail

PresentationsFacetImpl

public PresentationsFacetImpl()

Method Detail

isAuto

public boolean isAuto()

Specified by:

isAuto in interface PresentationsFacet

Returns:

true if facet should apply and save presentations for all supported component in the screen. False by default.

setAuto

public void setAuto(boolean auto)

Description copied from interface: PresentationsFacet

Set to true if facet should apply and save presentations for all supported component in the screen. False by default.

Specified by:

setAuto in interface PresentationsFacet

Parameters:

auto - whether facet should include all components for applying/saving presentations

addComponentIds

public void addComponentIds(java.lang.String... ids)

Description copied from interface: PresentationsFacet

Adds component ids that should be handled when PresentationsFacet.isAuto() returns false.

Note, component must be attached to the Window, otherwise it will be ignored.

Specified by:

addComponentIds in interface PresentationsFacet

Parameters:

ids - component ids

getComponentIds

public java.util.Set<java.lang.String> getComponentIds()

Specified by:

getComponentIds in interface PresentationsFacet

Returns:

list of component ids that should be handled when PresentationsFacet.isAuto() returns false.

getComponents

public java.util.Collection<Component> getComponents()

Description copied from interface: PresentationsFacet

Collection depends on PresentationsFacet.isAuto() property. If PresentationsFacet.isAuto() returns true collection will be filled by Window's components, otherwise collection will be filled by components were added by PresentationsFacet.addComponentIds(String...).

Specified by:

getComponents in interface PresentationsFacet

Returns:

components collection that is used for applying and saving presentations.

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

setupDefaultSettings

protected void setupDefaultSettings(java.util.Collection<Component> components)

applyDefaultPresentation

protected void applyDefaultPresentation(java.util.Collection<Component> components)

commitPresentations

protected void commitPresentations(java.util.Collection<Component> components)

subscribe

protected void subscribe()

unsubscribe

protected void unsubscribe()

onAfterShowEvent

public void onAfterShowEvent(Screen.AfterShowEvent event)

Specified by:

onAfterShowEvent in interface ScreenSettingsFacetResolver.AfterShowEventHandler

onPostAfterShow

public void onPostAfterShow()

Specified by:

onPostAfterShow in interface ScreenSettingsFacetResolver.PostAfterShowEventHandler

checkAttachedFrame

protected void checkAttachedFrame()

getScreenOwner

@Nullable
protected Screen getScreenOwner()

isPresentationsEnabled

protected boolean isPresentationsEnabled()

fillComponents

protected java.util.Collection<Component> fillComponents(java.util.Collection<Component> components)

fillWithInnerComponents

protected java.util.Collection<Component> fillWithInnerComponents(java.util.Collection<Component> components,
                                                                  HasInnerComponents hasInnerComponents)