Package io.jmix.flowui.xml.layout

Interface ComponentLoader<T extends com.vaadin.flow.component.Component>

Type Parameters:
T - the type of component being loaded
All Known Subinterfaces:
ComponentRootLoader<T>
All Known Implementing Classes:
AbstractComboBoxLoader, AbstractComponentLoader, AbstractContainerLoader, AbstractDetailsLoader, AbstractDropdownButtonLoader, AbstractGridLoader, AbstractGroupGridLoader, AbstractHtmlComponentLoader, AbstractHtmlContainerLoader, AbstractIconLoader, AbstractLayoutLoader, AbstractLoginFormLoader, AbstractMultiSelectComboBoxLoader, AbstractSingleFilterComponentLoader, AbstractTabLoader, AbstractTabsLoader, AbstractUploadFieldLoader, AbstractValuePickerLoader, AbstractViewLoader, AccordionLoader, AccordionPanelLoader, AnchorLoader, ArticleLoader, AsideLoader, AvatarLoader, BigDecimalFieldLoader, BoardLoader, ButtonLoader, CardLoader, ChartLoader, CheckboxGroupLoader, CheckboxLoader, CodeEditorLoader, CodeLoader, ComboBoxLoader, ComboBoxPickerLoader, ComboButtonLoader, DataGridLoader, DatePickerLoader, DateTimePickerLoader, DescriptionListLoader, DescriptionListLoader.DescriptionLoader, DescriptionListLoader.TermLoader, DetailsLoader, DivLoader, DrawerToggleLoader, DropdownButtonLoader, DynamicAttributesPanelLoader, EmailFieldLoader, EmphasisLoader, EntityComboBoxLoader, EntityPickerLoader, FieldSetLoader, FileStorageUploadFieldLoader, FileUploadFieldLoader, FlexLayoutLoader, FontIconLoader, FooterLoader, FormLayoutLoader, FormLayoutLoader.FormItemLoader, FormLayoutLoader.FormRowLoader, FragmentElementLoader, FullCalendarLoader, FullTextFilterLoader, GenericComponentLoader, GenericFilterLoader, GeoMapLoader, GrapesJsLoader, GridColumnVisibilityLoader, GridLayoutLoader, GroupDataGridLoader, GroupFilterLoader, H1Loader, H2Loader, H3Loader, H4Loader, H5Loader, H6Loader, HeaderLoader, HorizontalLayoutLoader, HorizontalMenuLoader, HrLoader, HtmlLoader, HtmlObjectLoader, IconLoader, IFrameLoader, ImageLoader, InputLoader, IntegerFieldLoader, JpqlFilterLoader, KanbanLoader, LabelLoader, ListBoxLoader, ListItemLoader, ListMenuLoader, LoginFormLoader, LoginOverlayLoader, MainLoader, MainTabSheetLoader, MainViewLoader, MarkdownLoader, MenuFilterFieldLoader, MultiSelectComboBoxLoader, MultiSelectComboBoxPickerLoader, MultiSelectListBoxLoader, MultiValuePickerLoader, NativeButtonLoader, NativeDetailsLoader, NativeLabelLoader, NavLoader, NotificationsIndicatorLoader, NumberFieldLoader, OrderedListLoader, ParagraphLoader, ParamLoader, PasswordFieldLoader, PivotTableLoader, PreLoader, ProgressBarLoader, PropertyFilterLoader, RadioButtonGroupLoader, RangeInputLoader, RichTextEditorLoader, RowLoader, ScrollerLoader, SearchFieldLoader, SectionLoader, SelectLoader, SimplePaginationLoader, SpanLoader, SplitLayoutLoader, SpreadsheetLoader, SupersetDashboardLoader, SvgIconLoader, SwitchLoader, TabbedModeMainViewLoader, TabSheetLoader, TabSheetLoader.LazyTabLoader, TabSheetLoader.TabLoader, TabsLoader, TabsLoader.TabLoader, TextAreaLoader, TextFieldLoader, TimePickerLoader, TreeDataGridLoader, TwinColumnLoader, UnorderedListLoader, UploadLoader, UserIndicatorLoader, UserMenuLoader, ValuePickerLoader, VerticalLayoutLoader, ViewLoader, VirtualListLoader, WebdavDocumentLinkLoader, WebdavDocumentUploadFieldLoader, WebdavDocumentVersionLinkLoader, WorkAreaLoader
public interface ComponentLoader<T extends com.vaadin.flow.component.Component>
Defines the contract for loading and initializing UI components from XML descriptors.

  • Method Details

    • getContext

      ComponentLoader.Context getContext()
      Returns the context associated with the current component loading and initialization process.
      Returns:
      the ComponentLoader.Context instance

    • setContext

      void setContext(ComponentLoader.Context context)
      Sets the context for loading and initializing UI components.
      Parameters:
      context - the ComponentLoader.Context instance to set

    • getFactory

      UiComponents getFactory()
      Returns the factory for creating UI components.
      Returns:
      the UiComponents instance

    • setFactory

      void setFactory(UiComponents factory)
      Sets the factory used for creating UI components.
      Parameters:
      factory - the UiComponents instance to set

    • getLoaderResolver

      LoaderResolver getLoaderResolver()
      Returns the LoaderResolver instance used to resolve component and view loaders during the XML-based component initialization process.
      Returns:
      the LoaderResolver instance

    • setLoaderResolver

      void setLoaderResolver(LoaderResolver loaderResolver)
      Sets the LoaderResolver instance used to resolve component and view loaders during the XML-based component initialization process.
      Parameters:
      loaderResolver - the LoaderResolver instance to set

    • getLoaderSupport

      LoaderSupport getLoaderSupport()
      Returns the LoaderSupport instance used to provide support functionalities for loading and initializing components.
      Returns:
      the LoaderSupport instance

    • setLoaderSupport

      void setLoaderSupport(LoaderSupport loaderSupport)
      Sets the LoaderSupport instance used to provide supporting functionalities for loading and initializing components.
      Parameters:
      loaderSupport - the LoaderSupport instance to set

    • getElement

      @Deprecated(since="2.6", forRemoval=true) org.dom4j.Element getElement(org.dom4j.Element element)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • setElement

      void setElement(org.dom4j.Element element)
      Sets the specified XML element to be associated with the component loader.
      Parameters:
      element - the Element instance representing the XML configuration for a UI component

    • getElement

      org.dom4j.Element getElement()
      Returns:
      XML element associated with the component loader

    • setApplicationContext

      void setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
      Sets the application context for the current component loader.
      Parameters:
      applicationContext - the ApplicationContext instance to set

    • setEnvironment

      @Deprecated(since="2.5", forRemoval=true) void setEnvironment(org.springframework.core.env.Environment environment)
      Deprecated, for removal: This API element is subject to removal in a future version.
      unused

    • initComponent

      void initComponent()
      Creates result component by XML-element

    • loadComponent

      void loadComponent()
      Loads component properties by XML definition.
      See Also:

    • getResultComponent

      T getResultComponent()
      Returns previously created instance of component.
      See Also: