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

Class ComponentLoaderContext

java.lang.Object

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

io.jmix.flowui.xml.layout.loader.ComponentLoaderContext

All Implemented Interfaces:

ComponentLoader.ComponentContext, ComponentLoader.Context

public class ComponentLoaderContext
extends AbstractLoaderContext
implements ComponentLoader.ComponentContext

Field Summary

Fields

Modifier and Type	Field	Description
protected List<ComponentLoader.AutowireTask>	autowireTasks
protected String	currentFrameId
protected String	fullFrameId
protected List<ComponentLoader.InitTask>	preInitTasks
protected View<?>	view

Fields inherited from class io.jmix.flowui.xml.layout.loader.AbstractLoaderContext

actionsHolder, dataHolder, fullOriginId, initTasks, messageGroup, parentContext

Constructor Summary

Constructors

Constructor	Description
ComponentLoaderContext()

Method Summary

Modifier and Type	Method	Description
void	addAutowireTask(ComponentLoader.AutowireTask task)	Add ComponentLoader.AutowireTask 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	executeAutowireTasks()	Executed all added ComponentLoader.AutowireTasks
void	executePreInitTasks()	Executes all added ComponentLoader.InitTasks
String	getCurrentFrameId()
String	getFullFrameId()
List<ComponentLoader.InitTask>	getInitTasks()	Deprecated, for removal: This API element is subject to removal in a future version.
com.vaadin.flow.component.Component	getOrigin()
Optional<ComponentLoader.ComponentContext>	getParent()
List<ComponentLoader.InitTask>	getPreInitTasks()	Deprecated, for removal: This API element is subject to removal in a future version.
View<?>	getView()
ViewActions	getViewActions()
ViewData	getViewData()
void	setCurrentFrameId(String currentFrameId)
void	setFullFrameId(String frameId)
void	setParent(ComponentLoader.ComponentContext parent)	Deprecated, for removal: This API element is subject to removal in a future version. Use AbstractLoaderContext.setParentContext(ComponentLoader.Context) instead
void	setView(View<?> view)
void	setViewActions(ViewActions viewActions)	Deprecated, for removal: This API element is subject to removal in a future version. Use AbstractLoaderContext.setActionsHolder(HasActions) instead
void	setViewData(ViewData viewData)	Deprecated, for removal: This API element is subject to removal in a future version. Use AbstractLoaderContext.setDataHolder(HasDataComponents) instead

Methods inherited from class io.jmix.flowui.xml.layout.loader.AbstractLoaderContext

addInitTask, executeInitTasks, getActionsHolder, getDataHolder, getFullOriginId, getMessageGroup, getParentContext, setActionsHolder, setDataHolder, setFullOriginId, setMessageGroup, setParentContext

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

addInitTask, executeInitTasks, getActionsHolder, getDataHolder, getFullOriginId, getMessageGroup, getParentContext

Field Details

view

protected View<?> view

fullFrameId

protected String fullFrameId

currentFrameId

protected String currentFrameId

preInitTasks

protected List<ComponentLoader.InitTask> preInitTasks

autowireTasks

protected List<ComponentLoader.AutowireTask> autowireTasks

Constructor Details

ComponentLoaderContext

public ComponentLoaderContext()

Method Details

getViewData

public ViewData getViewData()

Specified by:

getViewData in interface ComponentLoader.ComponentContext

Returns:

an instance of ViewData object associated with the origin view

setViewData

@Deprecated(since="2.3",
            forRemoval=true)
public void setViewData(ViewData viewData)

Deprecated, for removal: This API element is subject to removal in a future version.

Use AbstractLoaderContext.setDataHolder(HasDataComponents) instead

getViewActions

public ViewActions getViewActions()

Specified by:

getViewActions in interface ComponentLoader.ComponentContext

Returns:

actions holder object

setViewActions

@Deprecated(since="2.3",
            forRemoval=true)
public void setViewActions(ViewActions viewActions)

Deprecated, for removal: This API element is subject to removal in a future version.

Use AbstractLoaderContext.setActionsHolder(HasActions) instead

getOrigin

public com.vaadin.flow.component.Component getOrigin()

Specified by:

getOrigin in interface ComponentLoader.Context

Returns:

a target component for which an XML descriptor is processed

getView

public View<?> getView()

Specified by:

getView in interface ComponentLoader.ComponentContext

Returns:

an origin view

setView

public void setView(View<?> view)

getFullFrameId

public String getFullFrameId()

Specified by:

getFullFrameId in interface ComponentLoader.ComponentContext

setFullFrameId

public void setFullFrameId(String frameId)

getCurrentFrameId

public String getCurrentFrameId()

Specified by:

getCurrentFrameId in interface ComponentLoader.ComponentContext

setCurrentFrameId

public void setCurrentFrameId(String currentFrameId)

addPreInitTask

public void addPreInitTask(ComponentLoader.InitTask task)

Description copied from interface: ComponentLoader.ComponentContext

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

Parameters:

task - a task to add

addAutowireTask

public void addAutowireTask(ComponentLoader.AutowireTask task)

Description copied from interface: ComponentLoader.ComponentContext

Add ComponentLoader.AutowireTask that will be executed according to the origin component lifecycle.

Specified by:

addAutowireTask in interface ComponentLoader.ComponentContext

Parameters:

task - a task to add

getParent

public Optional<ComponentLoader.ComponentContext> getParent()

Specified by:

getParent in interface ComponentLoader.ComponentContext

Returns:

parent loader context

setParent

@Deprecated(since="2.3",
            forRemoval=true)
public void setParent(@Nullable
 ComponentLoader.ComponentContext parent)

Deprecated, for removal: This API element is subject to removal in a future version.

Use AbstractLoaderContext.setParentContext(ComponentLoader.Context) instead

getPreInitTasks

@Deprecated(since="2.3",
            forRemoval=true)
public List<ComponentLoader.InitTask> getPreInitTasks()

Deprecated, for removal: This API element is subject to removal in a future version.

getInitTasks

@Deprecated(since="2.3",
            forRemoval=true)
public List<ComponentLoader.InitTask> getInitTasks()

Deprecated, for removal: This API element is subject to removal in a future version.

executePreInitTasks

public void executePreInitTasks()

Description copied from interface: ComponentLoader.ComponentContext

Executes all added ComponentLoader.InitTasks

Specified by:

executePreInitTasks in interface ComponentLoader.ComponentContext

executeAutowireTasks

public void executeAutowireTasks()

Description copied from interface: ComponentLoader.ComponentContext

Executed all added ComponentLoader.AutowireTasks

Specified by:

executeAutowireTasks in interface ComponentLoader.ComponentContext