Package io.jmix.ui.xml.layout.loader

Class AbstractDataGridLoader<T extends DataGrid>

java.lang.Object

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

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

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

All Implemented Interfaces:

ComponentLoader<T>

Direct Known Subclasses:

DataGridLoader, TreeDataGridLoader

public abstract class AbstractDataGridLoader<T extends DataGrid>
extends ActionsHolderLoader<T>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	AbstractDataGridLoader.DataGridDataHolder	Contains information about metaclass, data container, loader, fetch plan.

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

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

Field Summary

Fields

Modifier and Type	Field	Description
protected ComponentLoader	buttonsPanelLoader
protected Subscription	masterDataLoaderPostLoadListener
protected org.dom4j.Element	panelElement
protected static final Map<String,Class<? extends DataGrid.Renderer>>	RENDERERS_MAP
protected DataGrid.SortDirection	sortDirection
protected String	sortedColumnId

Fields inherited from class io.jmix.ui.xml.layout.loader.AbstractComponentLoader

applicationContext, context, element, environment, factory, layoutLoaderConfig, loaderResolver, loaderSupport, resultComponent

Constructor Summary

Constructors

Constructor	Description
AbstractDataGridLoader()

Method Summary

Modifier and Type	Method	Description
protected void	createButtonsPanel(HasButtonsPanel dataGrid, org.dom4j.Element element)
void	createComponent()	Creates result component by XML-element and loads its Id.
protected abstract T	createComponentInternal()
protected DataGridItems	createContainerDataGridSource(CollectionContainer container)
protected DataGridItems	createEmptyDataGridItems(MetaClass metaClass)
protected Collection<String>	getAppliedProperties(org.dom4j.Element columnsElement, FetchPlan fetchPlan, MetaClass metaClass)
protected Metadata	getMetadata()
protected MetadataTools	getMetadataTools()
protected org.dom4j.Element	getOverriddenColumn(List<org.dom4j.Element> columns, String property)
protected FetchPlanRepository	getViewRepository()
protected AbstractDataGridLoader.DataGridDataHolder	initDataGridDataHolder()
protected void	initMasterDataLoaderListener(CollectionPropertyContainer collectionContainer)
protected void	loadAggregatable(DataGrid component, org.dom4j.Element element)
protected void	loadAggregation(DataGrid.Column column, org.dom4j.Element columnElement)
protected void	loadAggregationPosition(DataGrid component, org.dom4j.Element element)
protected void	loadAggregationType(AggregationInfo aggregation, org.dom4j.Element aggregationElement)
protected void	loadBodyRowHeight(DataGrid dataGrid, org.dom4j.Element element)
protected void	loadButtonsPanel(DataGrid component)
protected String	loadCaption(org.dom4j.Element element)
protected DataGrid.Column	loadColumn(DataGrid component, org.dom4j.Element element, MetaClass metaClass)
protected void	loadColumnResizeMode(DataGrid component, org.dom4j.Element element)
protected List<DataGrid.Column>	loadColumns(DataGrid component, org.dom4j.Element columnsElement, MetaClass metaClass, FetchPlan view)
protected List<DataGrid.Column>	loadColumnsByInclude(DataGrid component, org.dom4j.Element columnsElement, MetaClass metaClass, FetchPlan fetchPlan)
protected void	loadColumnsHidingAllowed(DataGrid component, org.dom4j.Element element)
protected void	loadColumnSort(DataGrid component, DataGrid.Column column, String sort)
protected void	loadColumnVisualDisplay(DataGrid.Column column, org.dom4j.Element columnElement)
void	loadComponent()	Loads component properties by XML definition.
protected void	loadContextMenuEnabled(DataGrid dataGrid, org.dom4j.Element element)
protected void	loadDataGridData()
protected void	loadEditorBuffered(DataGrid component, org.dom4j.Element element)
protected void	loadEditorCancelCaption(DataGrid component, org.dom4j.Element element)
protected void	loadEditorCrossFieldEnabled(DataGrid component, org.dom4j.Element element)
protected void	loadEditorEnabled(DataGrid component, org.dom4j.Element element)
protected void	loadEditorSaveCaption(DataGrid component, org.dom4j.Element element)
protected void	loadEmptyStateLinkMessage(DataGrid dataGrid, org.dom4j.Element element)
protected void	loadEmptyStateMessage(DataGrid dataGrid, org.dom4j.Element element)
protected void	loadFooterRowHeight(DataGrid dataGrid, org.dom4j.Element element)
protected void	loadFooterVisible(DataGrid component, org.dom4j.Element element)
protected void	loadFormatPattern(org.dom4j.Element rendererElement, DataGrid.HasDateTimeFormatter renderer)
protected void	loadFormatString(org.dom4j.Element rendererElement, DataGrid.HasFormatString renderer)
protected void	loadFrozenColumnCount(DataGrid component, org.dom4j.Element element)
protected void	loadHeaderRowHeight(DataGrid dataGrid, org.dom4j.Element element)
protected void	loadHeaderVisible(DataGrid component, org.dom4j.Element element)
protected void	loadNullRepresentation(org.dom4j.Element rendererElement, DataGrid.HasNullRepresentation renderer)
protected void	loadPagination(DataGrid component, org.dom4j.Element element)
protected DataGrid.Renderer	loadRenderer(org.dom4j.Element columnElement)
protected DataGrid.Renderer	loadRendererByClass(org.dom4j.Element rendererElement, Class<? extends DataGrid.Renderer> rendererClass)
protected void	loadReorderingAllowed(DataGrid component, org.dom4j.Element element)
protected void	loadSelectionMode(DataGrid component, org.dom4j.Element element)
protected Integer	loadSizeInPx(org.dom4j.Element element, String propertyName)
protected void	loadSortable(DataGrid component, org.dom4j.Element element)
protected void	loadStrategyClass(AggregationInfo aggregation, org.dom4j.Element aggregationElement)
protected void	loadTextSelectionEnabled(DataGrid dataGrid, org.dom4j.Element element)
protected void	loadValueDescription(DataGrid.Column column, org.dom4j.Element aggregationElement)
protected void	onMasterDataLoaderPostLoad(Object o)
protected void	setColumnSort()
protected void	setupDataContainer(AbstractDataGridLoader.DataGridDataHolder holder)

