Package io.jmix.ui.screen

Class ScreenFragment

java.lang.Object

io.jmix.ui.screen.ScreenFragment

All Implemented Interfaces:

FrameOwner

Direct Known Subclasses:

AbstractElementPropertiesFragment, AssignmentDetailsPropertiesFragment, AttributeLocalizationFragment, AttributeLocationFragment, BandDefinitionEditor, BpmnDiagramViewerFragment, CanvasFragment, CategoryAttrsFragment, ChartWidget, ChartWidgetEdit, DescriptionEditFragment, DispatcherPropertiesFragment, EmailAttachmentFragment, EmailTemplateAttachmentsFragment, EmailTemplateParametersFragment, EntityAttributesFragment, EntityListValueFragment, EntityTreeFragment, EntityValueFragment, EnumValueFragment, ErrorRefPropertiesFragment, ExecutionListenersFragment, ExtensionPropertiesFragment, FieldsFragment, FilterConfigurationModelFragment, FormDataPropertiesFragment, ImapEventHandlersFragment, InputParametersFragment, JpqlParametersFragment, JsonChartFragment, MBeanOperationFragment, MessageRefPropertiesFragment, MultiInstanceLoopCharacteristicsPropertiesFragment, PaletteFragment, ParametersFragment, ParametersFragment, PivotTableFragment, ProcessInstanceEditHistoryFragment, ProcessInstanceEditRuntimeFragment, ReportEditGeneralFragment, ReportEditLocalesFragment, ReportEditParametersFragment, ReportEditSecurityFragment, ReportEditTemplatesFragment, ReportEditValueFormatsFragment, RoleAssignmentFragment, RoleFilterFragment, SignalRefPropertiesFragment, SimpleValueFragment, SnapshotDiffViewer, StepFragment, TimerDescriptionPropertiesFragment, UiDataFilterConfigurationModelFragment, UserSubstitutionsFragment, ValueFormatsFragment

public abstract class ScreenFragment
extends Object
implements FrameOwner

Base class for all fragment controllers.

See Also:

• Fragment

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ScreenFragment.AfterInitEvent	Event sent when the fragment controller is created, dependency injection is completed, and all components have completed their internal initialization procedures.
static class	ScreenFragment.AttachEvent	Event sent when the fragment controller is initialized and added to host screen.
static class	ScreenFragment.DetachEvent	Event sent when the fragment controller has been removed from host screen.
static class	ScreenFragment.InitEvent	Event sent when the fragment controller is created and dependency injection is completed.

Field Summary

Fields inherited from interface io.jmix.ui.screen.FrameOwner

NO_OPTIONS, WINDOW_CLOSE_ACTION, WINDOW_COMMIT_AND_CLOSE_ACTION, WINDOW_DISCARD_AND_CLOSE_ACTION

Constructor Summary

Constructors

Constructor	Description
ScreenFragment()

Method Summary

Modifier and Type	Method	Description
protected Subscription	addAfterInitListener(Consumer<ScreenFragment.AfterInitEvent> listener)	Adds ScreenFragment.AfterInitEvent listener.
protected Subscription	addAttachEventListener(Consumer<ScreenFragment.AttachEvent> listener)	Adds ScreenFragment.AttachEvent listener.
protected Subscription	addDetachEventListener(Consumer<ScreenFragment.DetachEvent> listener)	Adds ScreenFragment.DetachEvent listener.
protected Subscription	addInitListener(Consumer<ScreenFragment.InitEvent> listener)	Adds ScreenFragment.InitEvent listener.
protected <E> void	fireEvent(Class<E> eventType, E event)
protected org.springframework.context.ApplicationContext	getApplicationContext()
protected EventHub	getEventHub()
protected Map<Class<?>,Object>	getExtensions()
Fragment	getFragment()
FrameOwner	getHostController()
protected Screen	getHostScreen()
String	getId()
protected ScreenData	getScreenData()
protected List<org.springframework.context.ApplicationListener>	getUiEventListeners()
ScreenFragment	init()	Convenient method to perform programmatic initialization of the fragment.
protected void	setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
protected void	setExtensions(Map<Class<?>,Object> extensions)
protected void	setFragment(Fragment fragment)
protected void	setHostController(FrameOwner hostController)
protected void	setId(String id)	Sets id of the screen fragment.
protected void	setScreenData(ScreenData data)
protected void	setUiEventListeners(List<org.springframework.context.ApplicationListener> listeners)

Methods inherited from class java.lang.Object

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

Constructor Details

ScreenFragment

public ScreenFragment()

Method Details

setApplicationContext

@Autowired
protected void setApplicationContext(org.springframework.context.ApplicationContext applicationContext)

getApplicationContext

protected org.springframework.context.ApplicationContext getApplicationContext()

getExtensions

@Nullable
protected Map<Class<?>,Object> getExtensions()

setExtensions

protected void setExtensions(@Nullable
 Map<Class<?>,Object> extensions)

getEventHub

protected EventHub getEventHub()

fireEvent

protected <E> void fireEvent(Class<E> eventType,
 E event)

setFragment

protected void setFragment(Fragment fragment)

getFragment

public Fragment getFragment()

getHostController

public FrameOwner getHostController()

setHostController

protected void setHostController(FrameOwner hostController)

getHostScreen

protected Screen getHostScreen()

Returns:

host screen of the fragment

Throws:

IllegalStateException - if host screen cannot be found though hierarchy of fragments

setId

protected void setId(@Nullable
 String id)

Sets id of the screen fragment. Called by the framework during screen init to assign screen id.

Parameters:

id - screen id

getId

@Nullable
public String getId()

getScreenData

protected ScreenData getScreenData()

setScreenData

protected void setScreenData(ScreenData data)

getUiEventListeners

@Nullable
protected List<org.springframework.context.ApplicationListener> getUiEventListeners()

setUiEventListeners

protected void setUiEventListeners(@Nullable
 List<org.springframework.context.ApplicationListener> listeners)

init

public ScreenFragment init()

Convenient method to perform programmatic initialization of the fragment.

See Also:

• Fragments.init(ScreenFragment)

addInitListener

protected Subscription addInitListener(Consumer<ScreenFragment.InitEvent> listener)

Adds ScreenFragment.InitEvent listener.

Parameters:

listener - listener

Returns:

subscription

addAfterInitListener

protected Subscription addAfterInitListener(Consumer<ScreenFragment.AfterInitEvent> listener)

Adds ScreenFragment.AfterInitEvent listener.

Parameters:

listener - listener

Returns:

subscription

addAttachEventListener

protected Subscription addAttachEventListener(Consumer<ScreenFragment.AttachEvent> listener)

Adds ScreenFragment.AttachEvent listener.

Parameters:

listener - listener

Returns:

subscription

addDetachEventListener

protected Subscription addDetachEventListener(Consumer<ScreenFragment.DetachEvent> listener)

Adds ScreenFragment.DetachEvent listener.

Parameters:

listener - listener

Returns:

subscription