io.jmix.ui.widget

Class JmixGrid<T>

java.lang.Object

com.vaadin.server.AbstractClientConnector

com.vaadin.ui.AbstractComponent

com.vaadin.ui.AbstractListing<T>

com.vaadin.ui.Grid<T>

io.jmix.ui.widget.JmixGrid<T>

All Implemented Interfaces:

com.vaadin.data.HasDataProvider<T>, com.vaadin.data.HasItems<T>, com.vaadin.event.ContextClickEvent.ContextClickNotifier, com.vaadin.event.MethodEventSource, com.vaadin.event.SortEvent.SortNotifier<com.vaadin.data.provider.GridSortOrder<T>>, com.vaadin.server.ClientConnector, com.vaadin.server.Sizeable, com.vaadin.shared.Connector, com.vaadin.ui.Component, com.vaadin.ui.Component.Focusable, com.vaadin.ui.Component.HasContextHelp, com.vaadin.ui.HasComponents, JmixEnhancedGrid<T>, java.io.Serializable, java.lang.Iterable<com.vaadin.ui.Component>

public class JmixGrid<T>
extends com.vaadin.ui.Grid<T>
implements JmixEnhancedGrid<T>

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.vaadin.ui.Grid

com.vaadin.ui.Grid.AbstractGridExtension<T>, com.vaadin.ui.Grid.Column<T,V>, com.vaadin.ui.Grid.ColumnReorderEvent, com.vaadin.ui.Grid.ColumnResizeEvent, com.vaadin.ui.Grid.ColumnVisibilityChangeEvent, com.vaadin.ui.Grid.DetailsManager<T>, com.vaadin.ui.Grid.FetchItemsCallback<T>, com.vaadin.ui.Grid.GridContextClickEvent<T>, com.vaadin.ui.Grid.ItemClick<T>, com.vaadin.ui.Grid.SelectionMode

Nested classes/interfaces inherited from class com.vaadin.ui.AbstractListing

com.vaadin.ui.AbstractListing.AbstractListingExtension<T>

Nested classes/interfaces inherited from class com.vaadin.server.AbstractClientConnector

com.vaadin.server.AbstractClientConnector.IncorrectConcurrentAccessHandler

Nested classes/interfaces inherited from interface io.jmix.ui.widget.JmixEnhancedGrid

JmixEnhancedGrid.AggregationPosition

Nested classes/interfaces inherited from interface com.vaadin.ui.HasComponents

com.vaadin.ui.HasComponents.ComponentAttachDetachNotifier, com.vaadin.ui.HasComponents.ComponentAttachEvent, com.vaadin.ui.HasComponents.ComponentAttachListener, com.vaadin.ui.HasComponents.ComponentDetachEvent, com.vaadin.ui.HasComponents.ComponentDetachListener

Nested classes/interfaces inherited from interface com.vaadin.ui.Component

com.vaadin.ui.Component.ErrorEvent, com.vaadin.ui.Component.Event, com.vaadin.ui.Component.Focusable, com.vaadin.ui.Component.HasContextHelp, com.vaadin.ui.Component.Listener

Nested classes/interfaces inherited from interface com.vaadin.server.ClientConnector

com.vaadin.server.ClientConnector.AttachEvent, com.vaadin.server.ClientConnector.AttachListener, com.vaadin.server.ClientConnector.ConnectorErrorEvent, com.vaadin.server.ClientConnector.DetachEvent, com.vaadin.server.ClientConnector.DetachListener

Nested classes/interfaces inherited from interface com.vaadin.server.Sizeable

com.vaadin.server.Sizeable.Unit

Nested classes/interfaces inherited from interface com.vaadin.ui.Component.HasContextHelp

com.vaadin.ui.Component.HasContextHelp.ContextHelpIconClickEvent, com.vaadin.ui.Component.HasContextHelp.ContextHelpIconClickListener

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	aggregatable
protected JmixEnhancedGrid.AggregationPosition	aggregationPosition
protected java.util.Collection<java.lang.String>	aggregationPropertyIds
protected JmixGridEditorFieldFactory<T>	editorFieldFactory
protected java.lang.Runnable	emptyStateLinkClickHandler

