io.jmix.ui.xml.layout.loader

Class AbstractComponentLoader<T extends Component>

java.lang.Object

io.jmix.ui.xml.layout.loader.AbstractComponentLoader<T>

All Implemented Interfaces:

ComponentLoader<T>

Direct Known Subclasses:

AbstractFieldLoader, AbstractPaginationLoader, AbstractResourceViewLoader, AbstractSingleFilterComponentLoader, ActionsHolderLoader, AppMenuLoader, ButtonLoader, CalendarLoader, CapsLockIndicatorLoader, ChartModelLoader, ContainerLoader, CustomChartLoader, FileMultiUploadFieldLoader, FormLoader, GroupFilterLoader, JavaScriptComponentLoader, LabelLoader, LinkLoader, LogoutButtonLoader, NewWindowButtonLoader, PivotTableLoader, PopupButtonLoader, PopupViewLoader, ProgressBarLoader, RelatedEntitiesLoader, ResponsiveGridLayoutLoader, SideMenuLoader, TimeZoneIndicatorLoader, UserActionsButtonLoader, UserIndicatorLoader

public abstract class AbstractComponentLoader<T extends Component>
extends java.lang.Object
implements ComponentLoader<T>

Nested Class Summary

Nested classes/interfaces inherited from interface io.jmix.ui.xml.layout.ComponentLoader

ComponentLoader.ComponentContext, ComponentLoader.CompositeComponentContext, ComponentLoader.Context, ComponentLoader.InitTask, ComponentLoader.InjectTask, ComponentLoader.PostInitTask

Field Summary

Fields

Modifier and Type	Field and Description
protected org.springframework.context.ApplicationContext	applicationContext
protected ComponentLoader.Context	context
protected org.dom4j.Element	element
protected org.springframework.core.env.Environment	environment
protected UiComponents	factory
protected LayoutLoaderConfig	layoutLoaderConfig Deprecated.
protected LoaderResolver	loaderResolver
protected LoaderSupport	loaderSupport
protected T	resultComponent

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractComponentLoader()

Method Summary