Methods inherited from class io.jmix.ui.xml.layout.loader.ActionsHolderLoader

loadDeclarativeAction

Methods inherited from class io.jmix.ui.xml.layout.loader.AbstractComponentLoader

assignFrame, assignXmlDescriptor, findComponent, getActions, getClassManager, getComponentContext, getCompositeComponentContext, getContext, getElement, getFactory, getIconPath, getLayoutLoader, getLayoutLoader, getLayoutLoaderConfig, getLoaderResolver, getLoaderSupport, getMessages, getMessageTools, getMeterRegistry, getParentDataContainer, getProperties, getResultComponent, getTheme, initAction, loadAction, loadActionConstraint, loadActionId, loadActions, loadAlign, loadBoolean, loadBoolean, loadBorder, loadCaption, loadCaptionAsHtml, loadCollapsible, loadContainer, loadContainer, loadContextHelp, loadCss, loadData, loadDeclarativeActionByType, loadDeclarativeActionDefault, loadDescription, loadDescriptionAsHtml, loadEditable, loadEnable, loadEnum, loadEnum, loadFocusable, loadFormatter, loadFormatter, loadHeight, loadHeight, loadHtmlSanitizerEnabled, loadIcon, loadId, loadInputPrompt, loadInteger, loadInteger, loadMargin, loadMetaClass, loadMetaClass, loadMinHeight, loadMinHeight, loadMinWidth, loadMinWidth, loadOptionsContainer, loadOrientation, loadRequired, loadRequiredIndicatorVisible, loadResourceString, loadResponsive, loadShortcut, loadShortcutFromAlias, loadShortcutFromConfig, loadShortcutFromFQNConfig, loadString, loadString, loadStyleName, loadTabIndex, loadThemeInt, loadThemeString, loadValidation, loadValuePickerDeclarativeAction, loadVisible, loadWidth, loadWidth, parseMarginInfo, setApplicationContext, setContext, setElement, setEnvironment, setFactory, setLayoutLoaderConfig, setLoaderResolver, setLoaderSupport

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

