Package 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>,Serializable,Iterable<com.vaadin.ui.Component>
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class com.vaadin.ui.Grid
com.vaadin.ui.Grid.AbstractGridExtension<T extends Object>, com.vaadin.ui.Grid.Column<T extends Object,V extends Object>, com.vaadin.ui.Grid.ColumnReorderEvent, com.vaadin.ui.Grid.ColumnResizeEvent, com.vaadin.ui.Grid.ColumnVisibilityChangeEvent, com.vaadin.ui.Grid.DetailsManager<T extends Object>, com.vaadin.ui.Grid.FetchItemsCallback<T extends Object>, com.vaadin.ui.Grid.GridContextClickEvent<T extends Object>, com.vaadin.ui.Grid.ItemClick<T extends Object>, com.vaadin.ui.Grid.SelectionMode Nested classes/interfaces inherited from class com.vaadin.ui.AbstractListing
com.vaadin.ui.AbstractListing.AbstractListingExtension<T extends Object>Nested classes/interfaces inherited from class com.vaadin.server.AbstractClientConnector
com.vaadin.server.AbstractClientConnector.IncorrectConcurrentAccessHandlerNested 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.DetachListenerNested 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.ListenerNested classes/interfaces inherited from interface com.vaadin.ui.Component.HasContextHelp
com.vaadin.ui.Component.HasContextHelp.ContextHelpIconClickEvent, com.vaadin.ui.Component.HasContextHelp.ContextHelpIconClickListenerNested 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.ComponentDetachListenerNested classes/interfaces inherited from interface io.jmix.ui.widget.JmixEnhancedGrid
JmixEnhancedGrid.AggregationPositionNested classes/interfaces inherited from interface com.vaadin.server.Sizeable
com.vaadin.server.Sizeable.Unit -
Field Summary
FieldsModifier and TypeFieldDescriptionprotected booleanprotected JmixEnhancedGrid.AggregationPositionprotected Collection<String>protected JmixGridEditorFieldFactory<T>protected Runnableprotected HtmlAttributesExtensionFields inherited from class com.vaadin.ui.AbstractComponent
componentErrorProvider, DESIGN_ATTR_PLAIN_TEXT, requiredErrorFields 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 -
Method Summary
Modifier and TypeMethodDescriptionvoidaddAggregationPropertyId(String propertyId) voidaddColumnId(String column, 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>getColumnEditorField(T bean, com.vaadin.ui.Grid.Column<T, ?> column) protected HtmlAttributesExtensioncom.vaadin.server.Sizeable.Unitcom.vaadin.server.Sizeable.Unitcom.vaadin.shared.ui.ContentModeprotected JmixGridStategetState()protected JmixGridStategetState(boolean markAsDirty) booleanvoidremoveAggregationPropertyId(String propertyId) voidremoveColumnId(String column) voidrepaint()voidsetAggregatable(boolean aggregatable) voidvoidsetBeforeRefreshHandler(Consumer<T> beforeRefreshHandler) voidsetColumnIds(Map<String, String> ids) voidsetDeselectAllLabel(String deselectAllLabel) voidsetEmptyStateLinkClickHandler(Runnable handler) voidsetEmptyStateLinkMessage(String linkMessage) voidsetEmptyStateMessage(String message) voidsetGridSelectionModel(com.vaadin.ui.components.grid.GridSelectionModel<T> model) voidsetJmixEditorFieldFactory(JmixGridEditorFieldFactory<T> editorFieldFactory) voidsetMinHeight(String minHeight) voidsetMinWidth(String minWidth) voidsetSelectAllLabel(String selectAllLabel) voidsetShowEmptyState(boolean show) voidCAUTION! 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, writeDataMethods inherited from class com.vaadin.ui.AbstractListing
addDataGenerator, focus, getDataCommunicator, getItemCaptionGenerator, getItemIconGenerator, getTabIndex, internalGetDataProvider, internalSetDataProvider, readDesign, readItem, removeDataGenerator, serializeDeclarativeRepresentation, setItemCaptionGenerator, setItemIconGenerator, setTabIndex, writeDesign, writeItem, writeItemsMethods 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, setWidthUndefinedMethods 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, updateDiffstateMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, waitMethods 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, setErrorHandlerMethods 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, writeDesignMethods inherited from interface com.vaadin.shared.Connector
getConnectorIdMethods inherited from interface com.vaadin.data.HasDataProvider
setItemsMethods inherited from interface com.vaadin.data.HasItems
setItems, setItemsMethods inherited from interface java.lang.Iterable
forEach, spliteratorMethods inherited from interface com.vaadin.server.Sizeable
getHeight, getHeightUnits, getWidth, getWidthUnits, setHeight, setHeightFull, setHeightUndefined, setSizeFull, setSizeUndefined, setWidth, setWidth, setWidthFull, setWidthUndefined
-
Field Details
-
editorFieldFactory
-
emptyStateLinkClickHandler
-
aggregatable
protected boolean aggregatable -
aggregationPosition
-
aggregationPropertyIds
-
htmlAttributesExtension
-
-
Constructor Details
-
JmixGrid
public JmixGrid()
-
-
Method Details
-
setGridSelectionModel
- Specified by:
setGridSelectionModelin interfaceJmixEnhancedGrid<T>
-
getState
- Overrides:
getStatein classcom.vaadin.ui.Grid<T>
-
getState
- Overrides:
getStatein classcom.vaadin.ui.Grid<T>
-
getColumnIds
- Specified by:
getColumnIdsin interfaceJmixEnhancedGrid<T>
-
setColumnIds
- Specified by:
setColumnIdsin interfaceJmixEnhancedGrid<T>
-
addColumnId
- Specified by:
addColumnIdin interfaceJmixEnhancedGrid<T>
-
removeColumnId
- Specified by:
removeColumnIdin interfaceJmixEnhancedGrid<T>
-
repaint
public void repaint()- Specified by:
repaintin interfaceJmixEnhancedGrid<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:
createColumnin classcom.vaadin.ui.Grid<T>
-
getJmixEditorFieldFactory
- Specified by:
getJmixEditorFieldFactoryin interfaceJmixEnhancedGrid<T>
-
setJmixEditorFieldFactory
- Specified by:
setJmixEditorFieldFactoryin interfaceJmixEnhancedGrid<T>
-
createEditor
- Overrides:
createEditorin classcom.vaadin.ui.Grid<T>
-
getColumnEditorField
- Specified by:
getColumnEditorFieldin interfaceJmixEnhancedGrid<T>
-
setBeforeRefreshHandler
- Specified by:
setBeforeRefreshHandlerin interfaceJmixEnhancedGrid<T>
-
setShowEmptyState
public void setShowEmptyState(boolean show) - Specified by:
setShowEmptyStatein interfaceJmixEnhancedGrid<T>
-
getEmptyStateMessage
- Specified by:
getEmptyStateMessagein interfaceJmixEnhancedGrid<T>
-
setEmptyStateMessage
- Specified by:
setEmptyStateMessagein interfaceJmixEnhancedGrid<T>
-
getEmptyStateLinkMessage
- Specified by:
getEmptyStateLinkMessagein interfaceJmixEnhancedGrid<T>
-
setEmptyStateLinkMessage
- Specified by:
setEmptyStateLinkMessagein interfaceJmixEnhancedGrid<T>
-
setEmptyStateLinkClickHandler
- Specified by:
setEmptyStateLinkClickHandlerin interfaceJmixEnhancedGrid<T>
-
getSelectAllLabel
- Specified by:
getSelectAllLabelin interfaceJmixEnhancedGrid<T>
-
setSelectAllLabel
- Specified by:
setSelectAllLabelin interfaceJmixEnhancedGrid<T>
-
getDeselectAllLabel
- Specified by:
getDeselectAllLabelin interfaceJmixEnhancedGrid<T>
-
setDeselectAllLabel
- Specified by:
setDeselectAllLabelin interfaceJmixEnhancedGrid<T>
-
isAggregatable
public boolean isAggregatable()- Specified by:
isAggregatablein interfaceJmixEnhancedGrid<T>
-
setAggregatable
public void setAggregatable(boolean aggregatable) - Specified by:
setAggregatablein interfaceJmixEnhancedGrid<T>
-
getAggregationPosition
- Specified by:
getAggregationPositionin interfaceJmixEnhancedGrid<T>
-
setAggregationPosition
- Specified by:
setAggregationPositionin interfaceJmixEnhancedGrid<T>
-
getAggregationPropertyIds
- Specified by:
getAggregationPropertyIdsin interfaceJmixEnhancedGrid<T>
-
addAggregationPropertyId
- Specified by:
addAggregationPropertyIdin interfaceJmixEnhancedGrid<T>
-
removeAggregationPropertyId
- Specified by:
removeAggregationPropertyIdin interfaceJmixEnhancedGrid<T>
-
getRowDescriptionContentMode
public com.vaadin.shared.ui.ContentMode getRowDescriptionContentMode()- Specified by:
getRowDescriptionContentModein interfaceJmixEnhancedGrid<T>
-
getMinHeight
- Specified by:
getMinHeightin interfaceJmixEnhancedGrid<T>
-
getMinHeightSizeUnit
@Nullable public com.vaadin.server.Sizeable.Unit getMinHeightSizeUnit()- Specified by:
getMinHeightSizeUnitin interfaceJmixEnhancedGrid<T>
-
setMinHeight
- Specified by:
setMinHeightin interfaceJmixEnhancedGrid<T>
-
getMinWidth
- Specified by:
getMinWidthin interfaceJmixEnhancedGrid<T>
-
getMinWidthSizeUnit
@Nullable public com.vaadin.server.Sizeable.Unit getMinWidthSizeUnit()- Specified by:
getMinWidthSizeUnitin interfaceJmixEnhancedGrid<T>
-
setMinWidth
- Specified by:
setMinWidthin interfaceJmixEnhancedGrid<T>
-
getHtmlAttributesExtension
-