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 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.ComponentContext, ComponentLoader.Context, ComponentLoader.InitTask

Field Summary

Fields

Modifier and Type	Field	Description
protected ActionLoaderSupport	actionLoaderSupport
static final String	ATTRIBUTE_JMIX_ROLE_NAME
protected ClassManager	classManager
static final String	COLUMN_ELEMENT_NAME
static final String	COLUMN_FILTER_BUTTON_ACTIVATED_ATTRIBUTE_NAME
static final String	COLUMN_FILTER_BUTTON_ROLE
static final String	COLUMN_FILTER_DIALOG_CLASSNAME
static final String	COLUMN_FILTER_FOOTER_SMALL_CLASSNAME
static final String	COLUMN_FILTER_POPUP_CLASSNAME
static final String	EDITOR_ACTIONS_COLUMN_ELEMENT_NAME
protected FetchPlanRepositoryImpl	fetchPlanRepository
protected Subscription	masterDataLoaderPostLoadListener
protected Messages	messages
protected MetadataTools	metaDataTools
protected PropertyFilterSupport	propertyFilterSupport

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

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

Constructor Summary

Constructors

Constructor	Description
AbstractGridLoader()

Method Summary

Modifier and Type	Method	Description
protected com.vaadin.flow.component.grid.Grid.Column<?>	addColumn(String key, MetaPropertyPath metaPropertyPath)
protected com.vaadin.flow.component.grid.Grid.Column<?>	addEmptyColumn(String key)
protected JmixButton	createApplyButton(PropertyFilter propertyFilter, com.vaadin.flow.component.dialog.Dialog dialog, AtomicReference appliedValue)
protected JmixButton	createCancelButton(PropertyFilter propertyFilter, com.vaadin.flow.component.dialog.Dialog dialog, AtomicReference appliedValue)
protected JmixButton	createClearFilterButton(PropertyFilter propertyFilter)
protected com.vaadin.flow.component.grid.Grid.Column<?>	createEditColumn(T resultComponent, org.dom4j.Element columnElement, com.vaadin.flow.component.grid.editor.Editor editor)
protected com.vaadin.flow.component.Component	createFilterButton(PropertyFilter<?> propertyFilter)
protected com.vaadin.flow.component.Component	createHeaderComponent(String headerText, com.vaadin.flow.component.Component filterButton)
protected com.vaadin.flow.component.dialog.Dialog	createOverlay(PropertyFilter propertyFilter, JmixButton filterButton)
protected PropertyFilter<?>	createPropertyFilter(DataLoader dataLoader, MetaClass metaClass, String property)
protected void	doApply(PropertyFilter propertyFilter, com.vaadin.flow.component.dialog.Dialog dialog, AtomicReference appliedValue)
protected void	doCancel(PropertyFilter propertyFilter, com.vaadin.flow.component.dialog.Dialog dialog, AtomicReference appliedValue)
protected ActionLoaderSupport	getActionLoaderSupport()
protected Collection<String>	getAppliedProperties(org.dom4j.Element columnsElement, FetchPlan fetchPlan, MetaClass metaClass)
protected ClassManager	getClassManager()
protected FetchPlanRepositoryImpl	getFetchPlanRepository()
protected Messages	getMessages()
protected MetadataTools	getMetaDataTools()
protected String	getOverlayPositionExpression()
protected org.dom4j.Element	getOverriddenColumn(List<org.dom4j.Element> columns, String property)
protected PropertyFilterSupport	getPropertyFilterSupport()
protected AbstractGridLoader.GridDataHolder	initDataGridDataHolder()
protected void	initMasterDataLoaderListener(CollectionPropertyContainer<?> collectionContainer)
protected boolean	isSmallDevice()
protected void	loadAggregationInfo(org.dom4j.Element columnElement, com.vaadin.flow.component.grid.Grid.Column<?> column)
protected void	loadColumn(T component, org.dom4j.Element element, DataLoader dataLoader, MetaClass metaClass, boolean sortableColumns, boolean resizableColumns)
protected void	loadColumnEditable(org.dom4j.Element element, com.vaadin.flow.component.grid.Grid.Column<?> column, String property)
protected void	loadColumnFilterable(org.dom4j.Element element, com.vaadin.flow.component.grid.Grid.Column<?> column, DataLoader dataLoader, MetaClass metaClass, String property)
protected void	loadColumnResizable(org.dom4j.Element element, com.vaadin.flow.component.grid.Grid.Column<?> column, boolean resizableColumns)
protected void	loadColumns(T resultComponent, org.dom4j.Element columnsElement, AbstractGridLoader.GridDataHolder holder, FetchPlan fetchPlan)
protected void	loadColumnsByInclude(T component, org.dom4j.Element columnsElement, AbstractGridLoader.GridDataHolder holder, FetchPlan fetchPlan, boolean sortableColumns, boolean resizableColumns)
protected void	loadColumnsElementChild(T resultComponent, org.dom4j.Element columnElement, AbstractGridLoader.GridDataHolder holder, boolean sortableColumns, boolean resizableColumns)
protected void	loadColumnSortable(org.dom4j.Element element, com.vaadin.flow.component.grid.Grid.Column<?> column, boolean sortableColumns)
void	loadComponent()	Loads component properties by XML definition.
protected void	loadData()
protected void	loadEditorActionsColumn(T resultComponent, org.dom4j.Element columnElement)
protected void	loadEditorActionsColumns(T resultComponent, org.dom4j.Element columnsElement)
protected com.vaadin.flow.component.button.Button	loadEditorButton(org.dom4j.Element columnElement, String buttonElementName)
protected void	loadMetaClass(org.dom4j.Element element, Consumer<MetaClass> setter)
protected void	loadMultiSort()
protected Optional<com.vaadin.flow.data.renderer.Renderer>	loadRenderer(org.dom4j.Element columnElement, MetaPropertyPath metaPropertyPath)
protected void	loadStrategyClassFqn(AggregationInfo aggregation, org.dom4j.Element element)
protected void	onDialogOpen(com.vaadin.flow.component.dialog.Dialog.OpenedChangeEvent event, PropertyFilter propertyFilter, JmixButton filterButton)
protected void	onMasterDataLoaderPostLoad(Object o)
protected void	setDefaultEditComponent(com.vaadin.flow.component.grid.Grid.Column<?> column, String property)
protected void	setFilterComponent(com.vaadin.flow.component.grid.Grid.Column<?> column, DataLoader dataLoader, MetaClass metaClass, String property)
protected abstract void	setupDataProvider(AbstractGridLoader.GridDataHolder holder)

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

