io.jmix.ui.widget

Interface JmixEnhancedTable

All Superinterfaces:

AggregationContainer, com.vaadin.v7.data.Container, java.io.Serializable

All Known Implementing Classes:

GroupTableImpl.JmixGroupTableExt, JmixGroupTable, JmixTable, JmixTreeTable

public interface JmixEnhancedTable
extends AggregationContainer

Interface to generalize additional functionality in JmixTable, JmixGroupTable and JmixTreeTable

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	JmixEnhancedTable.AggregationInputValueChangeContext
static class	JmixEnhancedTable.AggregationStyle
static interface	JmixEnhancedTable.CellClickListener Receives the events if the user clicks on text in a cell or the 'maxTextLength' is set for column cell.
static interface	JmixEnhancedTable.CellValueFormatter
static interface	JmixEnhancedTable.PlainTextGeneratedColumn Marker interface for generated columns which return String value.
static interface	JmixEnhancedTable.SpecificVariablesHandler
static class	JmixEnhancedTable.TableCellClickEvent An event is fired when the user clicks inside the table cell.
static interface	JmixEnhancedTable.TableCellClickListener Receives the events when the user clicks on a cell.

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

AggregationContainer.Context, AggregationContainer.Type

Nested classes/interfaces inherited from interface com.vaadin.v7.data.Container

com.vaadin.v7.data.Container.Editor, com.vaadin.v7.data.Container.Filter, com.vaadin.v7.data.Container.Filterable, com.vaadin.v7.data.Container.Hierarchical, com.vaadin.v7.data.Container.Indexed, com.vaadin.v7.data.Container.ItemSetChangeEvent, com.vaadin.v7.data.Container.ItemSetChangeListener, com.vaadin.v7.data.Container.ItemSetChangeNotifier, com.vaadin.v7.data.Container.Ordered, com.vaadin.v7.data.Container.PropertySetChangeEvent, com.vaadin.v7.data.Container.PropertySetChangeListener, com.vaadin.v7.data.Container.PropertySetChangeNotifier, com.vaadin.v7.data.Container.SimpleFilterable, com.vaadin.v7.data.Container.Sortable, com.vaadin.v7.data.Container.Viewer

Method Summary

Modifier and Type	Method and Description
void	addAggregationEditableColumn(java.lang.Object columnId)
void	addTableCellClickListener(java.lang.Object propertyId, JmixEnhancedTable.TableCellClickListener listener)
boolean	disableContentBufferRefreshing()
void	enableContentBufferRefreshing(boolean refreshContent)
java.util.function.Consumer<com.vaadin.ui.Component>	getAfterUnregisterComponentHandler()
java.lang.String	getAggregationDescription(java.lang.Object columnId)
java.util.function.Function<JmixEnhancedTable.AggregationInputValueChangeContext,java.lang.Boolean>	getAggregationDistributionProvider()
JmixEnhancedTable.AggregationStyle	getAggregationStyle()
java.lang.Runnable	getBeforeRefreshRowCacheHandler()
boolean	getColumnCaptionAsHtml(java.lang.Object columnId)
java.lang.String	getColumnDescription(java.lang.Object columnId)
boolean	getColumnSortable(java.lang.Object columnId)
JmixEnhancedTable.CellValueFormatter	getCustomCellValueFormatter()
boolean	getCustomPopupAutoClose()
java.lang.String	getDeselectAllLabel()
java.lang.Object[]	getEditableColumns()
java.lang.String	getEmptyStateLinkMessage()
java.lang.String	getEmptyStateMessage()
java.util.function.Function<java.lang.Object,com.vaadin.server.Resource>	getIconProvider()
java.lang.Object	getItemByRowKey(java.lang.String rowKey)
com.vaadin.ui.Component	getPresentationsLayout()
java.lang.String	getSelectAllLabel()
java.lang.String	getSortAscendingLabel()
java.lang.String	getSortDescendingLabel()
java.lang.String	getSortResetLabel()
JmixEnhancedTable.SpecificVariablesHandler	getSpecificVariablesHandler()
void	hideContextMenuPopup()
void	hidePresentationsPopup()
boolean	isAggregatable()
boolean	isAutowirePropertyDsForFields()
boolean	isColumnEditable(java.lang.Object columnId)
boolean	isContextMenuEnabled()
boolean	isMultiLineCells()
boolean	isShowTotalAggregation()
boolean	isTextSelectionEnabled()
void	refreshCellStyles()
void	removeTableCellClickListener(java.lang.Object propertyId)
void	requestFocus(java.lang.Object itemId, java.lang.Object columnId)
void	setAfterUnregisterComponentHandler(java.util.function.Consumer<com.vaadin.ui.Component> afterUnregisterComponentHandler)
void	setAggregatable(boolean aggregatable)
void	setAggregationDescription(java.lang.Object columnId, java.lang.String description)
void	setAggregationDistributionProvider(java.util.function.Function<JmixEnhancedTable.AggregationInputValueChangeContext,java.lang.Boolean> distributionProvider)
void	setAggregationStyle(JmixEnhancedTable.AggregationStyle aggregationStyle)
void	setAutowirePropertyDsForFields(boolean autowirePropertyDsForFields)
void	setBeforePaintListener(java.lang.Runnable beforePaintListener)
void	setBeforeRefreshRowCacheHandler(java.lang.Runnable beforeRefreshRowCacheHandler)
void	setColumnCaptionAsHtml(java.lang.Object columnId, boolean captionAsHtml) Sets whether caption of column with the given columnId should be interpreted as HTML or not.
void	setColumnDescription(java.lang.Object columnId, java.lang.String description)
void	setColumnSortable(java.lang.Object columnId, boolean sortable)
void	setContextMenuEnabled(boolean contextMenuEnabled)
void	setContextMenuPopup(com.vaadin.ui.Layout contextMenu)
void	setCustomCellValueFormatter(JmixEnhancedTable.CellValueFormatter cellValueFormatter)
void	setCustomPopupAutoClose(boolean popupAutoClose)
void	setDeselectAllLabel(java.lang.String deselectAllLabel)
void	setEditableColumns(java.lang.Object[] editableColumns)
void	setEmptyStateLinkClickHandler(java.lang.Runnable handler)
void	setEmptyStateLinkMessage(java.lang.String linkMessage)
void	setEmptyStateMessage(java.lang.String message)
void	setIconProvider(java.util.function.Function<java.lang.Object,com.vaadin.server.Resource> iconProvider)
void	setMultiLineCells(boolean multiLineCells)
void	setPresentationsLayout(com.vaadin.ui.Component presentations)
void	setSelectAllLabel(java.lang.String selectAllLabel)
void	setShowEmptyState(boolean show)
void	setShowTotalAggregation(boolean showTotalAggregation)
void	setSortAscendingLabel(java.lang.String tableSortAscendingLabel)
void	setSortDescendingLabel(java.lang.String tableSortDescendingLabel)
void	setSortOptions(java.lang.Object propertyId, boolean sortAscending) Sets column id to sort and sorting direction.
void	setSortResetLabel(java.lang.String tableSortResetLabel)
void	setSpecificVariablesHandler(JmixEnhancedTable.SpecificVariablesHandler handler)
void	setTextSelectionEnabled(boolean textSelectionEnabled)
void	showCustomPopup(com.vaadin.ui.Component popupComponent)