Modifier and Type	Method and Description
protected void	assignFrame(Component.BelongToFrame component)
protected void	assignXmlDescriptor(Component component, org.dom4j.Element element)
protected Component	findComponent(java.lang.String componentId)
protected Actions	getActions()
protected io.jmix.core.ClassManager	getClassManager()
protected ComponentLoader.ComponentContext	getComponentContext()
protected ComponentLoader.CompositeComponentContext	getCompositeComponentContext()
ComponentLoader.Context	getContext()
org.dom4j.Element	getElement(org.dom4j.Element element)
UiComponents	getFactory()
protected java.lang.String	getIconPath(java.lang.String icon)
protected LayoutLoader	getLayoutLoader()
protected LayoutLoader	getLayoutLoader(ComponentLoader.Context context)
LayoutLoaderConfig	getLayoutLoaderConfig() Deprecated.
LoaderResolver	getLoaderResolver()
LoaderSupport	getLoaderSupport()
protected io.jmix.core.Messages	getMessages()
protected io.jmix.core.MessageTools	getMessageTools()
protected io.micrometer.core.instrument.MeterRegistry	getMeterRegistry()
protected java.lang.String	getParentDataContainer(org.dom4j.Element element)
protected UiProperties	getProperties()
T	getResultComponent() Returns previously created instance of component.
protected ThemeConstants	getTheme()
protected void	initAction(org.dom4j.Element element, Action targetAction)
protected void	loadAction(ActionOwner component, org.dom4j.Element element)
protected void	loadActionConstraint(Action action, org.dom4j.Element element)
protected java.lang.String	loadActionId(org.dom4j.Element element)
protected void	loadActions(ActionsHolder actionsHolder, org.dom4j.Element element)
protected void	loadAlign(Component component, org.dom4j.Element element)
protected java.util.Optional<java.lang.Boolean>	loadBoolean(org.dom4j.Element element, java.lang.String attributeName)
protected void	loadBoolean(org.dom4j.Element element, java.lang.String attributeName, java.util.function.Consumer<java.lang.Boolean> setter)
protected void	loadBorder(HasBorder component, org.dom4j.Element element)
protected void	loadCaption(Component.HasCaption component, org.dom4j.Element element)
protected void	loadCaptionAsHtml(HasHtmlCaption component, org.dom4j.Element element)
protected void	loadCollapsible(Collapsable component, org.dom4j.Element element, boolean defaultCollapsable)
protected java.util.Optional<InstanceContainer>	loadContainer(org.dom4j.Element element, java.lang.String property)
protected void	loadContainer(T component, org.dom4j.Element element)
protected void	loadContextHelp(HasContextHelp component, org.dom4j.Element element)
protected void	loadCss(Component component, org.dom4j.Element element)
protected void	loadData(T component, org.dom4j.Element element)
protected Action	loadDeclarativeAction(ActionsHolder actionsHolder, org.dom4j.Element element)
protected Action	loadDeclarativeActionByType(ActionsHolder actionsHolder, org.dom4j.Element element)
protected Action	loadDeclarativeActionDefault(ActionsHolder actionsHolder, org.dom4j.Element element)
protected void	loadDescription(Component.HasDescription component, org.dom4j.Element element)
protected void	loadDescriptionAsHtml(HasHtmlDescription component, org.dom4j.Element element)
protected void	loadEditable(Component component, org.dom4j.Element element)
protected void	loadEnable(Component component, org.dom4j.Element element)
protected <T extends java.lang.Enum<T>> java.util.Optional<T>	loadEnum(org.dom4j.Element element, java.lang.Class<T> type, java.lang.String attributeName)
protected <T extends java.lang.Enum<T>> void	loadEnum(org.dom4j.Element element, java.lang.Class<T> type, java.lang.String attributeName, java.util.function.Consumer<T> setter)
protected void	loadFocusable(Component.Focusable component, org.dom4j.Element element)
protected Formatter<?>	loadFormatter(org.dom4j.Element element)
protected void	loadFormatter(HasFormatter component, org.dom4j.Element element)
protected void	loadHeight(Component component, org.dom4j.Element element)
protected void	loadHeight(Component component, org.dom4j.Element element, java.lang.String defaultValue)
protected void	loadHtmlSanitizerEnabled(HasHtmlSanitizer component, org.dom4j.Element element)
protected void	loadIcon(Component.HasIcon component, org.dom4j.Element element)
protected void	loadId(Component component, org.dom4j.Element element)
protected void	loadInputPrompt(HasInputPrompt component, org.dom4j.Element element)
protected java.util.Optional<java.lang.Integer>	loadInteger(org.dom4j.Element element, java.lang.String attributeName)
protected void	loadInteger(org.dom4j.Element element, java.lang.String attributeName, java.util.function.Consumer<java.lang.Integer> setter)
protected void	loadMargin(HasMargin layout, org.dom4j.Element element)
protected java.util.Optional<io.jmix.core.metamodel.model.MetaClass>	loadMetaClass(org.dom4j.Element element)
protected void	loadMetaClass(org.dom4j.Element element, java.util.function.Consumer<io.jmix.core.metamodel.model.MetaClass> setter)
protected java.util.Optional<CollectionContainer>	loadOptionsContainer(org.dom4j.Element element)
protected void	loadOrientation(HasOrientation component, org.dom4j.Element element)
protected void	loadRequired(Requirable component, org.dom4j.Element element)
protected void	loadRequiredIndicatorVisible(HasRequiredIndicator component, org.dom4j.Element element)
protected java.lang.String	loadResourceString(java.lang.String caption)
protected void	loadResponsive(Component component, org.dom4j.Element element)
protected java.lang.String	loadShortcut(java.lang.String shortcut)
protected java.lang.String	loadShortcutFromAlias(java.lang.String shortcut)
protected java.lang.String	loadShortcutFromConfig(java.lang.String shortcut)
protected java.lang.String	loadShortcutFromFQNConfig(java.lang.String shortcut)
protected java.util.Optional<java.lang.String>	loadString(org.dom4j.Element element, java.lang.String attributeName)
protected void	loadString(org.dom4j.Element element, java.lang.String attributeName, java.util.function.Consumer<java.lang.String> setter)
protected void	loadStyleName(Component component, org.dom4j.Element element)
protected void	loadTabIndex(Component.Focusable component, org.dom4j.Element element)
protected int	loadThemeInt(java.lang.String value)
protected java.lang.String	loadThemeString(java.lang.String value)
protected void	loadValidation(HasValidator component, org.dom4j.Element element)
protected Action	loadValuePickerDeclarativeAction(ActionsHolder actionsHolder, org.dom4j.Element element)
protected void	loadVisible(Component component, org.dom4j.Element element)
protected void	loadWidth(Component component, org.dom4j.Element element)
protected void	loadWidth(Component component, org.dom4j.Element element, java.lang.String defaultValue)
protected MarginInfo	parseMarginInfo(java.lang.String margin)
void	setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
void	setContext(ComponentLoader.Context context)
void	setElement(org.dom4j.Element element)
void	setEnvironment(org.springframework.core.env.Environment environment)
void	setFactory(UiComponents factory)
void	setLayoutLoaderConfig(LayoutLoaderConfig layoutLoaderConfig) Deprecated.
void	setLoaderResolver(LoaderResolver loaderResolver)
void	setLoaderSupport(LoaderSupport loaderSupport)

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.xml.layout.ComponentLoader

