com.haulmont.cuba.web.widgets

Class CubaGrid<T>

java.lang.Object

com.vaadin.server.AbstractClientConnector

com.vaadin.ui.AbstractComponent

com.vaadin.ui.AbstractListing<T>

com.vaadin.ui.Grid<T>

com.haulmont.cuba.web.widgets.CubaGrid<T>

All Implemented Interfaces:

CubaEnhancedGrid<T>, 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, java.io.Serializable, java.lang.Iterable<com.vaadin.ui.Component>

public class CubaGrid<T>
extends com.vaadin.ui.Grid<T>
implements CubaEnhancedGrid<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 com.haulmont.cuba.web.widgets.CubaEnhancedGrid

CubaEnhancedGrid.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 CubaEnhancedGrid.AggregationPosition	aggregationPosition
protected java.util.Collection<java.lang.String>	aggregationPropertyIds
protected CubaGridEditorFieldFactory<T>	editorFieldFactory
protected java.lang.Runnable	emptyStateLinkClickHandler
protected HtmlAttributesExtension	htmlAttributesExtension

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

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()
CubaEnhancedGrid.AggregationPosition	getAggregationPosition()
java.util.Collection<java.lang.String>	getAggregationPropertyIds()
CubaEditorField<?>	getColumnEditorField(T bean, com.vaadin.ui.Grid.Column<T,?> column)
java.util.Map<java.lang.String,java.lang.String>	getColumnIds()
CubaGridEditorFieldFactory<T>	getCubaEditorFieldFactory()
java.lang.String	getDeselectAllLabel()
java.lang.String	getEmptyStateLinkMessage()
java.lang.String	getEmptyStateMessage()
protected HtmlAttributesExtension	getHtmlAttributesExtension()
java.lang.Float	getMinHeight()
com.vaadin.server.Sizeable.Unit	getMinHeightSizeUnit()
java.lang.Float	getMinWidth()
com.vaadin.server.Sizeable.Unit	getMinWidthSizeUnit()
com.vaadin.shared.ui.ContentMode	getRowDescriptionContentMode()
java.lang.String	getSelectAllLabel()
protected com.haulmont.cuba.web.widgets.client.grid.CubaGridState	getState()
protected com.haulmont.cuba.web.widgets.client.grid.CubaGridState	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(CubaEnhancedGrid.AggregationPosition position)
void	setBeforeRefreshHandler(java.util.function.Consumer<T> beforeRefreshHandler)
void	setColumnIds(java.util.Map<java.lang.String,java.lang.String> ids)
void	setCubaEditorFieldFactory(CubaGridEditorFieldFactory<T> editorFieldFactory)
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	setMinHeight(java.lang.String minHeight)
void	setMinWidth(java.lang.String minWidth)
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, getCubaId, getData, getDebugId, getDescription, getErrorMessage, getHeight, getHeightUnits, getIcon, getId, 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, setCubaId, setData, setDebugId, setDescription, setDescription, setEnabled, setHeight, setHeightFull, setHeightUndefined, setIcon, setId, 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, getCubaId, getDescription, getIcon, getId, getLocale, getParent, getPrimaryStyleName, getStyleName, getUI, isEnabled, isVisible, readDesign, removeListener, removeStyleName, removeStyleNames, setCaption, setCubaId, setEnabled, setIcon, setId, 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 CubaGridEditorFieldFactory<T> editorFieldFactory

emptyStateLinkClickHandler

protected java.lang.Runnable emptyStateLinkClickHandler

aggregatable

protected boolean aggregatable

aggregationPosition

protected CubaEnhancedGrid.AggregationPosition aggregationPosition

aggregationPropertyIds

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

htmlAttributesExtension

protected HtmlAttributesExtension htmlAttributesExtension

Constructor Detail

CubaGrid

public CubaGrid()

Method Detail

setGridSelectionModel

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

Specified by:

setGridSelectionModel in interface CubaEnhancedGrid<T>

getState

protected com.haulmont.cuba.web.widgets.client.grid.CubaGridState getState()

Overrides:

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

getState

protected com.haulmont.cuba.web.widgets.client.grid.CubaGridState 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 CubaEnhancedGrid<T>

setColumnIds

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

Specified by:

setColumnIds in interface CubaEnhancedGrid<T>

addColumnId

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

Specified by:

addColumnId in interface CubaEnhancedGrid<T>

removeColumnId

public void removeColumnId(java.lang.String column)

Specified by:

removeColumnId in interface CubaEnhancedGrid<T>

repaint

public void repaint()

Specified by:

repaint in interface CubaEnhancedGrid<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>

getCubaEditorFieldFactory

public CubaGridEditorFieldFactory<T> getCubaEditorFieldFactory()

Specified by:

getCubaEditorFieldFactory in interface CubaEnhancedGrid<T>

setCubaEditorFieldFactory

