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

Class AbstractComponentLoader<T extends com.vaadin.flow.component.Component>

java.lang.Object
io.jmix.flowui.xml.layout.loader.AbstractComponentLoader<T>
All Implemented Interfaces:
ComponentLoader<T>
Direct Known Subclasses:
AbstractComboBoxLoader, AbstractContainerLoader, AbstractDropdownButtonLoader, AbstractGridLoader, AbstractGroupGridLoader, AbstractHtmlComponentLoader, AbstractIconLoader, AbstractLoginFormLoader, AbstractMultiSelectComboBoxLoader, AbstractSingleFilterComponentLoader, AbstractUploadFieldLoader, AbstractValuePickerLoader, AvatarLoader, BigDecimalFieldLoader, ButtonLoader, CardLoader, ChartLoader, CheckboxGroupLoader, CheckboxLoader, CodeEditorLoader, DatePickerLoader, DateTimePickerLoader, DrawerToggleLoader, DynamicAttributesPanelLoader, EmailFieldLoader, FormLayoutLoader, FormLayoutLoader.FormItemLoader, FormLayoutLoader.FormRowLoader, FragmentElementLoader, FullCalendarLoader, GenericComponentLoader, GenericFilterLoader, GeoMapLoader, GrapesJsLoader, GridColumnVisibilityLoader, GroupFilterLoader, HorizontalMenuLoader, HtmlLoader, InputLoader, IntegerFieldLoader, KanbanLoader, ListBoxLoader, ListMenuLoader, MainTabSheetLoader, MarkdownLoader, MenuFilterFieldLoader, MultiSelectListBoxLoader, NotificationsIndicatorLoader, NumberFieldLoader, PasswordFieldLoader, PivotTableLoader, ProgressBarLoader, RadioButtonGroupLoader, RangeInputLoader, RichTextEditorLoader, SearchFieldLoader, SelectLoader, SimplePaginationLoader, SpreadsheetLoader, SupersetDashboardLoader, SwitchLoader, TextAreaLoader, TextFieldLoader, TimePickerLoader, TwinColumnLoader, UploadLoader, UserIndicatorLoader, UserMenuLoader, VirtualListLoader, WebdavDocumentLinkLoader, WorkAreaLoader
public abstract class AbstractComponentLoader<T extends com.vaadin.flow.component.Component> extends Object implements ComponentLoader<T>

  • Field Details

    • context

      protected ComponentLoader.Context context

    • applicationContext

      protected org.springframework.context.ApplicationContext applicationContext

    • environment

      protected org.springframework.core.env.Environment environment

    • factory

      protected UiComponents factory

    • loaderResolver

      protected LoaderResolver loaderResolver

    • loaderSupport

      protected LoaderSupport loaderSupport

    • componentLoaderSupport

      protected ComponentLoaderSupport componentLoaderSupport

    • element

      protected org.dom4j.Element element

    • resultComponent

      protected T extends com.vaadin.flow.component.Component resultComponent

  • Constructor Details

    • AbstractComponentLoader

      protected AbstractComponentLoader()

  • Method Details

    • setApplicationContext

      public void setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
      Description copied from interface: ComponentLoader
      Sets the application context for the current component loader.
      Specified by:
      setApplicationContext in interface ComponentLoader<T extends com.vaadin.flow.component.Component>
      Parameters:
      applicationContext - the ApplicationContext instance to set

    • setEnvironment

      public void setEnvironment(org.springframework.core.env.Environment environment)
      Specified by:
      setEnvironment in interface ComponentLoader<T extends com.vaadin.flow.component.Component>

    • getContext

      public ComponentLoader.Context getContext()
      Description copied from interface: ComponentLoader
      Returns the context associated with the current component loading and initialization process.
      Specified by:
      getContext in interface ComponentLoader<T extends com.vaadin.flow.component.Component>
      Returns:
      the ComponentLoader.Context instance

    • setContext

      public void setContext(ComponentLoader.Context context)
      Description copied from interface: ComponentLoader
      Sets the context for loading and initializing UI components.
      Specified by:
      setContext in interface ComponentLoader<T extends com.vaadin.flow.component.Component>
      Parameters:
      context - the ComponentLoader.Context instance to set

    • getComponentContext

      protected ComponentLoader.ComponentContext getComponentContext()

    • createComponent

      protected abstract T createComponent()

    • initComponent

      public void initComponent()
      Description copied from interface: ComponentLoader
      Creates result component by XML-element
      Specified by:
      initComponent in interface ComponentLoader<T extends com.vaadin.flow.component.Component>

    • getFactory

      public UiComponents getFactory()
      Description copied from interface: ComponentLoader
      Returns the factory for creating UI components.
      Specified by:
      getFactory in interface ComponentLoader<T extends com.vaadin.flow.component.Component>
      Returns:
      the UiComponents instance

    • setFactory

      public void setFactory(UiComponents factory)
      Description copied from interface: ComponentLoader
      Sets the factory used for creating UI components.
      Specified by:
      setFactory in interface ComponentLoader<T extends com.vaadin.flow.component.Component>
      Parameters:
      factory - the UiComponents instance to set

    • getElement

      public org.dom4j.Element getElement()
      Specified by:
      getElement in interface ComponentLoader<T extends com.vaadin.flow.component.Component>
      Returns:
      XML element associated with the component loader

    • setElement

      public void setElement(org.dom4j.Element element)
      Description copied from interface: ComponentLoader
      Sets the specified XML element to be associated with the component loader.
      Specified by:
      setElement in interface ComponentLoader<T extends com.vaadin.flow.component.Component>
      Parameters:
      element - the Element instance representing the XML configuration for a UI component

    • getElement

      public org.dom4j.Element getElement(org.dom4j.Element element)
      Specified by:
      getElement in interface ComponentLoader<T extends com.vaadin.flow.component.Component>

    • getResultComponent

      public T getResultComponent()
      Description copied from interface: ComponentLoader
      Returns previously created instance of component.
      Specified by:
      getResultComponent in interface ComponentLoader<T extends com.vaadin.flow.component.Component>
      See Also:

    • getLoaderResolver

      public LoaderResolver getLoaderResolver()
      Description copied from interface: ComponentLoader
      Returns the LoaderResolver instance used to resolve component and view loaders during the XML-based component initialization process.
      Specified by:
      getLoaderResolver in interface ComponentLoader<T extends com.vaadin.flow.component.Component>
      Returns:
      the LoaderResolver instance

    • setLoaderResolver

      public void setLoaderResolver(LoaderResolver loaderResolver)
      Description copied from interface: ComponentLoader
      Sets the LoaderResolver instance used to resolve component and view loaders during the XML-based component initialization process.
      Specified by:
      setLoaderResolver in interface ComponentLoader<T extends com.vaadin.flow.component.Component>
      Parameters:
      loaderResolver - the LoaderResolver instance to set

    • getLoaderSupport

      public LoaderSupport getLoaderSupport()
      Description copied from interface: ComponentLoader
      Returns the LoaderSupport instance used to provide support functionalities for loading and initializing components.
      Specified by:
      getLoaderSupport in interface ComponentLoader<T extends com.vaadin.flow.component.Component>
      Returns:
      the LoaderSupport instance

    • setLoaderSupport

      public void setLoaderSupport(LoaderSupport loaderSupport)
      Description copied from interface: ComponentLoader
      Sets the LoaderSupport instance used to provide supporting functionalities for loading and initializing components.
      Specified by:
      setLoaderSupport in interface ComponentLoader<T extends com.vaadin.flow.component.Component>
      Parameters:
      loaderSupport - the LoaderSupport instance to set

    • componentLoader

      protected ComponentLoaderSupport componentLoader()

    • getLayoutLoader

      protected LayoutLoader getLayoutLoader()

    • loadId

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

    • loadVisible

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

    • loadBoolean

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

    • loadResourceString

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

    • loadResourceString

      protected Optional<String> loadResourceString(org.dom4j.Element element, String attributeName, String messageGroup, boolean emptyToNull)

    • loadString

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

    • loadString

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

    • loadInteger

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

    • loadDouble

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

    • loadEnum

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

    • loadBoolean

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

    • loadResourceString

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

    • loadString

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

    • loadInteger

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

    • loadDouble

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

    • loadEnum

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