Package io.jmix.flowui.xml.layout.loader

Class AbstractLoaderContext

java.lang.Object

io.jmix.flowui.xml.layout.loader.AbstractLoaderContext

All Implemented Interfaces:

ComponentLoader.Context

Direct Known Subclasses:

ComponentLoaderContext, FragmentLoaderContext, MenuLoaderContext

public abstract class AbstractLoaderContext
extends Object
implements ComponentLoader.Context

Field Summary

Fields

Modifier and Type	Field	Description
protected HasActions	actionsHolder
protected HasDataComponents	dataHolder
protected String	fullOriginId
protected List<ComponentLoader.InitTask>	initTasks
protected String	messageGroup
protected ComponentLoader.Context	parentContext
protected List<ComponentLoader.InitTask>	preInitTasks

Constructor Summary

Constructors

Constructor	Description
AbstractLoaderContext()

Method Summary

Modifier and Type	Method	Description
void	addInitTask(ComponentLoader.InitTask task)	Adds ComponentLoader.InitTask that will be executed according to the origin component lifecycle.
void	addPreInitTask(ComponentLoader.InitTask task)	Adds Pre ComponentLoader.InitTask that will be executed according to the origin component lifecycle.
void	executeInitTasks()	Executes all added ComponentLoader.InitTasks
void	executePreInitTasks()	Executes all added ComponentLoader.InitTasks
HasActions	getActionsHolder()
HasDataComponents	getDataHolder()
String	getFullOriginId()
String	getMessageGroup()
@Nullable ComponentLoader.Context	getParentContext()
void	setActionsHolder(HasActions actionsHolder)
void	setDataHolder(HasDataComponents dataHolder)
void	setFullOriginId(String fullOriginId)
void	setMessageGroup(String messageGroup)
void	setParentContext(@Nullable ComponentLoader.Context parentContext)

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.jmix.flowui.xml.layout.ComponentLoader.Context

getOrigin

Field Details

fullOriginId

protected String fullOriginId

parentContext

protected ComponentLoader.Context parentContext

dataHolder

protected HasDataComponents dataHolder

actionsHolder

protected HasActions actionsHolder

messageGroup

protected String messageGroup

preInitTasks

protected List<ComponentLoader.InitTask> preInitTasks

initTasks

protected List<ComponentLoader.InitTask> initTasks

Constructor Details

AbstractLoaderContext

public AbstractLoaderContext()

Method Details

getFullOriginId

public String getFullOriginId()

Specified by:

getFullOriginId in interface ComponentLoader.Context

Returns:

a target component id, including parent component ids

setFullOriginId

public void setFullOriginId(String fullOriginId)

getParentContext

public @Nullable ComponentLoader.Context getParentContext()

Specified by:

getParentContext in interface ComponentLoader.Context

Returns:

parent loader context

setParentContext

public void setParentContext(@Nullable ComponentLoader.Context parentContext)

getMessageGroup

public String getMessageGroup()

Specified by:

getMessageGroup in interface ComponentLoader.Context

Returns:

a message group associated with XML descriptor

setMessageGroup

public void setMessageGroup(String messageGroup)

getActionsHolder

public HasActions getActionsHolder()

Specified by:

getActionsHolder in interface ComponentLoader.Context

Returns:

an object that stores actions associated with the origin component

setActionsHolder

public void setActionsHolder(HasActions actionsHolder)

getDataHolder

public HasDataComponents getDataHolder()

Specified by:

getDataHolder in interface ComponentLoader.Context

Returns:

an object that stores data components associated with the origin component

setDataHolder

public void setDataHolder(HasDataComponents dataHolder)

addPreInitTask

public void addPreInitTask(ComponentLoader.InitTask task)

Description copied from interface: ComponentLoader.Context

Adds Pre ComponentLoader.InitTask that will be executed according to the origin component lifecycle.

Note: Pre InitTasks will be executed before DependencyManager invocation to have precedence over @Subscribe methods

Specified by:

addPreInitTask in interface ComponentLoader.Context

Parameters:

task - a task to add

executePreInitTasks

public void executePreInitTasks()

Description copied from interface: ComponentLoader.Context

Executes all added ComponentLoader.InitTasks

Specified by:

executePreInitTasks in interface ComponentLoader.Context

addInitTask

public void addInitTask(ComponentLoader.InitTask task)

Description copied from interface: ComponentLoader.Context

Adds ComponentLoader.InitTask that will be executed according to the origin component lifecycle.

Specified by:

addInitTask in interface ComponentLoader.Context

Parameters:

task - a task to add

executeInitTasks

public void executeInitTasks()

Description copied from interface: ComponentLoader.Context

Executes all added ComponentLoader.InitTasks

Specified by:

executeInitTasks in interface ComponentLoader.Context