RENDERERS_MAP

protected static final Map<String,Class<? extends DataGrid.Renderer>> RENDERERS_MAP

buttonsPanelLoader

protected ComponentLoader buttonsPanelLoader

panelElement

protected org.dom4j.Element panelElement

sortedColumnId

protected String sortedColumnId

sortDirection

protected DataGrid.SortDirection sortDirection

masterDataLoaderPostLoadListener

protected Subscription masterDataLoaderPostLoadListener

Constructor Details

AbstractDataGridLoader

public AbstractDataGridLoader()

Method Details

createComponent

public void createComponent()

Description copied from interface: ComponentLoader

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

See Also:

• ComponentLoader.getResultComponent()

createComponentInternal

protected abstract T createComponentInternal()

createButtonsPanel

protected void createButtonsPanel(HasButtonsPanel dataGrid,
 org.dom4j.Element element)

loadComponent

public void loadComponent()

Description copied from interface: ComponentLoader

Loads component properties by XML definition.

See Also:

• ComponentLoader.getElement(Element)

loadDataGridData

protected void loadDataGridData()

initDataGridDataHolder

protected AbstractDataGridLoader.DataGridDataHolder initDataGridDataHolder()

initMasterDataLoaderListener

protected void initMasterDataLoaderListener(CollectionPropertyContainer collectionContainer)

onMasterDataLoaderPostLoad

protected void onMasterDataLoaderPostLoad(Object o)

setColumnSort

protected void setColumnSort()

setupDataContainer

protected void setupDataContainer(AbstractDataGridLoader.DataGridDataHolder holder)

getMetadata

protected Metadata getMetadata()

getViewRepository

protected FetchPlanRepository getViewRepository()

createContainerDataGridSource

protected DataGridItems createContainerDataGridSource(CollectionContainer container)

createEmptyDataGridItems

protected DataGridItems createEmptyDataGridItems(MetaClass metaClass)

loadEditorEnabled

protected void loadEditorEnabled(DataGrid component,
 org.dom4j.Element element)

loadEditorBuffered

protected void loadEditorBuffered(DataGrid component,
 org.dom4j.Element element)

loadEditorSaveCaption

protected void loadEditorSaveCaption(DataGrid component,
 org.dom4j.Element element)

loadEditorCancelCaption

protected void loadEditorCancelCaption(DataGrid component,
 org.dom4j.Element element)

loadEditorCrossFieldEnabled

protected void loadEditorCrossFieldEnabled(DataGrid component,
 org.dom4j.Element element)

loadColumnsHidingAllowed

protected void loadColumnsHidingAllowed(DataGrid component,
 org.dom4j.Element element)

loadColumnResizeMode

protected void loadColumnResizeMode(DataGrid component,
 org.dom4j.Element element)

loadSortable

protected void loadSortable(DataGrid component,
 org.dom4j.Element element)

loadReorderingAllowed

protected void loadReorderingAllowed(DataGrid component,
 org.dom4j.Element element)

loadTextSelectionEnabled

protected void loadTextSelectionEnabled(DataGrid dataGrid,
 org.dom4j.Element element)

loadBodyRowHeight

protected void loadBodyRowHeight(DataGrid dataGrid,
 org.dom4j.Element element)

loadHeaderRowHeight

protected void loadHeaderRowHeight(DataGrid dataGrid,
 org.dom4j.Element element)

