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

Class AbstractGridLoader<T extends com.vaadin.flow.component.grid.Grid & EnhancedDataGrid & HasActions>

java.lang.Object

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

io.jmix.flowui.xml.layout.loader.component.AbstractGridLoader<T>

All Implemented Interfaces:

ComponentLoader<T>

Direct Known Subclasses:

DataGridLoader, TreeDataGridLoader

public abstract class AbstractGridLoader<T extends com.vaadin.flow.component.grid.Grid & EnhancedDataGrid & HasActions>
extends AbstractComponentLoader<T>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static final record	AbstractGridLoader.ColumnDefaultValues	Contains information about resizable, sortable, filterable column default values for the column.
protected static class	AbstractGridLoader.GridDataHolder	Contains information about metaClass, data container, loader, fetch plan.

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

ComponentLoader.AutowireTask, ComponentLoader.ComponentContext, ComponentLoader.Context, ComponentLoader.FragmentContext, ComponentLoader.InitTask

Field Summary

Fields

Modifier and Type	Field	Description
protected AccessManager	accessManager
protected ActionLoaderSupport	actionLoaderSupport
protected ClassManager	classManager
static final String	COLUMN_ELEMENT_NAME
static final String	EDITOR_ACTIONS_COLUMN_ELEMENT_NAME
protected FetchPlanRepositoryImpl	fetchPlanRepository
protected IconLoaderSupport	iconLoaderSupport
protected Subscription	masterDataLoaderPostLoadListener
protected Messages	messages
protected MetadataTools	metaDataTools
protected List<DataGridColumn<?>>	pendingToFilterableColumns

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

applicationContext, componentLoaderSupport, context, element, factory, loaderResolver, loaderSupport, resultComponent

Constructor Summary

Constructors

Constructor	Description
AbstractGridLoader()

Method Summary

Modifier and Type	Method	Description
protected DataGridColumn<?>	addColumn(String key, MetaPropertyPath metaPropertyPath)
protected void	addContextMenuItem(Function<com.vaadin.flow.component.Component,com.vaadin.flow.component.grid.contextmenu.GridMenuItem<?>> menuItemGenerator, Consumer<com.vaadin.flow.component.Component> separatorConsumer, org.dom4j.Element childElement)
protected DataGridColumn<?>	addEmptyColumn(String key)
protected void	configureParentViewReadOnlyChangeListener(com.vaadin.flow.component.button.Button editButton)
protected com.vaadin.flow.component.grid.Grid.Column<?>	createEditColumn(T resultComponent, org.dom4j.Element columnElement, com.vaadin.flow.component.grid.editor.Editor editor, MetaClass metaClass)
protected AccessManager	getAccessManager()
protected ActionLoaderSupport	getActionLoaderSupport()
protected Collection<String>	getAppliedProperties(org.dom4j.Element columnsElement, @Nullable FetchPlan fetchPlan, MetaClass metaClass)
protected ClassManager	getClassManager()
protected FetchPlanRepositoryImpl	getFetchPlanRepository()
protected Messages	getMessages()
protected MetadataTools	getMetaDataTools()
protected @Nullable org.dom4j.Element	getOverriddenColumn(List<org.dom4j.Element> columns, String property)
protected RendererProvider.RendererCreationContext	getRendererCreationContext(MetaClass metaClass, @Nullable MetaPropertyPath metaPropertyPath, org.dom4j.Element element)
protected IconLoaderSupport	iconLoaderSupport()
protected AbstractGridLoader.GridDataHolder	initDataGridDataHolder()
protected void	initMasterDataLoaderListener(CollectionPropertyContainer<?> collectionContainer)
protected boolean	isTransientProperty(@Nullable MetaPropertyPath metaPropertyPath)
protected void	loadActions()
protected void	loadAggregationInfo(org.dom4j.Element columnElement, DataGridColumn<?> column)
protected void	loadColumn(T component, org.dom4j.Element element, MetaClass metaClass, AbstractGridLoader.ColumnDefaultValues columnDefaultValues)
protected void	loadColumnEditable(org.dom4j.Element element, DataGridColumn<?> column, @Nullable String property)
protected void	loadColumnFilterable(org.dom4j.Element element, DataGridColumn<?> column, boolean defaultFilterable)
protected void	loadColumnResizable(org.dom4j.Element element, DataGridColumn<?> column, boolean resizableColumns)
protected void	loadColumns(T resultComponent, org.dom4j.Element columnsElement, MetaClass metaClass, FetchPlan fetchPlan)
protected void	loadColumnsByInclude(T component, org.dom4j.Element columnsElement, MetaClass metaClass, FetchPlan fetchPlan, AbstractGridLoader.ColumnDefaultValues columnDefaultValues)
protected void	loadColumnsElementChild(T resultComponent, org.dom4j.Element columnElement, MetaClass metaClass, AbstractGridLoader.ColumnDefaultValues columnDefaultValues)
protected void	loadColumnSortable(org.dom4j.Element element, boolean sortableColumns, DataGridColumn<?> column, @Nullable MetaPropertyPath metaPropertyPath)
protected void	loadColumnSortable(org.dom4j.Element element, DataGridColumn<?> column, boolean sortableColumns)
void	loadComponent()	Loads component properties by XML definition.
protected void	loadContextMenu()
protected void	loadContextMenuItem(GridContextMenuItemComponent<?> component, com.vaadin.flow.component.grid.contextmenu.GridMenuItem<?> menuItem, org.dom4j.Element itemElement)
protected void	loadContextMenuItemAction(GridContextMenuItemComponent<?> component, org.dom4j.Element element)
protected void	loadData()
protected void	loadEditorActionsColumn(T resultComponent, org.dom4j.Element columnElement, MetaClass metaClass)
protected void	loadEditorActionsColumns(T resultComponent, org.dom4j.Element columnsElement, MetaClass metaClass)
protected @Nullable com.vaadin.flow.component.button.Button	loadEditorButton(org.dom4j.Element columnElement, String buttonElementName)
protected void	loadEmptyStateComponent()
protected @Nullable String	loadMessage(@Nullable String message)
protected void	loadMetaClass(org.dom4j.Element element, Consumer<MetaClass> setter)
protected void	loadMultiSort()
protected Optional<? extends com.vaadin.flow.data.renderer.Renderer>	loadRenderer(org.dom4j.Element columnElement, MetaClass metaClass, @Nullable MetaPropertyPath metaPropertyPath)
protected void	loadStrategyClassFqn(AggregationInfo aggregation, org.dom4j.Element element)
protected void	onMasterDataLoaderPostLoad(Object o)
protected void	setDefaultEditComponent(DataGridColumn<?> column, String property)
protected void	setSelectionMode(com.vaadin.flow.component.grid.Grid.SelectionMode selectionMode)
protected abstract void	setupDataProvider(AbstractGridLoader.GridDataHolder holder)

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

