com.haulmont.cuba.gui.components

Interface Table<E extends io.jmix.core.Entity>

Type Parameters:

E - entity

All Superinterfaces:

io.jmix.ui.component.ActionsHolder, io.jmix.ui.component.Component, io.jmix.ui.component.Component.BelongToFrame, io.jmix.ui.component.Component.Editable, io.jmix.ui.component.Component.Focusable, io.jmix.ui.component.Component.HasCaption, io.jmix.ui.component.Component.HasDescription, io.jmix.ui.component.Component.HasIcon, io.jmix.ui.component.HasButtonsPanel, io.jmix.ui.component.HasContextHelp, HasDataLoadingSettings, io.jmix.ui.component.HasHtmlCaption, io.jmix.ui.component.HasHtmlDescription, io.jmix.ui.component.HasHtmlSanitizer, io.jmix.ui.component.HasPagination, HasPresentations, HasRowsCount, HasSettings, io.jmix.ui.component.HasSubParts, io.jmix.ui.component.HasTablePresentations, io.jmix.ui.component.ListComponent<E>, io.jmix.ui.component.LookupComponent<E>, RowsCount.RowsCountTarget, io.jmix.ui.component.Table<E>

All Known Subinterfaces:

GroupTable<E>, TreeTable<E>

Deprecated.

Use Table instead

@Deprecated
public interface Table<E extends io.jmix.core.Entity>
extends ListComponent<E>, io.jmix.ui.component.Table<E>, HasSettings, HasDataLoadingSettings, HasPresentations, HasRowsCount, RowsCount.RowsCountTarget, LookupComponent<E>

Component compatible with Datasource.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Table.CellClickEvent<T> Deprecated. Use Table.Column.ClickEvent instead
static interface	Table.CellClickListener<T> Deprecated. Use Table.Column.addClickListener(Consumer) instead.
static class	Table.Column<E extends io.jmix.core.Entity> Deprecated. Use Table.Column instead
static interface	Table.ColumnCollapseListener Deprecated. Use Table.addColumnCollapseListener(Consumer) instead

Nested classes/interfaces inherited from interface com.haulmont.cuba.gui.components.ListComponent

ListComponent.IconProvider<E>

Nested classes/interfaces inherited from interface io.jmix.ui.component.Table

io.jmix.ui.component.Table.AggregationDistributionContext<E>, io.jmix.ui.component.Table.AggregationDistributionProvider<E>, io.jmix.ui.component.Table.AggregationStyle, io.jmix.ui.component.Table.ColumnAlignment, io.jmix.ui.component.Table.ColumnCollapseEvent<E>, io.jmix.ui.component.Table.ColumnGenerator<E>, io.jmix.ui.component.Table.ColumnReorderEvent<E>, io.jmix.ui.component.Table.EmptyStateClickEvent<E>, io.jmix.ui.component.Table.PlainTextCell, io.jmix.ui.component.Table.Printable<E,P>, io.jmix.ui.component.Table.PrintableColumnGenerator<E,P>, io.jmix.ui.component.Table.RowHeaderMode, io.jmix.ui.component.Table.SelectionEvent<E>, io.jmix.ui.component.Table.SortDirection, io.jmix.ui.component.Table.SortInfo, io.jmix.ui.component.Table.StyleProvider<E>

Nested classes/interfaces inherited from interface io.jmix.ui.component.Component

io.jmix.ui.component.Component.Alignment, io.jmix.ui.component.Component.BelongToFrame, io.jmix.ui.component.Component.Disposable, io.jmix.ui.component.Component.Editable, io.jmix.ui.component.Component.Focusable, io.jmix.ui.component.Component.HasCaption, io.jmix.ui.component.Component.HasDescription, io.jmix.ui.component.Component.HasIcon, io.jmix.ui.component.Component.HasXmlDescriptor, io.jmix.ui.component.Component.Wrapper

Nested classes/interfaces inherited from interface io.jmix.ui.component.HasContextHelp