createComponent, loadComponent

Field Detail

context

protected ComponentLoader.Context context

factory

protected UiComponents factory

layoutLoaderConfig

@Deprecated
protected LayoutLoaderConfig layoutLoaderConfig

Deprecated.

loaderResolver

protected LoaderResolver loaderResolver

loaderSupport

protected LoaderSupport loaderSupport

element

protected org.dom4j.Element element

resultComponent

protected T extends Component resultComponent

applicationContext

protected org.springframework.context.ApplicationContext applicationContext

environment

protected org.springframework.core.env.Environment environment

Constructor Detail

AbstractComponentLoader

protected AbstractComponentLoader()

Method Detail

setApplicationContext

public void setApplicationContext(org.springframework.context.ApplicationContext applicationContext)

Specified by:

setApplicationContext in interface ComponentLoader<T extends Component>

setEnvironment

public void setEnvironment(org.springframework.core.env.Environment environment)

Specified by:

setEnvironment in interface ComponentLoader<T extends Component>

getContext

public ComponentLoader.Context getContext()

Specified by:

getContext in interface ComponentLoader<T extends Component>

setContext

public void setContext(ComponentLoader.Context context)

Specified by:

setContext in interface ComponentLoader<T extends Component>

getComponentContext

protected ComponentLoader.ComponentContext getComponentContext()

getCompositeComponentContext

protected ComponentLoader.CompositeComponentContext getCompositeComponentContext()

getFactory

public UiComponents getFactory()

Specified by:

getFactory in interface ComponentLoader<T extends Component>

setFactory

public void setFactory(UiComponents factory)

Specified by:

setFactory in interface ComponentLoader<T extends Component>

setElement

public void setElement(org.dom4j.Element element)

Specified by:

setElement in interface ComponentLoader<T extends Component>

getElement

public org.dom4j.Element getElement(org.dom4j.Element element)

Specified by:

getElement in interface ComponentLoader<T extends Component>

getResultComponent

public T getResultComponent()

Description copied from interface: ComponentLoader

Returns previously created instance of component.

Specified by:

getResultComponent in interface ComponentLoader<T extends Component>

See Also:

ComponentLoader.createComponent()

getLoaderResolver

public LoaderResolver getLoaderResolver()

Specified by:

getLoaderResolver in interface ComponentLoader<T extends Component>

setLoaderResolver

public void setLoaderResolver(LoaderResolver loaderResolver)

Specified by:

setLoaderResolver in interface ComponentLoader<T extends Component>

getLoaderSupport

public LoaderSupport getLoaderSupport()

Specified by:

getLoaderSupport in interface ComponentLoader<T extends Component>

setLoaderSupport

public void setLoaderSupport(LoaderSupport loaderSupport)

Specified by:

setLoaderSupport in interface ComponentLoader<T extends Component>

getLayoutLoaderConfig

@Deprecated
public LayoutLoaderConfig getLayoutLoaderConfig()

Deprecated.

Specified by:

getLayoutLoaderConfig in interface ComponentLoader<T extends Component>

setLayoutLoaderConfig

@Deprecated
public void setLayoutLoaderConfig(LayoutLoaderConfig layoutLoaderConfig)

Deprecated.

Specified by:

setLayoutLoaderConfig in interface ComponentLoader<T extends Component>