componentLoader, createComponent, getContext, getElement, getFactory, getLayoutLoader, getLoaderResolver, getLoaderSupport, getResultComponent, initComponent, loadBoolean, loadBoolean, loadDouble, loadDouble, loadEnum, loadEnum, loadId, loadInteger, loadInteger, loadResourceString, loadResourceString, loadResourceString, loadString, loadString, loadString, loadVisible, setApplicationContext, setContext, setElement, setFactory, setLoaderResolver, setLoaderSupport

Methods inherited from class java.lang.Object

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

Field Details

COLUMN_ELEMENT_NAME

public static final String COLUMN_ELEMENT_NAME

See Also:

• Constant Field Values

EDITOR_ACTIONS_COLUMN_ELEMENT_NAME

public static final String EDITOR_ACTIONS_COLUMN_ELEMENT_NAME

See Also:

• Constant Field Values

actionLoaderSupport

protected ActionLoaderSupport actionLoaderSupport

metaDataTools

protected MetadataTools metaDataTools

messages

protected Messages messages

masterDataLoaderPostLoadListener

protected Subscription masterDataLoaderPostLoadListener

fetchPlanRepository

protected FetchPlanRepositoryImpl fetchPlanRepository

classManager

protected ClassManager classManager

accessManager

protected AccessManager accessManager

iconLoaderSupport

protected IconLoaderSupport iconLoaderSupport

pendingToFilterableColumns

protected List<DataGridColumn<?>> pendingToFilterableColumns

Constructor Details

AbstractGridLoader

public AbstractGridLoader()

Method Details

loadComponent

public void loadComponent()

Description copied from interface: ComponentLoader

Loads component properties by XML definition.

loadData

protected void loadData()

loadMultiSort

protected void loadMultiSort()

loadColumns

protected void loadColumns(T resultComponent,
 org.dom4j.Element columnsElement,
 MetaClass metaClass,
 FetchPlan fetchPlan)

loadColumnsElementChild

protected void loadColumnsElementChild(T resultComponent,
 org.dom4j.Element columnElement,
 MetaClass metaClass,
 AbstractGridLoader.ColumnDefaultValues columnDefaultValues)

loadEditorActionsColumns

protected void loadEditorActionsColumns(T resultComponent,
 org.dom4j.Element columnsElement,
 MetaClass metaClass)

loadEditorActionsColumn

protected void loadEditorActionsColumn(T resultComponent,
 org.dom4j.Element columnElement,
 MetaClass metaClass)

configureParentViewReadOnlyChangeListener

protected void configureParentViewReadOnlyChangeListener(com.vaadin.flow.component.button.Button editButton)

createEditColumn