componentLoader, createComponent, getComponentContext, getContext, getElement, getFactory, getLayoutLoader, getLoaderResolver, getLoaderSupport, getResultComponent, initComponent, loadBoolean, loadBoolean, loadDouble, loadDouble, loadEnum, loadEnum, loadId, loadInteger, loadInteger, loadResourceString, loadResourceString, loadString, loadString, loadVisible, setApplicationContext, setContext, setElement, setEnvironment, 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

COLUMN_FILTER_POPUP_CLASSNAME

public static final String COLUMN_FILTER_POPUP_CLASSNAME

See Also:

• Constant Field Values

COLUMN_FILTER_DIALOG_CLASSNAME

public static final String COLUMN_FILTER_DIALOG_CLASSNAME

See Also:

• Constant Field Values

COLUMN_FILTER_FOOTER_SMALL_CLASSNAME

public static final String COLUMN_FILTER_FOOTER_SMALL_CLASSNAME

See Also:

• Constant Field Values

ATTRIBUTE_JMIX_ROLE_NAME

public static final String ATTRIBUTE_JMIX_ROLE_NAME

See Also:

• Constant Field Values

COLUMN_FILTER_BUTTON_ROLE

public static final String COLUMN_FILTER_BUTTON_ROLE

See Also:

• Constant Field Values

COLUMN_FILTER_BUTTON_ACTIVATED_ATTRIBUTE_NAME

public static final String COLUMN_FILTER_BUTTON_ACTIVATED_ATTRIBUTE_NAME

See Also:

• Constant Field Values

actionLoaderSupport

protected ActionLoaderSupport actionLoaderSupport

metaDataTools

protected MetadataTools metaDataTools

masterDataLoaderPostLoadListener

protected Subscription masterDataLoaderPostLoadListener

fetchPlanRepository

protected FetchPlanRepositoryImpl fetchPlanRepository

classManager

protected ClassManager classManager

messages

protected Messages messages

propertyFilterSupport

protected PropertyFilterSupport propertyFilterSupport

Constructor Details

AbstractGridLoader

public AbstractGridLoader()

Method Details

loadComponent

public void loadComponent()

Description copied from interface: ComponentLoader

Loads component properties by XML definition.

See Also:

• ComponentLoader.getElement(Element)

loadData

protected void loadData()

loadMultiSort

protected void loadMultiSort()

loadColumns

protected void loadColumns(T resultComponent,
 org.dom4j.Element columnsElement,
 AbstractGridLoader.GridDataHolder holder,
 FetchPlan fetchPlan)