Fields inherited from class com.vaadin.ui.AbstractComponent

componentErrorProvider, DESIGN_ATTR_PLAIN_TEXT, requiredError

Fields inherited from interface com.vaadin.server.Sizeable

SIZE_UNDEFINED, UNITS_CM, UNITS_EM, UNITS_EX, UNITS_INCH, UNITS_MM, UNITS_PERCENTAGE, UNITS_PICAS, UNITS_PIXELS, UNITS_POINTS

Constructor Summary

Constructors

Constructor and Description
JmixGrid()

Method Summary

Modifier and Type	Method and Description
void	addAggregationPropertyId(java.lang.String propertyId)
void	addColumnId(java.lang.String column, java.lang.String value)
protected <V,P> com.vaadin.ui.Grid.Column<T,V>	createColumn(com.vaadin.data.ValueProvider<T,V> valueProvider, com.vaadin.data.ValueProvider<V,P> presentationProvider, com.vaadin.ui.renderers.AbstractRenderer<? super T,? super P> renderer)
protected com.vaadin.ui.components.grid.Editor<T>	createEditor()
JmixEnhancedGrid.AggregationPosition	getAggregationPosition()
java.util.Collection<java.lang.String>	getAggregationPropertyIds()
JmixEditorField<?>	getColumnEditorField(T bean, com.vaadin.ui.Grid.Column<T,?> column)
java.util.Map<java.lang.String,java.lang.String>	getColumnIds()
java.lang.String	getDeselectAllLabel()
java.lang.String	getEmptyStateLinkMessage()
java.lang.String	getEmptyStateMessage()
JmixGridEditorFieldFactory<T>	getJmixEditorFieldFactory()
com.vaadin.shared.ui.ContentMode	getRowDescriptionContentMode()
java.lang.String	getSelectAllLabel()
protected JmixGridState	getState()
protected JmixGridState	getState(boolean markAsDirty)
boolean	isAggregatable()
void	removeAggregationPropertyId(java.lang.String propertyId)
void	removeColumnId(java.lang.String column)
void	repaint()
void	setAggregatable(boolean aggregatable)
void	setAggregationPosition(JmixEnhancedGrid.AggregationPosition position)
void	setBeforeRefreshHandler(java.util.function.Consumer<T> beforeRefreshHandler)
void	setColumnIds(java.util.Map<java.lang.String,java.lang.String> ids)
void	setDeselectAllLabel(java.lang.String deselectAllLabel)
void	setEmptyStateLinkClickHandler(java.lang.Runnable handler)
void	setEmptyStateLinkMessage(java.lang.String linkMessage)
void	setEmptyStateMessage(java.lang.String message)
void	setGridSelectionModel(com.vaadin.ui.components.grid.GridSelectionModel<T> model)
void	setJmixEditorFieldFactory(JmixGridEditorFieldFactory<T> editorFieldFactory)
void	setSelectAllLabel(java.lang.String selectAllLabel)
void	setShowEmptyState(boolean show)
void	updateFooterVisibility() CAUTION! Safari hides footer while changing predefined styles at runtime.

Methods inherited from class com.vaadin.ui.Grid