getMessages

protected io.jmix.core.Messages getMessages()

getActions

protected Actions getActions()

getMessageTools

protected io.jmix.core.MessageTools getMessageTools()

getClassManager

protected io.jmix.core.ClassManager getClassManager()

getProperties

protected UiProperties getProperties()

getMeterRegistry

protected io.micrometer.core.instrument.MeterRegistry getMeterRegistry()

getTheme

protected ThemeConstants getTheme()

getLayoutLoader

protected LayoutLoader getLayoutLoader()

getLayoutLoader

protected LayoutLoader getLayoutLoader(ComponentLoader.Context context)

loadId

protected void loadId(Component component,
                      org.dom4j.Element element)

loadStyleName

protected void loadStyleName(Component component,
                             org.dom4j.Element element)

loadCss

protected void loadCss(Component component,
                       org.dom4j.Element element)

loadResponsive

protected void loadResponsive(Component component,
                              org.dom4j.Element element)

assignXmlDescriptor

protected void assignXmlDescriptor(Component component,
                                   org.dom4j.Element element)

loadEditable

protected void loadEditable(Component component,
                            org.dom4j.Element element)

loadCaption

protected void loadCaption(Component.HasCaption component,
                           org.dom4j.Element element)

loadCaptionAsHtml

protected void loadCaptionAsHtml(HasHtmlCaption component,
                                 org.dom4j.Element element)

loadDescription

protected void loadDescription(Component.HasDescription component,
                               org.dom4j.Element element)

loadDescriptionAsHtml

protected void loadDescriptionAsHtml(HasHtmlDescription component,
                                     org.dom4j.Element element)

loadContextHelp

protected void loadContextHelp(HasContextHelp component,
                               org.dom4j.Element element)

loadRequired

protected void loadRequired(Requirable component,
                            org.dom4j.Element element)

loadValidation

protected void loadValidation(HasValidator component,
                              org.dom4j.Element element)

loadVisible

protected void loadVisible(Component component,
                           org.dom4j.Element element)

loadEnable

protected void loadEnable(Component component,
                          org.dom4j.Element element)

loadResourceString

protected java.lang.String loadResourceString(java.lang.String caption)

loadThemeString

@Nullable
protected java.lang.String loadThemeString(@Nullable
                                                     java.lang.String value)

loadThemeInt

protected int loadThemeInt(@Nullable
                           java.lang.String value)

loadAlign

protected void loadAlign(Component component,
                         org.dom4j.Element element)

loadHeight

protected void loadHeight(Component component,
                          org.dom4j.Element element)

loadHeight

protected void loadHeight(Component component,
                          org.dom4j.Element element,
                          @Nullable
                          java.lang.String defaultValue)

loadWidth

protected void loadWidth(Component component,
                         org.dom4j.Element element)

loadTabIndex

protected void loadTabIndex(Component.Focusable component,
                            org.dom4j.Element element)

loadWidth

protected void loadWidth(Component component,
                         org.dom4j.Element element,
                         @Nullable
                         java.lang.String defaultValue)

loadCollapsible

protected void loadCollapsible(Collapsable component,
                               org.dom4j.Element element,
                               boolean defaultCollapsable)

loadBorder

protected void loadBorder(HasBorder component,
                          org.dom4j.Element element)

loadMargin

protected void loadMargin(HasMargin layout,
                          org.dom4j.Element element)

parseMarginInfo

protected MarginInfo parseMarginInfo(java.lang.String margin)

assignFrame

protected void assignFrame(Component.BelongToFrame component)

loadAction

protected void loadAction(ActionOwner component,
                          org.dom4j.Element element)

loadIcon

protected void loadIcon(Component.HasIcon component,
                        org.dom4j.Element element)

getIconPath

@Nullable
protected java.lang.String getIconPath(@Nullable
                                                 java.lang.String icon)

loadActions

protected void loadActions(ActionsHolder actionsHolder,
                           org.dom4j.Element element)

loadDeclarativeAction

protected Action loadDeclarativeAction(ActionsHolder actionsHolder,
                                       org.dom4j.Element element)

loadDeclarativeActionDefault

protected Action loadDeclarativeActionDefault(ActionsHolder actionsHolder,
                                              org.dom4j.Element element)

loadActionId