loadColumnsElementChild

protected void loadColumnsElementChild(T resultComponent,
 org.dom4j.Element columnElement,
 AbstractGridLoader.GridDataHolder holder,
 boolean sortableColumns,
 boolean resizableColumns)

loadEditorActionsColumns

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

loadEditorActionsColumn

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

createEditColumn

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

loadEditorButton

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

loadColumnsByInclude

protected void loadColumnsByInclude(T component,
 org.dom4j.Element columnsElement,
 AbstractGridLoader.GridDataHolder holder,
 FetchPlan fetchPlan,
 boolean sortableColumns,
 boolean resizableColumns)

loadColumn

protected void loadColumn(T component,
 org.dom4j.Element element,
 @Nullable
 DataLoader dataLoader,
 MetaClass metaClass,
 boolean sortableColumns,
 boolean resizableColumns)

addEmptyColumn

protected com.vaadin.flow.component.grid.Grid.Column<?> addEmptyColumn(String key)

loadRenderer

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

loadColumnSortable

protected void loadColumnSortable(org.dom4j.Element element,
 com.vaadin.flow.component.grid.Grid.Column<?> column,
 boolean sortableColumns)

loadColumnResizable

protected void loadColumnResizable(org.dom4j.Element element,
 com.vaadin.flow.component.grid.Grid.Column<?> column,
 boolean resizableColumns)

loadColumnFilterable

protected void loadColumnFilterable(org.dom4j.Element element,
 com.vaadin.flow.component.grid.Grid.Column<?> column,
 @Nullable
 DataLoader dataLoader,
 MetaClass metaClass,
 String property)

setFilterComponent

protected void setFilterComponent(com.vaadin.flow.component.grid.Grid.Column<?> column,
 DataLoader dataLoader,
 MetaClass metaClass,
 String property)

createPropertyFilter

protected PropertyFilter<?> createPropertyFilter(DataLoader dataLoader,
 MetaClass metaClass,
 String property)

createFilterButton

protected com.vaadin.flow.component.Component createFilterButton(PropertyFilter<?> propertyFilter)

createOverlay

protected com.vaadin.flow.component.dialog.Dialog createOverlay(PropertyFilter propertyFilter,
 JmixButton filterButton)

onDialogOpen

protected void onDialogOpen(com.vaadin.flow.component.dialog.Dialog.OpenedChangeEvent event,
 PropertyFilter propertyFilter,
 JmixButton filterButton)

createClearFilterButton

protected JmixButton createClearFilterButton(PropertyFilter propertyFilter)

createApplyButton

protected JmixButton createApplyButton(PropertyFilter propertyFilter,
 com.vaadin.flow.component.dialog.Dialog dialog,
 AtomicReference appliedValue)

createCancelButton

protected JmixButton createCancelButton(PropertyFilter propertyFilter,
 com.vaadin.flow.component.dialog.Dialog dialog,
 AtomicReference appliedValue)

doApply

protected void doApply(PropertyFilter propertyFilter,
 com.vaadin.flow.component.dialog.Dialog dialog,
 AtomicReference appliedValue)

doCancel

protected void doCancel(PropertyFilter propertyFilter,
 com.vaadin.flow.component.dialog.Dialog dialog,
 AtomicReference appliedValue)

createHeaderComponent

protected com.vaadin.flow.component.Component createHeaderComponent(String headerText,
 com.vaadin.flow.component.Component filterButton)

loadColumnEditable

protected void loadColumnEditable(org.dom4j.Element element,
 com.vaadin.flow.component.grid.Grid.Column<?> column,
 String property)

loadAggregationInfo

protected void loadAggregationInfo(org.dom4j.Element columnElement,
 com.vaadin.flow.component.grid.Grid.Column<?> column)

loadStrategyClassFqn

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

setDefaultEditComponent

protected void setDefaultEditComponent(com.vaadin.flow.component.grid.Grid.Column<?> column,
 String property)

addColumn

protected com.vaadin.flow.component.grid.Grid.Column<?> addColumn(String key,
 MetaPropertyPath metaPropertyPath)

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)

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()

getClassManager

protected ClassManager getClassManager()

getPropertyFilterSupport

protected PropertyFilterSupport getPropertyFilterSupport()

getMessages

protected Messages getMessages()

getOverlayPositionExpression

protected String getOverlayPositionExpression()

isSmallDevice

protected boolean isSmallDevice()

setupDataProvider

protected abstract void setupDataProvider(AbstractGridLoader.GridDataHolder holder)