Package io.jmix.flowui.component.gridlayout

Class GridLayout<T>

java.lang.Object

com.vaadin.flow.component.Component

io.jmix.flowui.kit.component.gridlayout.JmixGridLayout<T>

io.jmix.flowui.component.gridlayout.GridLayout<T>

Type Parameters:

T - the type of the items displayed in this layout

All Implemented Interfaces:

com.vaadin.flow.component.AttachNotifier, com.vaadin.flow.component.DetachNotifier, com.vaadin.flow.component.HasComponents, com.vaadin.flow.component.HasElement, com.vaadin.flow.component.HasEnabled, com.vaadin.flow.component.HasSize, com.vaadin.flow.component.HasStyle, com.vaadin.flow.data.binder.HasItemComponents<T>, com.vaadin.flow.data.provider.HasDataView<T,Void,GridLayoutDataView<T>>, com.vaadin.flow.data.provider.HasListDataView<T,GridLayoutListDataView<T>>, SupportsDataProvider<T>, SupportsItemsContainer<T>, SupportsItemsEnum<T>, Serializable, org.springframework.beans.factory.Aware, org.springframework.beans.factory.InitializingBean, org.springframework.context.ApplicationContextAware

public class GridLayout<T>
extends JmixGridLayout<T>
implements SupportsDataProvider<T>, SupportsItemsContainer<T>, SupportsItemsEnum<T>, org.springframework.context.ApplicationContextAware, org.springframework.beans.factory.InitializingBean

Represents a customizable grid layout component for displaying data in a grid-based format. Provides integration with data sources to support data binding, items enumeration, and other features.

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface com.vaadin.flow.data.binder.HasItemComponents

com.vaadin.flow.data.binder.HasItemComponents.ItemComponent<T extends Object>

Field Summary

Fields

Modifier and Type	Field	Description
protected org.springframework.context.ApplicationContext	applicationContext
protected DataViewDelegate<GridLayout<T>,T>	dataViewDelegate
protected MetadataTools	metadataTools

Fields inherited from class io.jmix.flowui.kit.component.gridlayout.JmixGridLayout

dataProvider, dataProviderListenerRegistration, itemLabelGenerator, itemRenderer, items, lastFetchedDataSize, lastNotifiedDataSize, sizeRequest

Constructor Summary

Constructors

Constructor	Description
GridLayout()

Method Summary

Modifier and Type	Method	Description
void	afterPropertiesSet()
protected String	applyDefaultValueFormat(T item)
protected void	autowireDependencies()
protected void	bindDataProvider(com.vaadin.flow.data.provider.DataProvider<T,?> dataProvider)
protected DataViewDelegate<GridLayout<T>,T>	createItemsDelegate()
com.vaadin.flow.data.provider.DataProvider<T,?>	getDataProvider()	Gets the data provider used by this JmixGridLayout.
protected void	initComponent()
void	setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
GridLayoutDataView<T>	setItems(com.vaadin.flow.data.provider.DataProvider<T,Void> dataProvider)	Sets a generic data provider for the JmixGridLayout to use and returns the base GridLayoutDataView that provides API to get information on the items.
GridLayoutDataView<T>	setItems(com.vaadin.flow.data.provider.InMemoryDataProvider<T> inMemoryDataProvider)	Sets an in-memory data provider for the JmixGridLayout to use.
GridLayoutListDataView<T>	setItems(com.vaadin.flow.data.provider.ListDataProvider<T> listDataProvider)	Sets a ListDataProvider for the JmixGridLayout to use and returns a ListDataView that provides information and allows operation on the items.
void	setItems(CollectionContainer<T> container)	Sets items from the passed CollectionContainer.
void	setItems(Class<T> itemsEnum)	Sets items from the passed EnumClass.

Methods inherited from class io.jmix.flowui.kit.component.gridlayout.JmixGridLayout

createItemComponent, fireSizeEvent, getColumnMinWidth, getGap, getGenericDataView, getItemComponents, getItemId, getItemLabelGenerator, getItemRenderer, getListDataView, handleDataChange, onAttach, onDetach, rebuild, refresh, refreshContent, runBeforeClientResponse, setColumnMinWidth, setDataProvider, setGap, setItemLabelGenerator, setRenderer, setupDataProviderListener

Methods inherited from class com.vaadin.flow.component.Component

addListener, findAncestor, fireEvent, from, get, getChildren, getElement, getEventBus, getId, getListeners, getLocale, getParent, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getUI, hasListener, isAttached, isTemplateMapped, isVisible, onEnabledStateChanged, removeFromParent, scrollIntoView, scrollIntoView, set, setElement, setId, setVisible

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.vaadin.flow.component.AttachNotifier

addAttachListener

Methods inherited from interface com.vaadin.flow.component.DetachNotifier

addDetachListener

Methods inherited from interface com.vaadin.flow.component.HasComponents

add, add, add, addComponentAsFirst, addComponentAtIndex, remove, remove, removeAll

Methods inherited from interface com.vaadin.flow.component.HasElement

getElement

Methods inherited from interface com.vaadin.flow.component.HasEnabled