Methods inherited from interface io.jmix.ui.widget.data.AggregationContainer

addContainerPropertyAggregation, aggregate, aggregateValues, getAggregationPropertyIds, removeContainerPropertyAggregation

Methods inherited from interface com.vaadin.v7.data.Container

addContainerProperty, addItem, addItem, containsId, getContainerProperty, getContainerPropertyIds, getItem, getItemIds, getType, removeAllItems, removeContainerProperty, removeItem, size

Method Detail

setContextMenuPopup

void setContextMenuPopup(com.vaadin.ui.Layout contextMenu)

hideContextMenuPopup

void hideContextMenuPopup()

getPresentationsLayout

@Nullable
com.vaadin.ui.Component getPresentationsLayout()

setPresentationsLayout

void setPresentationsLayout(com.vaadin.ui.Component presentations)

hidePresentationsPopup

void hidePresentationsPopup()

getEditableColumns

java.lang.Object[] getEditableColumns()

setEditableColumns

void setEditableColumns(java.lang.Object[] editableColumns)

getSortDescendingLabel

java.lang.String getSortDescendingLabel()

setSortDescendingLabel

void setSortDescendingLabel(java.lang.String tableSortDescendingLabel)

getSortAscendingLabel

java.lang.String getSortAscendingLabel()

setSortAscendingLabel

void setSortAscendingLabel(java.lang.String tableSortAscendingLabel)

getSortResetLabel

java.lang.String getSortResetLabel()

setSortResetLabel

void setSortResetLabel(java.lang.String tableSortResetLabel)

getSelectAllLabel

java.lang.String getSelectAllLabel()

setSelectAllLabel

void setSelectAllLabel(java.lang.String selectAllLabel)

getDeselectAllLabel

java.lang.String getDeselectAllLabel()

setDeselectAllLabel

void setDeselectAllLabel(java.lang.String deselectAllLabel)

isColumnEditable

boolean isColumnEditable(java.lang.Object columnId)

setMultiLineCells

void setMultiLineCells(boolean multiLineCells)

isMultiLineCells

boolean isMultiLineCells()

isContextMenuEnabled

boolean isContextMenuEnabled()

setContextMenuEnabled

void setContextMenuEnabled(boolean contextMenuEnabled)

isTextSelectionEnabled

boolean isTextSelectionEnabled()

setTextSelectionEnabled

void setTextSelectionEnabled(boolean textSelectionEnabled)

disableContentBufferRefreshing

boolean disableContentBufferRefreshing()

enableContentBufferRefreshing

void enableContentBufferRefreshing(boolean refreshContent)

isAutowirePropertyDsForFields

boolean isAutowirePropertyDsForFields()

setAutowirePropertyDsForFields

void setAutowirePropertyDsForFields(boolean autowirePropertyDsForFields)