loadFooterRowHeight

protected void loadFooterRowHeight(DataGrid dataGrid,
 org.dom4j.Element element)

loadHeaderVisible

protected void loadHeaderVisible(DataGrid component,
 org.dom4j.Element element)

loadFooterVisible

protected void loadFooterVisible(DataGrid component,
 org.dom4j.Element element)

loadContextMenuEnabled

protected void loadContextMenuEnabled(DataGrid dataGrid,
 org.dom4j.Element element)

loadButtonsPanel

protected void loadButtonsPanel(DataGrid component)

loadPagination

protected void loadPagination(DataGrid component,
 org.dom4j.Element element)

loadColumnsByInclude

protected List<DataGrid.Column> loadColumnsByInclude(DataGrid component,
 org.dom4j.Element columnsElement,
 MetaClass metaClass,
 FetchPlan fetchPlan)

loadColumns

protected List<DataGrid.Column> loadColumns(DataGrid component,
 org.dom4j.Element columnsElement,
 MetaClass metaClass,
 FetchPlan view)

loadColumn

protected DataGrid.Column loadColumn(DataGrid component,
 org.dom4j.Element element,
 MetaClass metaClass)

loadColumnVisualDisplay

protected void loadColumnVisualDisplay(DataGrid.Column column,
 org.dom4j.Element columnElement)

loadRenderer

@Nullable
protected DataGrid.Renderer loadRenderer(org.dom4j.Element columnElement)

loadRendererByClass

protected DataGrid.Renderer loadRendererByClass(org.dom4j.Element rendererElement,
 Class<? extends DataGrid.Renderer> rendererClass)

loadNullRepresentation

protected void loadNullRepresentation(org.dom4j.Element rendererElement,
 DataGrid.HasNullRepresentation renderer)

loadFormatPattern

protected void loadFormatPattern(org.dom4j.Element rendererElement,
 DataGrid.HasDateTimeFormatter renderer)

loadFormatString

protected void loadFormatString(org.dom4j.Element rendererElement,
 DataGrid.HasFormatString renderer)

loadCaption

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

loadSizeInPx

@Nullable
protected Integer loadSizeInPx(org.dom4j.Element element,
 String propertyName)

getMetadataTools

protected MetadataTools getMetadataTools()

loadSelectionMode

protected void loadSelectionMode(DataGrid component,
 org.dom4j.Element element)

loadFrozenColumnCount

protected void loadFrozenColumnCount(DataGrid component,
 org.dom4j.Element element)

getAppliedProperties

protected Collection<String> getAppliedProperties(org.dom4j.Element columnsElement,
 @Nullable
 FetchPlan fetchPlan,
 MetaClass metaClass)

getOverriddenColumn

@Nullable
protected org.dom4j.Element getOverriddenColumn(List<org.dom4j.Element> columns,
 String property)

loadColumnSort

protected void loadColumnSort(DataGrid component,
 DataGrid.Column column,
 String sort)

loadEmptyStateMessage

protected void loadEmptyStateMessage(DataGrid dataGrid,
 org.dom4j.Element element)

loadEmptyStateLinkMessage

protected void loadEmptyStateLinkMessage(DataGrid dataGrid,
 org.dom4j.Element element)

loadAggregatable

protected void loadAggregatable(DataGrid component,
 org.dom4j.Element element)

loadAggregationPosition

protected void loadAggregationPosition(DataGrid component,
 org.dom4j.Element element)

loadAggregation

protected void loadAggregation(DataGrid.Column column,
 org.dom4j.Element columnElement)

loadAggregationType

protected void loadAggregationType(AggregationInfo aggregation,
 org.dom4j.Element aggregationElement)

loadValueDescription

protected void loadValueDescription(DataGrid.Column column,
 org.dom4j.Element aggregationElement)

loadStrategyClass

protected void loadStrategyClass(AggregationInfo aggregation,
 org.dom4j.Element aggregationElement)