isEnabled, setEnabled

Methods inherited from interface com.vaadin.flow.data.binder.HasItemComponents

addComponents, getItemPosition, prependComponents

Methods inherited from interface com.vaadin.flow.data.provider.HasListDataView

setItems, setItems

Methods inherited from interface com.vaadin.flow.component.HasSize

getHeight, getHeightUnit, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getWidth, getWidthUnit, setHeight, setHeight, setHeightFull, setMaxHeight, setMaxHeight, setMaxWidth, setMaxWidth, setMinHeight, setMinHeight, setMinWidth, setMinWidth, setSizeFull, setSizeUndefined, setWidth, setWidth, setWidthFull

Methods inherited from interface com.vaadin.flow.component.HasStyle

addClassName, addClassNames, getClassName, getClassNames, getStyle, hasClassName, removeClassName, removeClassNames, setClassName, setClassName

Field Details

applicationContext

protected org.springframework.context.ApplicationContext applicationContext

metadataTools

protected MetadataTools metadataTools

dataViewDelegate

protected DataViewDelegate<GridLayout<T>,T> dataViewDelegate

Constructor Details

GridLayout

public GridLayout()

Method Details

setApplicationContext

public void setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
                           throws org.springframework.beans.BeansException

Specified by:

setApplicationContext in interface org.springframework.context.ApplicationContextAware

Throws:

org.springframework.beans.BeansException

afterPropertiesSet

public void afterPropertiesSet()
                        throws Exception

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

Throws:

Exception

autowireDependencies

protected void autowireDependencies()

initComponent

protected void initComponent()

applyDefaultValueFormat

protected String applyDefaultValueFormat(T item)

setItems

public void setItems(CollectionContainer<T> container)

Description copied from interface: SupportsItemsContainer

Sets items from the passed CollectionContainer.

Specified by:

setItems in interface SupportsItemsContainer<T>

Parameters:

container - a CollectionContainer to be used as items source

See Also:

• ContainerDataProvider

setItems

public void setItems(Class<T> itemsEnum)

Description copied from interface: SupportsItemsEnum

Sets items from the passed EnumClass.

Specified by:

setItems in interface SupportsItemsEnum<T>

Parameters:

itemsEnum - a EnumClass to be used as items source

See Also:

• EnumDataProvider

setItems

public GridLayoutDataView<T> setItems(com.vaadin.flow.data.provider.DataProvider<T,Void> dataProvider)

Description copied from class: JmixGridLayout

Sets a generic data provider for the JmixGridLayout to use and returns the base GridLayoutDataView that provides API to get information on the items.

This method should be used only when the data provider type is not either ListDataProvider or BackEndDataProvider.

Specified by:

setItems in interface com.vaadin.flow.data.provider.HasDataView<T,Void,GridLayoutDataView<T>>

Overrides:

setItems in class JmixGridLayout<T>

Parameters:

dataProvider - DataProvider instance to use, not null

Returns:

GridLayoutDataView providing information on the data

setItems

public GridLayoutDataView<T> setItems(com.vaadin.flow.data.provider.InMemoryDataProvider<T> inMemoryDataProvider)

Description copied from class: JmixGridLayout

Sets an in-memory data provider for the JmixGridLayout to use.

Note! Using a ListDataProvider instead of a InMemoryDataProvider is recommended to get access to GridLayoutListDataView API by using HasListDataView.setItems(ListDataProvider).

Specified by:

setItems in interface com.vaadin.flow.data.provider.HasDataView<T,Void,GridLayoutDataView<T>>

Overrides:

setItems in class JmixGridLayout<T>

Parameters:

inMemoryDataProvider - data provider to use, not null

Returns:

GridLayoutDataView providing information on the data

setItems

public GridLayoutListDataView<T> setItems(com.vaadin.flow.data.provider.ListDataProvider<T> listDataProvider)

Description copied from class: JmixGridLayout

Sets a ListDataProvider for the JmixGridLayout to use and returns a ListDataView that provides information and allows operation on the items.

Specified by:

setItems in interface com.vaadin.flow.data.provider.HasListDataView<T,GridLayoutListDataView<T>>

Overrides:

setItems in class JmixGridLayout<T>

Parameters:

listDataProvider - ListDataProvider providing items to the JmixGridLayout.

Returns:

GridLayoutListDataView providing access to the items

bindDataProvider

protected void bindDataProvider(com.vaadin.flow.data.provider.DataProvider<T,?> dataProvider)

getDataProvider

@Nullable
public com.vaadin.flow.data.provider.DataProvider<T,?> getDataProvider()

Description copied from class: JmixGridLayout

Gets the data provider used by this JmixGridLayout.

To get information and control over the items in the JmixGridLayout, use either JmixGridLayout.getListDataView() or JmixGridLayout.getGenericDataView() instead.

Specified by:

getDataProvider in interface SupportsDataProvider<T>

Overrides:

getDataProvider in class JmixGridLayout<T>

Returns:

the data provider used by this JmixGridLayout

createItemsDelegate

protected DataViewDelegate<GridLayout<T>,T> createItemsDelegate()