public void setCubaEditorFieldFactory(CubaGridEditorFieldFactory<T> editorFieldFactory)

Specified by:

setCubaEditorFieldFactory in interface CubaEnhancedGrid<T>

createEditor

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

Overrides:

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

getColumnEditorField

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

Specified by:

getColumnEditorField in interface CubaEnhancedGrid<T>

setBeforeRefreshHandler

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

Specified by:

setBeforeRefreshHandler in interface CubaEnhancedGrid<T>

setShowEmptyState

public void setShowEmptyState(boolean show)

Specified by:

setShowEmptyState in interface CubaEnhancedGrid<T>

getEmptyStateMessage

public java.lang.String getEmptyStateMessage()

Specified by:

getEmptyStateMessage in interface CubaEnhancedGrid<T>

setEmptyStateMessage

public void setEmptyStateMessage(java.lang.String message)

Specified by:

setEmptyStateMessage in interface CubaEnhancedGrid<T>

getEmptyStateLinkMessage

public java.lang.String getEmptyStateLinkMessage()

Specified by:

getEmptyStateLinkMessage in interface CubaEnhancedGrid<T>

setEmptyStateLinkMessage

public void setEmptyStateLinkMessage(java.lang.String linkMessage)

Specified by:

setEmptyStateLinkMessage in interface CubaEnhancedGrid<T>

setEmptyStateLinkClickHandler

public void setEmptyStateLinkClickHandler(java.lang.Runnable handler)

Specified by:

setEmptyStateLinkClickHandler in interface CubaEnhancedGrid<T>

updateFooterVisibility

public void updateFooterVisibility()

Description copied from interface: CubaEnhancedGrid

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

Specified by:

updateFooterVisibility in interface CubaEnhancedGrid<T>

getSelectAllLabel

public java.lang.String getSelectAllLabel()

Specified by:

getSelectAllLabel in interface CubaEnhancedGrid<T>

setSelectAllLabel

public void setSelectAllLabel(java.lang.String selectAllLabel)

Specified by:

setSelectAllLabel in interface CubaEnhancedGrid<T>

getDeselectAllLabel

public java.lang.String getDeselectAllLabel()

Specified by:

getDeselectAllLabel in interface CubaEnhancedGrid<T>

setDeselectAllLabel

public void setDeselectAllLabel(java.lang.String deselectAllLabel)

Specified by:

setDeselectAllLabel in interface CubaEnhancedGrid<T>

isAggregatable

public boolean isAggregatable()

Specified by:

isAggregatable in interface CubaEnhancedGrid<T>

setAggregatable

public void setAggregatable(boolean aggregatable)

Specified by:

setAggregatable in interface CubaEnhancedGrid<T>

getAggregationPosition

public CubaEnhancedGrid.AggregationPosition getAggregationPosition()

Specified by:

getAggregationPosition in interface CubaEnhancedGrid<T>

setAggregationPosition

public void setAggregationPosition(CubaEnhancedGrid.AggregationPosition position)

Specified by:

setAggregationPosition in interface CubaEnhancedGrid<T>

getAggregationPropertyIds

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

Specified by:

getAggregationPropertyIds in interface CubaEnhancedGrid<T>

addAggregationPropertyId

public void addAggregationPropertyId(java.lang.String propertyId)

Specified by:

addAggregationPropertyId in interface CubaEnhancedGrid<T>

removeAggregationPropertyId

public void removeAggregationPropertyId(java.lang.String propertyId)

Specified by:

removeAggregationPropertyId in interface CubaEnhancedGrid<T>

getRowDescriptionContentMode

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

Specified by:

getRowDescriptionContentMode in interface CubaEnhancedGrid<T>

getMinHeight

@Nullable
public java.lang.Float getMinHeight()

Specified by:

getMinHeight in interface CubaEnhancedGrid<T>

getMinHeightSizeUnit

@Nullable
public com.vaadin.server.Sizeable.Unit getMinHeightSizeUnit()

Specified by:

getMinHeightSizeUnit in interface CubaEnhancedGrid<T>

setMinHeight

public void setMinHeight(@Nullable
                         java.lang.String minHeight)

Specified by:

setMinHeight in interface CubaEnhancedGrid<T>

getMinWidth

@Nullable
public java.lang.Float getMinWidth()

Specified by:

getMinWidth in interface CubaEnhancedGrid<T>

getMinWidthSizeUnit

@Nullable
public com.vaadin.server.Sizeable.Unit getMinWidthSizeUnit()

Specified by:

getMinWidthSizeUnit in interface CubaEnhancedGrid<T>

setMinWidth

public void setMinWidth(@Nullable
                        java.lang.String minWidth)

Specified by:

setMinWidth in interface CubaEnhancedGrid<T>

getHtmlAttributesExtension

protected HtmlAttributesExtension getHtmlAttributesExtension()