addColumn, addColumn, addColumn, addColumn, addColumn, addColumn, addColumn, addColumnReorderListener, addColumnResizeListener, addColumnVisibilityChangeListener, addComponentColumn, addContextClickListener, addFooterRowAt, addHeaderRowAt, addItemClickListener, addSelectionListener, addSortListener, appendFooterRow, appendHeaderRow, asMultiSelect, asSingleSelect, beforeClientResponse, clearSortOrder, createSortingComparator, deselect, deselectAll, deserializeDeclarativeRepresentation, doReadDesign, doWriteDesign, fireColumnVisibilityChangeEvent, getBeanType, getBodyRowHeight, getColumn, getColumnByInternalId, getColumnResizeMode, getColumns, getCustomAttributes, getDataProvider, getDefaultHeaderRow, getDescriptionGenerator, getEditor, getFooter, getFooterRow, getFooterRowCount, getFooterRowHeight, getFrozenColumnCount, getHeader, getHeaderRow, getHeaderRowCount, getHeaderRowHeight, getHeightByRows, getHeightMode, getInternalIdForColumn, getPropertySet, getRowHeight, getSelectedItems, getSelectionModel, getSortOrder, getStyleGenerator, internalSetDataProvider, isColumnReorderingAllowed, isDetailsVisible, isFooterVisible, isHeaderVisible, isReadOnly, iterator, prependFooterRow, prependHeaderRow, readData, readItems, recalculateColumnWidths, removeAllColumns, removeColumn, removeColumn, removeFooterRow, removeFooterRow, removeHeaderRow, removeHeaderRow, scrollTo, scrollTo, scrollToEnd, scrollToStart, select, setBeanType, setBeanType, setBodyRowHeight, setColumnId, setColumnOrder, setColumnOrder, setColumnReorderingAllowed, setColumnResizeMode, setColumns, setColumns, setDataProvider, setDataProvider, setDefaultHeaderRow, setDescriptionGenerator, setDescriptionGenerator, setDetailsGenerator, setDetailsVisible, setFooterRowHeight, setFooterVisible, setFrozenColumnCount, setHeaderRowHeight, setHeaderVisible, setHeight, setHeightByRows, setHeightMode, setPropertySet, setReadOnly, setRowHeight, setSelectionMode, setSelectionModel, setSortOrder, setSortOrder, setStyleGenerator, sort, sort, sort, sort, withPropertySet, writeData

Methods inherited from class com.vaadin.ui.AbstractListing

addDataGenerator, focus, getDataCommunicator, getItemCaptionGenerator, getItemIconGenerator, getTabIndex, internalGetDataProvider, internalSetDataProvider, readDesign, readItem, removeDataGenerator, serializeDeclarativeRepresentation, setItemCaptionGenerator, setItemIconGenerator, setTabIndex, writeDesign, writeItem, writeItems

Methods inherited from class com.vaadin.ui.AbstractComponent

addContextHelpIconClickListener, addListener, addShortcutListener, addStyleName, attach, detach, ensureContextHelpInitialized, findAncestor, fireComponentErrorEvent, fireComponentEvent, fireContextHelpClick, getActionManager, getCaption, getComponentError, getComponentErrorProvider, getContextHelpText, getData, getDebugId, getDescription, getErrorMessage, getHeight, getHeightUnits, getIcon, getId, getJTestId, getLocale, getParent, getPrimaryStyleName, getRequiredError, getStyleName, getWidth, getWidthUnits, isCaptionAsHtml, isConnectorEnabled, isContextHelpTextHtmlEnabled, isEnabled, isOrHasAncestor, isRequiredIndicatorVisible, isResponsive, isVisible, removeContextClickListener, removeListener, removeShortcutListener, removeStyleName, setCaption, setCaptionAsHtml, setComponentError, setComponentErrorProvider, setContextHelpText, setContextHelpTextHtmlEnabled, setData, setDebugId, setDescription, setDescription, setEnabled, setHeight, setHeightFull, setHeightUndefined, setIcon, setId, setJTestId, setLocale, setParent, setPrimaryStyleName, setRequiredError, setRequiredIndicatorVisible, setResponsive, setSizeFull, setSizeUndefined, setStyleName, setVisible, setWidth, setWidth, setWidthFull, setWidthUndefined

Methods inherited from class com.vaadin.server.AbstractClientConnector

addAttachListener, addDetachListener, addExtension, addListener, addListener, addListener, addListener, addListener, addListener, addMethodInvocationToQueue, createState, encodeState, equals, fireEvent, getAllChildrenIterable, getConnectorId, getErrorHandler, getExtensions, getIncorrectConcurrentAccessHandler, getListeners, getResource, getRpcManager, getRpcProxy, getSession, getStateType, getUI, handleConnectorRequest, hashCode, hasListeners, isAttached, isThis, markAsDirty, markAsDirtyRecursive, registerRpc, registerRpc, removeAttachListener, removeDetachListener, removeExtension, removeListener, removeListener, removeListener, removeListener, removeListener, requestRepaint, requestRepaintAll, retrievePendingRpcCalls, setConnectorResource, setErrorHandler, setIncorrectConcurrentAccessHandler, setResource, updateDiffstate

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface com.vaadin.data.HasDataProvider

