Package 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, BpmnModelerLoader, BpmnViewerLoader, ButtonLoader, CalendarLoader, CapsLockIndicatorLoader, ChartModelLoader, ContainerLoader, CustomChartLoader, DashboardLoader, DynamicAttributesPanelLoader, FileMultiUploadFieldLoader, FormLoader, GeoMapLoader, GrapesJsHtmlEditorLoader, GroupFilterLoader, JavaScriptComponentLoader, LabelLoader, LinkLoader, LogoutButtonLoader, NewWindowButtonLoader, NotificationsIndicatorLoader, OutcomesPanelLoader, PivotTableLoader, PopupButtonLoader, PopupViewLoader, ProgressBarLoader, RelatedEntitiesLoader, ResponsiveGridLayoutLoader, SearchFieldLoader, SideMenuLoader, TimeZoneIndicatorLoader, UserActionsButtonLoader, UserIndicatorLoader, WebdavDocumentLinkLoader
public abstract class AbstractComponentLoader<T extends Component> extends Object implements ComponentLoader<T>

  • Field Details

    • 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 Details

    • AbstractComponentLoader

      protected AbstractComponentLoader()

  • Method Details

    • 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:

    • 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 Messages getMessages()

    • getActions

      protected Actions getActions()

    • getMessageTools

      protected MessageTools getMessageTools()

    • getClassManager

      protected 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 String loadResourceString(String caption)

    • loadThemeString

      @Nullable protected String loadThemeString(@Nullable String value)

    • loadThemeInt

      protected int loadThemeInt(@Nullable 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 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 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(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 String getIconPath(@Nullable 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 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 String loadShortcut(String shortcut)

    • loadShortcutFromFQNConfig

      @Nullable protected String loadShortcutFromFQNConfig(String shortcut)

    • loadShortcutFromAlias

      @Nullable protected String loadShortcutFromAlias(String shortcut)

    • loadShortcutFromConfig

      @Nullable protected String loadShortcutFromConfig(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 Optional<InstanceContainer> loadContainer(org.dom4j.Element element, @Nullable String property)

    • loadOptionsContainer

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

    • getParentDataContainer

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

    • findComponent

      @Nullable protected Component findComponent(String componentId)

    • loadRequiredIndicatorVisible

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

    • loadHtmlSanitizerEnabled

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

    • loadString

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

    • loadString

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

    • loadBoolean

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

    • loadBoolean

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

    • loadInteger

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

    • loadInteger

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

    • loadEnum

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

    • loadEnum

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

    • loadMetaClass

      protected Optional<MetaClass> loadMetaClass(org.dom4j.Element element)

    • loadMetaClass

      protected void loadMetaClass(org.dom4j.Element element, Consumer<MetaClass> setter)

    • loadMinHeight

      protected Optional<String> loadMinHeight(org.dom4j.Element element)

    • loadMinHeight

      protected void loadMinHeight(org.dom4j.Element element, Consumer<String> setter)

    • loadMinWidth

      protected Optional<String> loadMinWidth(org.dom4j.Element element)

    • loadMinWidth

      protected void loadMinWidth(org.dom4j.Element element, Consumer<String> setter)