protected com.vaadin.flow.component.grid.Grid.Column<?> createEditColumn(T resultComponent,
 org.dom4j.Element columnElement,
 com.vaadin.flow.component.grid.editor.Editor editor,
 MetaClass metaClass)

loadEditorButton

protected @Nullable com.vaadin.flow.component.button.Button loadEditorButton(org.dom4j.Element columnElement,
 String buttonElementName)

loadColumnsByInclude

protected void loadColumnsByInclude(T component,
 org.dom4j.Element columnsElement,
 MetaClass metaClass,
 FetchPlan fetchPlan,
 AbstractGridLoader.ColumnDefaultValues columnDefaultValues)

loadColumn

protected void loadColumn(T component,
 org.dom4j.Element element,
 MetaClass metaClass,
 AbstractGridLoader.ColumnDefaultValues columnDefaultValues)

addEmptyColumn

protected DataGridColumn<?> addEmptyColumn(String key)

loadRenderer

protected Optional<? extends com.vaadin.flow.data.renderer.Renderer> loadRenderer(org.dom4j.Element columnElement,
 MetaClass metaClass,
 @Nullable MetaPropertyPath metaPropertyPath)

getRendererCreationContext

protected RendererProvider.RendererCreationContext getRendererCreationContext(MetaClass metaClass,
 @Nullable MetaPropertyPath metaPropertyPath,
 org.dom4j.Element element)

loadColumnSortable

protected void loadColumnSortable(org.dom4j.Element element,
 boolean sortableColumns,
 DataGridColumn<?> column,
 @Nullable MetaPropertyPath metaPropertyPath)

loadColumnSortable

protected void loadColumnSortable(org.dom4j.Element element,
 DataGridColumn<?> column,
 boolean sortableColumns)

loadColumnResizable

protected void loadColumnResizable(org.dom4j.Element element,
 DataGridColumn<?> column,
 boolean resizableColumns)

loadColumnFilterable

protected void loadColumnFilterable(org.dom4j.Element element,
 DataGridColumn<?> column,
 boolean defaultFilterable)

loadColumnEditable

protected void loadColumnEditable(org.dom4j.Element element,
 DataGridColumn<?> column,
 @Nullable String property)

setSelectionMode

protected void setSelectionMode(com.vaadin.flow.component.grid.Grid.SelectionMode selectionMode)

loadAggregationInfo

protected void loadAggregationInfo(org.dom4j.Element columnElement,
 DataGridColumn<?> column)

loadStrategyClassFqn

protected void loadStrategyClassFqn(AggregationInfo aggregation,
 org.dom4j.Element element)

setDefaultEditComponent

protected void setDefaultEditComponent(DataGridColumn<?> column,
 String property)

addColumn

protected DataGridColumn<?> addColumn(String key,
 MetaPropertyPath metaPropertyPath)

getAppliedProperties

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

getOverriddenColumn

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

loadMetaClass

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

initMasterDataLoaderListener

protected void initMasterDataLoaderListener(CollectionPropertyContainer<?> collectionContainer)

initDataGridDataHolder

protected AbstractGridLoader.GridDataHolder initDataGridDataHolder()

onMasterDataLoaderPostLoad

protected void onMasterDataLoaderPostLoad(Object o)

getFetchPlanRepository

protected FetchPlanRepositoryImpl getFetchPlanRepository()

getActionLoaderSupport

protected ActionLoaderSupport getActionLoaderSupport()

getMetaDataTools

protected MetadataTools getMetaDataTools()

getMessages

protected Messages getMessages()

getClassManager

protected ClassManager getClassManager()

getAccessManager

protected AccessManager getAccessManager()

iconLoaderSupport

protected IconLoaderSupport iconLoaderSupport()

loadMessage

protected @Nullable String loadMessage(@Nullable String message)

setupDataProvider

protected abstract void setupDataProvider(AbstractGridLoader.GridDataHolder holder)

loadContextMenu

protected void loadContextMenu()

loadEmptyStateComponent

protected void loadEmptyStateComponent()

addContextMenuItem

protected void addContextMenuItem(Function<com.vaadin.flow.component.Component,com.vaadin.flow.component.grid.contextmenu.GridMenuItem<?>> menuItemGenerator,
 Consumer<com.vaadin.flow.component.Component> separatorConsumer,
 org.dom4j.Element childElement)

loadContextMenuItem

protected void loadContextMenuItem(GridContextMenuItemComponent<?> component,
 com.vaadin.flow.component.grid.contextmenu.GridMenuItem<?> menuItem,
 org.dom4j.Element itemElement)

loadContextMenuItemAction

protected void loadContextMenuItemAction(GridContextMenuItemComponent<?> component,
 org.dom4j.Element element)

isTransientProperty

protected boolean isTransientProperty(@Nullable MetaPropertyPath metaPropertyPath)

loadActions

protected void loadActions()