io.jmix.ui.component.HasContextHelp.ContextHelpIconClickEvent

Nested classes/interfaces inherited from interface com.haulmont.cuba.gui.components.LookupComponent

LookupComponent.LookupSelectionChangeNotifier<T>

Nested classes/interfaces inherited from interface io.jmix.ui.component.LookupComponent

io.jmix.ui.component.LookupComponent.LookupSelectionChangeEvent<T>

Field Summary

Fields inherited from interface io.jmix.ui.component.Table

NAME

Fields inherited from interface io.jmix.ui.component.Component

AUTO_SIZE, AUTO_SIZE_PX, FULL_SIZE

Method Summary

Modifier and Type	Method and Description
default void	addColumnCollapsedListener(Table.ColumnCollapseListener columnCollapsedListener) Deprecated. Use Table.addColumnCollapseListener(Consumer) instead
default CollectionDatasource	getDatasource() Deprecated. Use ListComponent.getItems() instead
Datasource	getItemDatasource(io.jmix.core.Entity item) Deprecated. Use Table.getInstanceContainer(Object) instead.
static <T extends io.jmix.core.Entity> com.google.common.reflect.TypeToken<Table<T>>	of(java.lang.Class<T> itemClass) Deprecated.
void	refresh() Deprecated. refresh datasource instead
void	removeClickListener(java.lang.String columnId) Deprecated. Use Subscription instead
void	removeColumnCollapseListener(java.util.function.Consumer<io.jmix.ui.component.Table.ColumnCollapseEvent<E>> listener) Deprecated. Use Subscription instead
default void	removeColumnCollapseListener(Table.ColumnCollapseListener columnCollapseListener) Deprecated. Use Table.addColumnCollapseListener(Consumer) instead
void	setCellClickListener(java.lang.String columnId, java.util.function.Consumer<Table.CellClickEvent<E>> clickListener) Deprecated. Use Table.Column.addClickListener(Consumer) instead
default void	setClickListener(java.lang.String columnId, Table.CellClickListener<? super E> clickListener) Deprecated. Use Table.Column.addClickListener(Consumer) instead
default void	setDatasource(CollectionDatasource datasource) Deprecated. Use Table.setItems(TableItems) instead
void	sortBy(java.lang.Object propertyId, boolean ascending) Deprecated. Use Table.sort(String, SortDirection) method

Methods inherited from interface io.jmix.ui.component.Table

addColumn, addColumn, addColumn, addColumn, addColumnCollapseListener, addColumnReorderListener, addGeneratedColumn, addGeneratedColumn, addGeneratedColumn, addPrintable, addSelectionListener, addStyleProvider, getAggregationDistributionProvider, getAggregationResults, getAggregationStyle, getColumn, getColumnControlVisible, getColumnReorderingAllowed, getColumns, getEmptyStateLinkClickHandler, getEmptyStateLinkMessage, getEmptyStateMessage, getEnterPressAction, getInstanceContainer, getItemClickAction, getItemDescriptionProvider, getItems, getNotCollapsedColumns, getPrintable, getPrintable, getRowHeaderWidth, getSortInfo, getSubPart, isAggregatable, isColumnHeaderVisible, isContextMenuEnabled, isMultiLineCells, isShowSelection, isShowTotalAggregation, isSortable, isTextSelectionEnabled, removeColumn, removeGeneratedColumn, removePrintable, removeStyleProvider, repaint, requestFocus, scrollTo, selectAll, setAggregatable, setAggregationDistributionProvider, setAggregationStyle, setColumnControlVisible, setColumnHeaderVisible, setColumnReorderingAllowed, setContextMenuEnabled, setEmptyStateLinkClickHandler, setEmptyStateLinkMessage, setEmptyStateMessage, setEnterPressAction, setIconProvider, setItemClickAction, setItemDescriptionProvider, setItems, setMultiLineCells, setMultiSelect, setRequired, setRowHeaderMode, setRowHeaderWidth, setShowSelection, setShowTotalAggregation, setSortable, setStyleProvider, setTextSelectionEnabled, showCustomPopup, showCustomPopupActions, sort