protected java.lang.String loadActionId(org.dom4j.Element element)

loadDeclarativeActionByType

@Nullable
protected Action loadDeclarativeActionByType(ActionsHolder actionsHolder,
                                                       org.dom4j.Element element)

initAction

protected void initAction(org.dom4j.Element element,
                          Action targetAction)

loadActionConstraint

protected void loadActionConstraint(Action action,
                                    org.dom4j.Element element)

loadShortcut

protected java.lang.String loadShortcut(java.lang.String shortcut)

loadShortcutFromFQNConfig

@Nullable
protected java.lang.String loadShortcutFromFQNConfig(java.lang.String shortcut)

loadShortcutFromAlias

@Nullable
protected java.lang.String loadShortcutFromAlias(java.lang.String shortcut)

loadShortcutFromConfig

@Nullable
protected java.lang.String loadShortcutFromConfig(java.lang.String shortcut)

loadValuePickerDeclarativeAction

protected Action loadValuePickerDeclarativeAction(ActionsHolder actionsHolder,
                                                  org.dom4j.Element element)

loadFormatter

@Nullable
protected Formatter<?> loadFormatter(org.dom4j.Element element)

loadFormatter

protected void loadFormatter(HasFormatter component,
                             org.dom4j.Element element)

loadOrientation

protected void loadOrientation(HasOrientation component,
                               org.dom4j.Element element)

loadInputPrompt

protected void loadInputPrompt(HasInputPrompt component,
                               org.dom4j.Element element)

loadFocusable

protected void loadFocusable(Component.Focusable component,
                             org.dom4j.Element element)

loadData

protected void loadData(T component,
                        org.dom4j.Element element)

loadContainer

protected void loadContainer(T component,
                             org.dom4j.Element element)

loadContainer

protected java.util.Optional<InstanceContainer> loadContainer(org.dom4j.Element element,
                                                              @Nullable
                                                              java.lang.String property)

loadOptionsContainer

protected java.util.Optional<CollectionContainer> loadOptionsContainer(org.dom4j.Element element)

getParentDataContainer

@Nullable
protected java.lang.String getParentDataContainer(org.dom4j.Element element)

findComponent

@Nullable
protected Component findComponent(java.lang.String componentId)

loadRequiredIndicatorVisible

protected void loadRequiredIndicatorVisible(HasRequiredIndicator component,
                                            org.dom4j.Element element)

loadHtmlSanitizerEnabled

protected void loadHtmlSanitizerEnabled(HasHtmlSanitizer component,
                                        org.dom4j.Element element)

loadString

protected java.util.Optional<java.lang.String> loadString(org.dom4j.Element element,
                                                          java.lang.String attributeName)

loadString

protected void loadString(org.dom4j.Element element,
                          java.lang.String attributeName,
                          java.util.function.Consumer<java.lang.String> setter)

loadBoolean

protected java.util.Optional<java.lang.Boolean> loadBoolean(org.dom4j.Element element,
                                                            java.lang.String attributeName)

loadBoolean

protected void loadBoolean(org.dom4j.Element element,
                           java.lang.String attributeName,
                           java.util.function.Consumer<java.lang.Boolean> setter)

loadInteger

protected java.util.Optional<java.lang.Integer> loadInteger(org.dom4j.Element element,
                                                            java.lang.String attributeName)

loadInteger

protected void loadInteger(org.dom4j.Element element,
                           java.lang.String attributeName,
                           java.util.function.Consumer<java.lang.Integer> setter)

loadEnum

protected <T extends java.lang.Enum<T>> java.util.Optional<T> loadEnum(org.dom4j.Element element,
                                                                       java.lang.Class<T> type,
                                                                       java.lang.String attributeName)

loadEnum

protected <T extends java.lang.Enum<T>> void loadEnum(org.dom4j.Element element,
                                                      java.lang.Class<T> type,
                                                      java.lang.String attributeName,
                                                      java.util.function.Consumer<T> setter)

loadMetaClass

protected java.util.Optional<io.jmix.core.metamodel.model.MetaClass> loadMetaClass(org.dom4j.Element element)

loadMetaClass

protected void loadMetaClass(org.dom4j.Element element,
                             java.util.function.Consumer<io.jmix.core.metamodel.model.MetaClass> setter)