setItems

Methods inherited from interface com.vaadin.data.HasItems

setItems, setItems

Methods inherited from interface com.vaadin.ui.Component

addListener, addStyleName, addStyleNames, attach, getCaption, getDescription, getIcon, getId, getJTestId, getLocale, getParent, getPrimaryStyleName, getStyleName, getUI, isEnabled, isVisible, readDesign, removeListener, removeStyleName, removeStyleNames, setCaption, setEnabled, setIcon, setId, setJTestId, setParent, setPrimaryStyleName, setStyleName, setStyleName, setVisible, writeDesign

Methods inherited from interface com.vaadin.server.ClientConnector

addAttachListener, addDetachListener, detach, encodeState, getErrorHandler, getExtensions, getRpcManager, getStateType, handleConnectorRequest, isAttached, isConnectorEnabled, markAsDirty, markAsDirtyRecursive, removeAttachListener, removeDetachListener, removeExtension, requestRepaint, requestRepaintAll, retrievePendingRpcCalls, setErrorHandler

Methods inherited from interface com.vaadin.shared.Connector

getConnectorId

Methods inherited from interface com.vaadin.server.Sizeable

getHeight, getHeightUnits, getWidth, getWidthUnits, setHeight, setHeightFull, setHeightUndefined, setSizeFull, setSizeUndefined, setWidth, setWidth, setWidthFull, setWidthUndefined

Field Detail

editorFieldFactory

protected JmixGridEditorFieldFactory<T> editorFieldFactory

emptyStateLinkClickHandler

protected java.lang.Runnable emptyStateLinkClickHandler

aggregatable

protected boolean aggregatable

aggregationPosition

protected JmixEnhancedGrid.AggregationPosition aggregationPosition

aggregationPropertyIds

protected java.util.Collection<java.lang.String> aggregationPropertyIds

Constructor Detail

JmixGrid

public JmixGrid()

Method Detail

setGridSelectionModel

public void setGridSelectionModel(com.vaadin.ui.components.grid.GridSelectionModel<T> model)

Specified by:

setGridSelectionModel in interface JmixEnhancedGrid<T>

getState

protected JmixGridState getState()

Overrides:

getState in class com.vaadin.ui.Grid<T>

getState

protected JmixGridState getState(boolean markAsDirty)

Overrides:

getState in class com.vaadin.ui.Grid<T>

getColumnIds

public java.util.Map<java.lang.String,java.lang.String> getColumnIds()

Specified by:

getColumnIds in interface JmixEnhancedGrid<T>

setColumnIds

public void setColumnIds(java.util.Map<java.lang.String,java.lang.String> ids)

Specified by:

setColumnIds in interface JmixEnhancedGrid<T>

addColumnId

public void addColumnId(java.lang.String column,
                        java.lang.String value)

Specified by:

addColumnId in interface JmixEnhancedGrid<T>

removeColumnId

public void removeColumnId(java.lang.String column)

Specified by:

removeColumnId in interface JmixEnhancedGrid<T>

repaint

public void repaint()

Specified by:

repaint in interface JmixEnhancedGrid<T>

createColumn

protected <V,P> com.vaadin.ui.Grid.Column<T,V> createColumn(com.vaadin.data.ValueProvider<T,V> valueProvider,
                                                            com.vaadin.data.ValueProvider<V,P> presentationProvider,
                                                            com.vaadin.ui.renderers.AbstractRenderer<? super T,? super P> renderer)

Overrides:

createColumn in class com.vaadin.ui.Grid<T>

getJmixEditorFieldFactory

public JmixGridEditorFieldFactory<T> getJmixEditorFieldFactory()

Specified by:

getJmixEditorFieldFactory in interface JmixEnhancedGrid<T>

setJmixEditorFieldFactory

public void setJmixEditorFieldFactory(JmixGridEditorFieldFactory<T> editorFieldFactory)

Specified by:

setJmixEditorFieldFactory in interface JmixEnhancedGrid<T>