refreshCellStyles

void refreshCellStyles()

isAggregatable

boolean isAggregatable()

setAggregatable

void setAggregatable(boolean aggregatable)

setAggregationStyle

void setAggregationStyle(JmixEnhancedTable.AggregationStyle aggregationStyle)

getAggregationStyle

JmixEnhancedTable.AggregationStyle getAggregationStyle()

isShowTotalAggregation

boolean isShowTotalAggregation()

setShowTotalAggregation

void setShowTotalAggregation(boolean showTotalAggregation)

addTableCellClickListener

void addTableCellClickListener(java.lang.Object propertyId,
                               JmixEnhancedTable.TableCellClickListener listener)

removeTableCellClickListener

void removeTableCellClickListener(java.lang.Object propertyId)

showCustomPopup

void showCustomPopup(com.vaadin.ui.Component popupComponent)

getCustomPopupAutoClose

boolean getCustomPopupAutoClose()

setCustomPopupAutoClose

void setCustomPopupAutoClose(boolean popupAutoClose)

getColumnDescription

@Nullable
java.lang.String getColumnDescription(java.lang.Object columnId)

setColumnDescription

void setColumnDescription(java.lang.Object columnId,
                          @Nullable
                          java.lang.String description)

getAggregationDescription

@Nullable
java.lang.String getAggregationDescription(java.lang.Object columnId)

setAggregationDescription

void setAggregationDescription(java.lang.Object columnId,
                               @Nullable
                               java.lang.String description)

getColumnSortable

boolean getColumnSortable(java.lang.Object columnId)

setColumnSortable

void setColumnSortable(java.lang.Object columnId,
                       boolean sortable)

requestFocus

void requestFocus(java.lang.Object itemId,
                  java.lang.Object columnId)

getIconProvider

java.util.function.Function<java.lang.Object,com.vaadin.server.Resource> getIconProvider()

setIconProvider

void setIconProvider(java.util.function.Function<java.lang.Object,com.vaadin.server.Resource> iconProvider)

setSpecificVariablesHandler

void setSpecificVariablesHandler(JmixEnhancedTable.SpecificVariablesHandler handler)

getSpecificVariablesHandler

JmixEnhancedTable.SpecificVariablesHandler getSpecificVariablesHandler()

getAfterUnregisterComponentHandler

java.util.function.Consumer<com.vaadin.ui.Component> getAfterUnregisterComponentHandler()

setAfterUnregisterComponentHandler

void setAfterUnregisterComponentHandler(java.util.function.Consumer<com.vaadin.ui.Component> afterUnregisterComponentHandler)

getBeforeRefreshRowCacheHandler

java.lang.Runnable getBeforeRefreshRowCacheHandler()

setBeforeRefreshRowCacheHandler

void setBeforeRefreshRowCacheHandler(java.lang.Runnable beforeRefreshRowCacheHandler)

addAggregationEditableColumn

void addAggregationEditableColumn(java.lang.Object columnId)

setAggregationDistributionProvider

void setAggregationDistributionProvider(java.util.function.Function<JmixEnhancedTable.AggregationInputValueChangeContext,java.lang.Boolean> distributionProvider)

getAggregationDistributionProvider

java.util.function.Function<JmixEnhancedTable.AggregationInputValueChangeContext,java.lang.Boolean> getAggregationDistributionProvider()

setSortOptions

void setSortOptions(java.lang.Object propertyId,
                    boolean sortAscending)

Sets column id to sort and sorting direction. It doesn't invoke sorting after setting parameters.

Parameters:

propertyId - column id

sortAscending - sort ascending option

setBeforePaintListener

void setBeforePaintListener(java.lang.Runnable beforePaintListener)

setCustomCellValueFormatter

void setCustomCellValueFormatter(@Nullable
                                 JmixEnhancedTable.CellValueFormatter cellValueFormatter)

getCustomCellValueFormatter

@Nullable
JmixEnhancedTable.CellValueFormatter getCustomCellValueFormatter()

setColumnCaptionAsHtml

void setColumnCaptionAsHtml(java.lang.Object columnId,
                            boolean captionAsHtml)

Sets whether caption of column with the given columnId should be interpreted as HTML or not.

Parameters:

columnId - column id

captionAsHtml - interpret caption as HTML or not

getColumnCaptionAsHtml

boolean getColumnCaptionAsHtml(java.lang.Object columnId)

Parameters:

columnId - column id

Returns:

whether caption of column with the given columnId should be interpreted as HTML or not

getItemByRowKey

java.lang.Object getItemByRowKey(java.lang.String rowKey)

Parameters:

rowKey - row index in the table

Returns:

item

setShowEmptyState

void setShowEmptyState(boolean show)

setEmptyStateMessage

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

getEmptyStateMessage

@Nullable
java.lang.String getEmptyStateMessage()

setEmptyStateLinkMessage

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

getEmptyStateLinkMessage

@Nullable
java.lang.String getEmptyStateLinkMessage()

setEmptyStateLinkClickHandler

void setEmptyStateLinkClickHandler(java.lang.Runnable handler)