Package io.jmix.ui.xml.layout

Interface ComponentLoader<T extends Component>

All Known Subinterfaces:

ComponentRootLoader<T>

All Known Implementing Classes:

AbstractBoxLoader, AbstractChartLoader, AbstractComponentLoader, AbstractDataGridLoader, AbstractFieldLoader, AbstractOptionsBaseLoader, AbstractPaginationLoader, AbstractResourceViewLoader, AbstractSelectListLoader, AbstractSerialChartLoader, AbstractSingleFilterComponentLoader, AbstractSuggestionFieldLoader, AbstractTableLoader, AbstractTextFieldLoader, AbstractValuePickerLoader, AccordionLoader, ActionsHolderLoader, AngularGaugeChartLoader, AppMenuLoader, AppWorkAreaLoader, BpmnModelerLoader, BpmnViewerLoader, BrowserFrameLoader, ButtonLoader, ButtonsPanelLoader, CalendarLoader, CapsLockIndicatorLoader, ChartModelLoader, CheckBoxGroupLoader, CheckBoxLoader, ColorPickerLoader, ComboBoxLoader, ContainerLoader, CoordinateChartLoader, CssLayoutLoader, CurrencyFieldLoader, CustomChartLoader, DashboardLoader, DashboardResponsiveLayoutLoader, DataGridLoader, DateFieldLoader, DatePickerLoader, DrawerLoader, DynamicAttributesPanelLoader, EntityComboBoxLoader, EntityPickerLoader, EntitySuggestionFieldLoader, FileMultiUploadFieldLoader, FileStorageUploadFieldLoader, FileUploadFieldLoader, FilterLoader, FlowBoxLayoutLoader, FormLoader, FragmentComponentLoader, FragmentLoader, FullTextFilterLoader, FunnelChartLoader, GanttChartLoader, GeoMapLoader, GrapesJsHtmlEditorLoader, GrapesJsNewsletterHtmlEditorLoader, GrapesJsWebpageHtmlEditorLoader, GridLayoutLoader, GroupBoxLayoutLoader, GroupFilterLoader, GroupTableLoader, HBoxLayoutLoader, HtmlBoxLayoutLoader, ImageLoader, JavaScriptComponentLoader, JpqlFilterLoader, LabelLoader, LinkButtonLoader, LinkLoader, LogoutButtonLoader, MaskedFieldLoader, MultiSelectListLoader, NewWindowButtonLoader, NotificationsIndicatorLoader, OutcomesPanelLoader, PaginationLoader, PaletteButtonLoader, PasswordFieldLoader, PieChartLoader, PivotTableLoader, PopupButtonLoader, PopupViewLoader, ProgressBarLoader, PropertyFilterLoader, RadarChartLoader, RadioButtonGroupLoader, RectangularChartLoader, RelatedEntitiesLoader, ResizableTextAreaLoader, ResponsiveGridLayoutLoader, RichTextAreaLoader, ScrollBoxLayoutLoader, SearchFieldLoader, SerialChartLoader, SideMenuLoader, SimplePaginationLoader, SingleSelectListLoader, SlicedChartLoader, SliderLoader, SourceCodeEditorLoader, SplitPanelLoader, StockChartLoader, SuggestionFieldLoader, TabComponentLoader, TableLoader, TabSheetLoader, TagFieldLoader, TagPickerLoader, TextAreaLoader, TextFieldLoader, TimeFieldLoader, TimeZoneIndicatorLoader, TreeDataGridLoader, TreeLoader, TreeTableLoader, TwinColumnLoader, UserActionsButtonLoader, UserIndicatorLoader, ValuePickerLoader, ValuesPickerLoader, VBoxLayoutLoader, WebdavDocumentLinkLoader, WebdavDocumentUploadFieldLoader, WebdavDocumentVersionLinkLoader, WindowLoader, XYChartLoader

public interface ComponentLoader<T extends Component>

Base interface for loaders which create components by XML definitions.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	ComponentLoader.ComponentContext
static interface	ComponentLoader.CompositeComponentContext
static interface	ComponentLoader.Context
static interface	ComponentLoader.InitTask	Init tasks are used to perform deferred initialization of visual components.
static interface	ComponentLoader.InjectTask	For internal use only.

Method Summary

Modifier and Type	Method	Description
void	createComponent()	Creates result component by XML-element and loads its Id.
ComponentLoader.Context	getContext()
org.dom4j.Element	getElement(org.dom4j.Element element)
UiComponents	getFactory()
LayoutLoaderConfig	getLayoutLoaderConfig()	Deprecated. use getLoaderResolver() instead
LoaderResolver	getLoaderResolver()
LoaderSupport	getLoaderSupport()
T	getResultComponent()	Returns previously created instance of component.
void	loadComponent()	Loads component properties by XML definition.
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 config)	Deprecated. use setLoaderResolver(LoaderResolver) instead
void	setLoaderResolver(LoaderResolver loaderResolver)
void	setLoaderSupport(LoaderSupport loaderSupport)

Method Details

getContext

ComponentLoader.Context getContext()

setContext

void setContext(ComponentLoader.Context context)

getFactory

UiComponents getFactory()

setFactory

void setFactory(UiComponents factory)

getLoaderResolver

LoaderResolver getLoaderResolver()

setLoaderResolver

void setLoaderResolver(LoaderResolver loaderResolver)

getLoaderSupport

LoaderSupport getLoaderSupport()

setLoaderSupport

void setLoaderSupport(LoaderSupport loaderSupport)

getLayoutLoaderConfig

@Deprecated
LayoutLoaderConfig getLayoutLoaderConfig()

Deprecated.

use getLoaderResolver() instead

setLayoutLoaderConfig

@Deprecated
void setLayoutLoaderConfig(LayoutLoaderConfig config)

Deprecated.

use setLoaderResolver(LoaderResolver) instead

getElement

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

setElement

void setElement(org.dom4j.Element element)

setApplicationContext

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

setEnvironment

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

createComponent

void createComponent()

Creates result component by XML-element and loads its Id. Also creates all nested components.

See Also:

• getResultComponent()

loadComponent

void loadComponent()

Loads component properties by XML definition.

See Also:

• getElement(Element)

getResultComponent

T getResultComponent()

Returns previously created instance of component.

See Also:

• createComponent()