createEditor

protected com.vaadin.ui.components.grid.Editor<T> createEditor()

Overrides:

createEditor in class com.vaadin.ui.Grid<T>

getColumnEditorField

public JmixEditorField<?> getColumnEditorField(T bean,
                                               com.vaadin.ui.Grid.Column<T,?> column)

Specified by:

getColumnEditorField in interface JmixEnhancedGrid<T>

setBeforeRefreshHandler

public void setBeforeRefreshHandler(java.util.function.Consumer<T> beforeRefreshHandler)

Specified by:

setBeforeRefreshHandler in interface JmixEnhancedGrid<T>

setShowEmptyState

public void setShowEmptyState(boolean show)

Specified by:

setShowEmptyState in interface JmixEnhancedGrid<T>

getEmptyStateMessage

@Nullable
public java.lang.String getEmptyStateMessage()

Specified by:

getEmptyStateMessage in interface JmixEnhancedGrid<T>

setEmptyStateMessage

public void setEmptyStateMessage(@Nullable
                                 java.lang.String message)

Specified by:

setEmptyStateMessage in interface JmixEnhancedGrid<T>

getEmptyStateLinkMessage

@Nullable
public java.lang.String getEmptyStateLinkMessage()

Specified by:

getEmptyStateLinkMessage in interface JmixEnhancedGrid<T>

setEmptyStateLinkMessage

public void setEmptyStateLinkMessage(@Nullable
                                     java.lang.String linkMessage)

Specified by:

setEmptyStateLinkMessage in interface JmixEnhancedGrid<T>

setEmptyStateLinkClickHandler

public void setEmptyStateLinkClickHandler(java.lang.Runnable handler)

Specified by:

setEmptyStateLinkClickHandler in interface JmixEnhancedGrid<T>

updateFooterVisibility

public void updateFooterVisibility()

Description copied from interface: JmixEnhancedGrid

CAUTION! Safari hides footer while changing predefined styles at runtime. Given method updates footer visibility without changing its value.

Specified by:

updateFooterVisibility in interface JmixEnhancedGrid<T>

getSelectAllLabel

public java.lang.String getSelectAllLabel()

Specified by:

getSelectAllLabel in interface JmixEnhancedGrid<T>

setSelectAllLabel

public void setSelectAllLabel(java.lang.String selectAllLabel)

Specified by:

setSelectAllLabel in interface JmixEnhancedGrid<T>

getDeselectAllLabel

public java.lang.String getDeselectAllLabel()

Specified by:

getDeselectAllLabel in interface JmixEnhancedGrid<T>

setDeselectAllLabel

public void setDeselectAllLabel(java.lang.String deselectAllLabel)

Specified by:

setDeselectAllLabel in interface JmixEnhancedGrid<T>

isAggregatable

public boolean isAggregatable()

Specified by:

isAggregatable in interface JmixEnhancedGrid<T>

setAggregatable

public void setAggregatable(boolean aggregatable)

Specified by:

setAggregatable in interface JmixEnhancedGrid<T>

getAggregationPosition

public JmixEnhancedGrid.AggregationPosition getAggregationPosition()

Specified by:

getAggregationPosition in interface JmixEnhancedGrid<T>

setAggregationPosition

public void setAggregationPosition(JmixEnhancedGrid.AggregationPosition position)

Specified by:

setAggregationPosition in interface JmixEnhancedGrid<T>

getAggregationPropertyIds

public java.util.Collection<java.lang.String> getAggregationPropertyIds()

Specified by:

getAggregationPropertyIds in interface JmixEnhancedGrid<T>

addAggregationPropertyId

public void addAggregationPropertyId(java.lang.String propertyId)

Specified by:

addAggregationPropertyId in interface JmixEnhancedGrid<T>

removeAggregationPropertyId

public void removeAggregationPropertyId(java.lang.String propertyId)

Specified by:

removeAggregationPropertyId in interface JmixEnhancedGrid<T>

getRowDescriptionContentMode

public com.vaadin.shared.ui.ContentMode getRowDescriptionContentMode()

Specified by:

getRowDescriptionContentMode in interface JmixEnhancedGrid<T>