Methods inherited from interface io.jmix.ui.component.ListComponent

getSelected, getSingleSelected, isMultiSelect, setSelected, setSelected

Methods inherited from interface io.jmix.ui.component.Component.BelongToFrame

getFrame, setFrame

Methods inherited from interface io.jmix.ui.component.ActionsHolder

addAction, addAction, getAction, getActionNN, getActions, removeAction, removeAction, removeAllActions

Methods inherited from interface io.jmix.ui.component.Component

addStyleName, getAlignment, getHeight, getHeightSizeUnit, getId, getParent, getStyleName, getWidth, getWidthSizeUnit, isEnabled, isEnabledRecursive, isResponsive, isVisible, isVisibleRecursive, removeStyleName, setAlignment, setEnabled, setHeight, setHeightAuto, setHeightFull, setId, setParent, setResponsive, setSizeAuto, setSizeFull, setStyleName, setVisible, setWidth, setWidthAuto, setWidthFull, unwrap, unwrapComposition, unwrapCompositionOrNull, unwrapOrNull, withUnwrapped, withUnwrappedComposition

Methods inherited from interface io.jmix.ui.component.Component.Editable

isEditable, isEditableWithParent, setEditable

Methods inherited from interface io.jmix.ui.component.HasButtonsPanel

getButtonsPanel, setButtonsPanel

Methods inherited from interface io.jmix.ui.component.HasContextHelp

getContextHelpIconClickHandler, getContextHelpText, isContextHelpTextHtmlEnabled, setContextHelpIconClickHandler, setContextHelpText, setContextHelpTextHtmlEnabled

Methods inherited from interface io.jmix.ui.component.Component.HasIcon

getIcon, setIcon, setIconFromSet

Methods inherited from interface io.jmix.ui.component.Component.Focusable

focus, getTabIndex, isFocusable, setFocusable, setTabIndex

Methods inherited from interface io.jmix.ui.component.HasHtmlCaption

isCaptionAsHtml, setCaptionAsHtml

Methods inherited from interface io.jmix.ui.component.Component.HasCaption

getCaption, setCaption

Methods inherited from interface io.jmix.ui.component.Component.HasDescription

getDescription, setDescription

Methods inherited from interface io.jmix.ui.component.HasHtmlDescription

isDescriptionAsHtml, setDescriptionAsHtml

Methods inherited from interface io.jmix.ui.component.HasHtmlSanitizer

isHtmlSanitizerEnabled, setHtmlSanitizerEnabled

Methods inherited from interface io.jmix.ui.component.HasPagination

getPagination, setPagination

Methods inherited from interface com.haulmont.cuba.gui.components.HasSettings

applySettings, isSettingsEnabled, saveSettings, setSettingsEnabled

Methods inherited from interface com.haulmont.cuba.gui.components.HasDataLoadingSettings

applyDataLoadingSettings

Methods inherited from interface com.haulmont.cuba.gui.components.HasPresentations

isUsePresentations, usePresentations

Methods inherited from interface io.jmix.ui.component.HasTablePresentations

applyPresentation, applyPresentationAsDefault, getDefaultPresentationId, getDefaultSettings, getPresentations, loadPresentations, resetPresentation, setDefaultSettings

Methods inherited from interface com.haulmont.cuba.gui.components.HasRowsCount

getRowsCount, setRowsCount, setRowsCountTotalCountDelegate

Methods inherited from interface io.jmix.ui.component.LookupComponent

getLookupSelectedItems, setLookupSelectHandler

Method Detail

of

static <T extends io.jmix.core.Entity> com.google.common.reflect.TypeToken<Table<T>> of(java.lang.Class<T> itemClass)

Deprecated.

Specified by:

of in interface io.jmix.ui.component.Table<E extends io.jmix.core.Entity>

setDatasource

@Deprecated
default void setDatasource(CollectionDatasource datasource)

Deprecated. Use Table.setItems(TableItems) instead

Sets CollectionDatasource as Table data source.

Parameters:

datasource - collection datasource

getDatasource

@Deprecated
default CollectionDatasource getDatasource()

Deprecated. Use ListComponent.getItems() instead

Returns:

collection datasource

refresh

@Deprecated
void refresh()

Deprecated. refresh datasource instead

getItemDatasource

@Deprecated
Datasource getItemDatasource(io.jmix.core.Entity item)

Deprecated. Use Table.getInstanceContainer(Object) instead.

This method returns the datasource which contains the provided item. It can be used in data-aware components, created in generated columns.
Do not save to final variables, just get it from table when you need.

 modelsTable.addGeneratedColumn(
     "numberOfSeats",
     new Table.ColumnGenerator<Model>() {
         public Component generateCell(Model entity) {
             LookupField lookupField = componentsFactory.createComponent(LookupField.NAME);
             lookupField.setDatasource(modelsTable.getItemDatasource(entity), "numberOfSeats");
             lookupField.setOptionsList(Arrays.asList(2, 4, 5));
             lookupField.setWidth("100px");
             return lookupField;
         }
     }
 );
 

Parameters:

item - entity item

Returns:

datasource containing the item

sortBy

@Deprecated
void sortBy(java.lang.Object propertyId,
                        boolean ascending)

Deprecated. Use Table.sort(String, SortDirection) method

Sorts the table by a column. For example:

table.sortBy(table.getDatasource().getMetaClass().getPropertyPath("name"), ascending);

Parameters:

propertyId - column indicated by a corresponding MetaPropertyPath object

ascending - sort direction

addColumnCollapsedListener

@Deprecated
default void addColumnCollapsedListener(Table.ColumnCollapseListener columnCollapsedListener)

Deprecated. Use Table.addColumnCollapseListener(Consumer) instead

Parameters:

columnCollapsedListener - a listener to add

removeColumnCollapseListener

@Deprecated
default void removeColumnCollapseListener(Table.ColumnCollapseListener columnCollapseListener)

Deprecated. Use Table.addColumnCollapseListener(Consumer) instead

Parameters:

columnCollapseListener - a listener to remove

removeColumnCollapseListener

@Deprecated
void removeColumnCollapseListener(java.util.function.Consumer<io.jmix.ui.component.Table.ColumnCollapseEvent<E>> listener)

Deprecated. Use Subscription instead

Parameters:

listener - a listener to remove

setClickListener

@Deprecated
default void setClickListener(java.lang.String columnId,
                                          Table.CellClickListener<? super E> clickListener)

Deprecated. Use Table.Column.addClickListener(Consumer) instead

Adds lightweight click handler for column cells.
Web specific: cell value will be wrapped in span with cuba-table-clickable-cell style name.
You can use .cuba-table-clickable-cell for CSS rules to specify custom representation of cell value.

Parameters:

columnId - id of column

clickListener - click listener

setCellClickListener

@Deprecated
void setCellClickListener(java.lang.String columnId,
                                      java.util.function.Consumer<Table.CellClickEvent<E>> clickListener)

Deprecated. Use Table.Column.addClickListener(Consumer) instead

Adds lightweight click handler for text in column cells.
Web specific: cell value will be wrapped in span with cuba-table-clickable-cell style name.
You can use .cuba-table-clickable-cell for CSS rules to specify custom representation of cell value.

You cannot use cellClickListener for column with maxTextLength attribute, since cellClickListener is already defined to display abbreviated cell text.

Parameters:

columnId - id of column

clickListener - cell text click listener

removeClickListener

@Deprecated
void removeClickListener(java.lang.String columnId)

Deprecated. Use Subscription instead

Removes click listener.

Parameters:

columnId - id of column