Package io.jmix.ui.component.impl
Class AbstractTable<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable,E>
java.lang.Object
io.jmix.ui.component.impl.AbstractComponent<T>
io.jmix.ui.component.impl.AbstractActionsHolderComponent<T>
io.jmix.ui.component.impl.AbstractTable<T,E>
- All Implemented Interfaces:
ActionsHolder,AttachNotifier,Component,Component.BelongToFrame,Component.Editable,Component.Focusable,Component.HasCaption,Component.HasDescription,Component.HasIcon,Component.HasXmlDescriptor,Component.Wrapper,HasButtonsPanel,HasContextHelp,HasDebugId,HasHtmlCaption,HasHtmlDescription,HasHtmlSanitizer,HasInnerComponents,HasMinSize,HasPagination,HasSubParts,HasTablePresentations,ListComponent<E>,LookupComponent<E>,LookupComponent.LookupSelectionChangeNotifier<E>,SecuredActionsHolder,Table<E>,TableItemsEventsDelegate<E>,InstallTargetHandler,org.springframework.beans.factory.InitializingBean
- Direct Known Subclasses:
GroupTableImpl,TableImpl,TreeTableImpl
public abstract class AbstractTable<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable,E>
extends AbstractActionsHolderComponent<T>
implements Table<E>, TableItemsEventsDelegate<E>, LookupComponent.LookupSelectionChangeNotifier<E>, HasInnerComponents, InstallTargetHandler, org.springframework.beans.factory.InitializingBean
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionprotected classprotected classstatic classprotected static classprotected classprotected classNested classes/interfaces inherited from interface io.jmix.ui.component.Component
Component.Alignment, Component.BelongToFrame, Component.Disposable, Component.Editable, Component.Focusable, Component.HasCaption, Component.HasDescription, Component.HasIcon, Component.HasXmlDescriptor, Component.WrapperNested classes/interfaces inherited from interface io.jmix.ui.component.HasContextHelp
HasContextHelp.ContextHelpIconClickEventNested classes/interfaces inherited from interface io.jmix.ui.component.LookupComponent
LookupComponent.LookupSelectionChangeEvent<T>, LookupComponent.LookupSelectionChangeNotifier<T>Nested classes/interfaces inherited from interface io.jmix.ui.component.Table
Table.AggregationDistributionContext<E>, Table.AggregationDistributionProvider<E>, Table.AggregationStyle, Table.Column<E>, Table.ColumnAlignment, Table.ColumnCollapseEvent<E>, Table.ColumnGenerator<E>, Table.ColumnReorderEvent<E>, Table.EmptyStateClickEvent<E>, Table.PlainTextCell, Table.Printable<E,P>, Table.PrintableColumnGenerator<E, P>, Table.RowHeaderMode, Table.SelectionEvent<E>, Table.SortDirection, Table.SortInfo, Table.StyleProvider<E> -
Field Summary
FieldsModifier and TypeFieldDescriptionprotected AccessManagerprotected Actionsprotected AggregatableDelegate<Object>protected Map<Table.Column,String> protected Aggregationsstatic final Stringstatic final Stringprotected ButtonsPanelprotected com.vaadin.v7.ui.Table.ColumnCollapseListenerprotected Map<Object,Table.Column<E>> protected List<Table.Column<E>>protected TableCompositionprotected UiComponentPropertiesprotected static final Stringprotected TableDataContainer<E>protected DataComponentsprotected DatatypeRegistryprotected TableSettingsprotected Table.AggregationDistributionProvider<E>protected static final Stringprotected booleanprotected Consumer<Table.EmptyStateClickEvent<E>>protected Actionprotected EntityStatesprotected static final Stringprotected IconResolverprotected booleanprotected Actionprotected BiFunction<? super E,String, String> protected Localestatic final intprotected Messagesprotected MessageToolsprotected Metadataprotected MetadataToolsprotected PaginationComponentprotected TablePresentationsprotected Map<String,Table.Printable> protected Map<Table.Column,String> protected static final Objectprotected ComponentSettingsRegistryprotected booleanprotected List<Table.StyleProvider>protected com.vaadin.ui.CssLayoutprotected UiComponentsGeneratorprotected UiTestIdsSupportprotected UserSettingsToolsprotected com.vaadin.v7.ui.Table.ColumnGeneratorprotected static final Stringprotected FetchPlanRepositoryprotected static final com.vaadin.v7.ui.Table.ColumnGeneratorFields inherited from class io.jmix.ui.component.impl.AbstractActionsHolderComponent
actionButtons, actionList, actionPropertyChangeListener, actionsPermissions, contextMenuPopup, shortcutsDelegate, showIconsForPopupMenuActionsFields inherited from class io.jmix.ui.component.impl.AbstractComponent
alignment, applicationContext, component, contextHelpIconClickHandler, contextHelpIconClickListener, descriptionAsHtml, element, frame, htmlSanitizerEnabled, icon, ICON_STYLE, id, parentFields inherited from interface io.jmix.ui.component.Component
AUTO_SIZE, AUTO_SIZE_PX, FULL_SIZE -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescription__aggregate(AggregationContainer container, AggregationContainer.Context context) __aggregateValues(AggregationContainer container, AggregationContainer.Context context) __handleAggregationResults(AggregationContainer.Context context, Map<Object, Object> results) protected voidaddAggregationCell(Table.Column column) voidaddColumn(Table.Column<E> column) Adds the given column to Table.voidaddColumn(Table.Column<E> column, int index) Adds the given column at the specified index to Table.Creates new column with given Id, then adds this column to Table.Creates new column with given Id at the specified index, then adds this column to Table.addColumnCollapseListener(Consumer<Table.ColumnCollapseEvent<E>> listener) Adds a listener for column collapse events.protected voidaddColumnInternal(Table.Column<E> column, int index) addColumnReorderListener(Consumer<Table.ColumnReorderEvent<E>> listener) Registers a new column reorder listener.voidaddGeneratedColumn(String columnId, int index, Table.ColumnGenerator<? super E> generator) Adds a generated column at the specified index to Table.voidaddGeneratedColumn(String columnId, Table.ColumnGenerator<? super E> generator) Adds a generated column to the table.voidaddGeneratedColumn(String columnId, Table.ColumnGenerator<? super E> generator, Class<? extends Component> componentClass) Adds a generated column to the table.protected voidaddGeneratedColumnInternal(Object id, com.vaadin.v7.ui.Table.ColumnGenerator generator) Adds a listener that invoked when lookup selected items set is changed.voidaddPrintable(String columnId, Table.Printable<? super E, ?> printable) AddsTable.Printablerepresentation for column.addSelectionListener(Consumer<Table.SelectionEvent<E>> listener) Registers a new selection listenervoidaddStyleProvider(Table.StyleProvider<? super E> styleProvider) Add style provider for the table.
Table can use several providers to obtain many style names for cells and rows.voidprotected voidvoidvoidprotected voidprotected voidattachAction(Action action) voidattached()Notifies all listeners that component has been attached.protected voidprotected voidprotected booleancanBeSorted(TableItems<E> tableItems) protected voidcheckAggregation(AggregationInfo aggregationInfo) protected voidconvertAggregationKeyMapToColumnIdKeyMap(AggregationContainer container, Map<AggregationInfo, ?> aggregationInfoMap) protected AbstractTable.ColumnImpl<E>createColumn(Object id, AbstractTable<?, E> owner) protected voidcreateColumns(com.vaadin.v7.data.Container ds) protected JmixButtonprotected TableFieldFactoryImplcreateInstallHandler(Class<?> targetObjectType, FrameOwner frameOwner, Method method) protected Consumer<Table.Column.ClickEvent>protected voidprotected AbstractTable<T,E>.StyleGeneratorAdapter protected TableDataContainer<E>createTableDataContainer(TableItems<E> tableItems) protected TablePresentationsprotected TablePresentationsLayoutprotected com.vaadin.ui.CssLayoutvoiddetached()Notifies all listeners that component has been detached.protected voiddisableEditableColumns(EntityTableItems<E> entityTableSource, Collection<MetaPropertyPath> propertyIds) protected booleanprotected voidenableEditableColumns(EntityTableItems<E> entityTableSource, Collection<MetaPropertyPath> propertyIds) protected voidfireSelectionEvent(com.vaadin.v7.data.Property.ValueChangeEvent e) voidfocus()Sets focus to this componentprotected StringformatCellValue(Object rowId, Object colId, com.vaadin.v7.data.Property<?> property) protected StringformatFileRef(FileRef file) protected StringgenerateCellDescription(Object itemId, Object propertyId) protected StringgenerateCellStyle(Object itemId, Object propertyId) protected StringgenerateClickableCellStyles(Object itemId, Table.Column column, MetaPropertyPath propertyPath) protected StringgenerateDefaultCellStyle(Object itemId, Object propertyId, MetaPropertyPath propertyPath) protected AggregatableDelegate<Object>protected List<AggregationInfo>getAggregationInfos(AggregationContainer container) Returns a map with aggregation results, where keys are table column ids and values are aggregation values.protected Collection<MetaPropertyPath>getAutowiredProperties(EntityTableItems<E> entityTableSource) Returns a column by id.protected StringgetColumnCaption(Object columnId) protected StringgetColumnCaption(Object columnId, Table.Column column) booleanbooleanReturns whether column reordering is allowed.Returns a copy of currently configured columns in their current visual order in this Table.protected List<Table.Column<E>>protected ClassgetColumnType(Table.Column<E> column) com.vaadin.ui.Componentprotected Actionprotected StringgetFormattedValue(Table.Column<E> column, Object value) protected StringgetGeneratedCellStyle(Object itemId, Object propertyId) getInitialVisibleColumnIds(EntityTableItems<E> entityTableSource) getInstanceContainer(E item) This method returns the InstanceContainer which contains the provided item.BiFunction<? super E,String, String> Gets the item description provider.protected com.vaadin.server.ResourcegetItemIcon(Object itemId) getItems()protected ObjectgetParsedAggregationValue(String value, Object columnId) getPrintable(Table.Column column) GetsTable.Printablerepresentation for column.getPrintable(String columnId) GetsTable.Printablerepresentation for column.getPropertyColumns(EntityTableItems<E> entityTableSource, List<Table.Column<E>> columnsOrder) intReturns a set of entity instances corresponding to the selected rows of the list component.protected ComponentSettingsBinderprotected ComponentSettingsReturns an instance of entity corresponding to the selected row of the list component.Styles implementation is client-type-specific.intGets the tabulator index of theHasTabIndexcomponent.protected ObjectgetValueExIgnoreUnfetched(Object instance, String[] properties) protected voidprotected voidprotected voidhandleColumnCollapsed(com.vaadin.v7.ui.Table.ColumnCollapseEvent event) protected voidhandlePresentationVariables(Map<String, Object> variables) protected booleanhandleSpecificVariables(Map<String, Object> variables) protected voidinitComponent(T component) protected voidprotected voidbooleanbooleanbooleanbooleanbooleanbooleanbooleanprotected booleanbooleanbooleanbooleanbooleanprotected booleanisValueGeneratedColumn(Object propertyId) voidprotected booleanneedUpdatePresentation(Map<String, Object> variables) protected voidonAfterUnregisterComponent(com.vaadin.ui.Component component) protected voidprotected voidonColumnCollapseStateChange(com.vaadin.v7.ui.Table.ColumnCollapseEvent e) protected voidonColumnReorder(com.vaadin.v7.ui.Table.ColumnReorderEvent e) protected voidprotected voidremoveAggregationCell(Table.Column column) protected voidvoidremoveColumn(Table.Column column) Removes the given column from Table or do nothing if column isnull.voidremoveGeneratedColumn(String columnId) Removes generated column from the Table by column id.protected voidvoidremovePrintable(String columnId) RemovesTable.Printablerepresentation of column.voidremoveStyleProvider(Table.StyleProvider<? super E> styleProvider) Removes style provider for the table.voidrepaint()Repaints UI representation of the table (columns, generated columns) without refreshing the table data.voidrequestFocus(E item, String columnId) Sets focus on inner field of editable/generated column.voidvoidScrolls table to specified row.voidMarks all the items in the current data source as selected.voidsetAccessManager(AccessManager accessManager) voidsetActions(Actions actions) voidsetAggregatable(boolean aggregatable) Sets whether aggregation is enabled.voidsetAggregationDistributionProvider(Table.AggregationDistributionProvider<E> distributionProvider) Sets aggregation distribution provider to handle distribution of data on rows.voidsetAggregations(Aggregations aggregations) voidsetAggregationStyle(Table.AggregationStyle aggregationStyle) Sets the location of the aggregation row.voidsetButtonsPanel(ButtonsPanel panel) Sets aButtonsPanelcomponent.voidsetCaption(String caption) Sets the component's caption.voidsetCaptionAsHtml(boolean captionAsHtml) Sets whether the caption is rendered as HTML.protected voidprotected voidsetColumnAggregationDescriptionByType(Table.Column<E> column, Object columnId) voidsetColumnControlVisible(boolean columnControlVisible) Sets whether user can hide columns using the columnControlButton dropdown on the right side of the table header.protected voidsetColumnHeader(Object columnId, String caption) voidsetColumnHeaderVisible(boolean visible) Sets whether table header is displayed.voidsetColumnReorderingAllowed(boolean columnReorderingAllowed) Sets whether or not column reordering is allowed.voidsetContextMenuEnabled(boolean contextMenuEnabled) Sets whether context menu is enabled.voidsetCurrentAuthentication(CurrentAuthentication currentAuthentication) voidsetDataComponents(DataComponents dataComponents) voidsetDatatypeRegistry(DatatypeRegistry datatypeRegistry) voidsetDebugId(String id) INTERNAL.voidsetDefaultSettings(SettingsWrapper wrapper) Sets default settings for a component.voidsetEditable(boolean editable) protected voidsetEditableColumns(List<MetaPropertyPath> editableColumns) voidSets click handler for link message.voidsetEmptyStateLinkMessage(String linkMessage) Sets a link message to the middle of Table body that should be appeared when Table is empty.voidsetEmptyStateMessage(String message) Sets a message to the middle of Table body that should be appeared when Table is empty.voidsetEnterPressAction(Action action) Assign action to be executed on Enter key press.voidsetEntityStates(EntityStates entityStates) voidsetIconProvider(Function<? super E, String> iconProvider) Sets the row icon provider for the Table.voidsetIconResolver(IconResolver iconResolver) voidSet component IDvoidsetItemClickAction(Action action) Assign action to be executed on double click inside a table row.voidsetItemDescriptionProvider(BiFunction<? super E, String, String> provider) Sets the item description provider that is used for generating tooltip descriptions for items.voidsetItems(TableItems<E> tableItems) Sets an instance ofTableItemsas the Table data source.voidsetLookupSelectHandler(Consumer<Collection<E>> selectHandler) voidsetMessages(Messages messages) voidsetMessageTools(MessageTools messageTools) voidsetMetadata(Metadata metadata) voidsetMetadataTools(MetadataTools metadataTools) voidsetMinHeight(String minHeight) SetsminHeightCSS property value to the Table (not a composition).voidsetMinWidth(String minWidth) SetsminWidthCSS property value to the Table (not a composition).voidsetMultiLineCells(boolean multiLineCells) Sets whether multi-line display is enabled for cells containing several lines of text.voidsetMultiSelect(boolean multiselect) Sets whether multiple selection mode is enabled.voidsetPagination(PaginationComponent pagination) Sets pagination component.voidsetRequired(Table.Column column, boolean required, String message) Sets whether the component inside a column must contain a non-null value.voidsetRowHeaderMode(Table.RowHeaderMode rowHeaderMode) Sets the row header mode.voidsetRowHeaderWidth(int width) Sets the width of row header column.voidsetSelected(E item) Selects a row of the list component for a given entity instance.voidsetSelected(Collection<E> items) Selects the rows of the list component for a given collection of entity instances.protected voidsetSelectedIds(Collection<Object> itemIds) voidsetSettingsRegistry(ComponentSettingsRegistry settingsRegistry) voidsetShowSelection(boolean showSelection) Sets whether a current row is highlighted.voidsetShowTotalAggregation(boolean showAggregation) Shows in which aggregation the changes occurred: in the total or group.voidsetSortable(boolean sortable) Defines if sortable attribute can be changed for individual column or not.voidsetStyleName(String name) Sets one or more style names of the component, replacing any previous styles.voidsetStyleProvider(Table.StyleProvider<? super E> styleProvider) Sets the cell style provider for the table.
All style providers added before this call will be removed.voidsetTabIndex(int tabIndex) Sets the tabulator index of theFocusablecomponent.protected voidsetTablePresentationsLayout(TablePresentationsLayout tablePresentations) voidsetTextSelectionEnabled(boolean textSelectionEnabled) Sets whether text selection in Table cells is enabled.voidsetUiComponentProperties(UiComponentProperties componentProperties) voidsetUiComponentsGenerator(UiComponentsGenerator uiComponentsGenerator) protected voidsetUiTestId(TableItems<E> items) voidsetUiTestIdsSupport(UiTestIdsSupport uiTestIdsSupport) protected voidsetupAutowiredColumns(EntityTableItems<E> entityTableSource) protected voidsetupColumnSettings(EntityTableItems<E> entityTableSource) voidvoidsetUserSettingsTools(UserSettingsTools userSettingsTools) voidsetViewRepository(FetchPlanRepository viewRepository) protected voidsetVisibleColumns(List<?> columnsOrder) voidshowCustomPopup(Component popupComponent) Shows popup inside of Table, relative to last cell click event.
Call this method fromTable.Column.ClickEventimplementation.voidshowCustomPopupActions(List<Action> actions) Shows autocloseable popup view with actions, relative to last cell click event.
Call this method fromTable.Column.ClickEventimplementation.
Autocloseable means that after any click on action popup will be closed.protected voidprotected voidshowParseErrorNotification(String message) voidsort(String columnId, Table.SortDirection direction) Sorts the Table data for passed column id in the chosen sort direction.protected voidtableSelectionChanged(com.vaadin.v7.data.Property.ValueChangeEvent event) voidvoidvoidvoidprotected voidprotected voidMethods inherited from class io.jmix.ui.component.impl.AbstractActionsHolderComponent
actionPropertyChanged, addAction, addAction, createContextMenuPopup, createShortcutsDelegate, getAction, getActions, getActionsPermissions, initContextMenuButton, initContextMenuPopup, removeAction, removeAction, removeAllActions, setContextMenuButtonAction, setContextMenuButtonCaption, setContextMenuButtonIcon, setThemeConstantsManagerMethods inherited from class io.jmix.ui.component.impl.AbstractComponent
addAttachListener, addDetachListener, addStyleName, assignDebugId, getAlignment, getComponent, getContextHelpIconClickHandler, getContextHelpText, getDebugId, getDescription, getEventHub, getFrame, getHeight, getHeightSizeUnit, getHtmlSanitizer, getIcon, getIconName, getIconResource, getId, getParent, getUiComponentProperties, getUiProperties, getWidth, getWidthSizeUnit, getXmlDescriptor, hasSubscriptions, hasValidationError, isAttached, isContextHelpTextHtmlEnabled, isDescriptionAsHtml, isEnabled, isEnabledRecursive, isHtmlSanitizerEnabled, isResponsive, isVisible, isVisibleRecursive, onContextHelpIconClick, publish, removeStyleName, sanitize, setAlignment, setApplicationContext, setContextHelpIconClickHandler, setContextHelpText, setContextHelpTextHtmlEnabled, setDescription, setDescriptionAsHtml, setEnabled, setFrame, setHeight, setHtmlSanitizerEnabled, setIcon, setIconFromSet, setParent, setResponsive, setValidationError, setVisible, setWidth, setXmlDescriptor, unsubscribe, unwrap, unwrapComposition, unwrapCompositionOrNull, unwrapOrNull, withUnwrapped, withUnwrappedCompositionMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface io.jmix.ui.component.ActionsHolder
addAction, addAction, getAction, getActionNN, getActions, removeAction, removeAction, removeAllActionsMethods inherited from interface io.jmix.ui.component.Component
addStyleName, getAlignment, getHeight, getHeightSizeUnit, getId, getParent, getWidth, getWidthSizeUnit, isEnabled, isEnabledRecursive, isResponsive, isVisible, isVisibleRecursive, removeStyleName, setAlignment, setEnabled, setHeight, setHeightAuto, setHeightFull, setParent, setResponsive, setSizeAuto, setSizeFull, setVisible, setWidth, setWidthAuto, setWidthFull, unwrap, unwrapComposition, unwrapCompositionOrNull, unwrapOrNull, withUnwrapped, withUnwrappedCompositionMethods inherited from interface io.jmix.ui.component.Component.BelongToFrame
getFrame, setFrameMethods inherited from interface io.jmix.ui.component.Component.Editable
isEditableWithParentMethods inherited from interface io.jmix.ui.component.Component.Focusable
isFocusable, setFocusableMethods inherited from interface io.jmix.ui.component.Component.HasDescription
getDescription, setDescriptionMethods inherited from interface io.jmix.ui.component.Component.HasIcon
getIcon, setIcon, setIconFromSetMethods inherited from interface io.jmix.ui.component.HasContextHelp
getContextHelpIconClickHandler, getContextHelpText, isContextHelpTextHtmlEnabled, setContextHelpIconClickHandler, setContextHelpText, setContextHelpTextHtmlEnabledMethods inherited from interface io.jmix.ui.component.HasHtmlDescription
isDescriptionAsHtml, setDescriptionAsHtmlMethods inherited from interface io.jmix.ui.component.HasHtmlSanitizer
isHtmlSanitizerEnabled, setHtmlSanitizerEnabledMethods inherited from interface io.jmix.ui.component.Table
getSubPart
-
Field Details
-
MAX_TEXT_LENGTH_GAP
public static final int MAX_TEXT_LENGTH_GAP- See Also:
-
BOOLEAN_CELL_STYLE_TRUE
- See Also:
-
BOOLEAN_CELL_STYLE_FALSE
- See Also:
-
VOID_COLUMN_GENERATOR
protected static final com.vaadin.v7.ui.Table.ColumnGenerator VOID_COLUMN_GENERATOR -
HAS_TOP_PANEL_STYLENAME
- See Also:
-
CUSTOM_STYLE_NAME_PREFIX
- See Also:
-
EDIT_ACTION_ID
- See Also:
-
VIEW_ACTION_ID
- See Also:
-
ROW_HEADER_PROPERTY_ID
-
componentProperties
-
iconResolver
-
metadataTools
-
metadata
-
accessManager
-
messages
-
messageTools
-
datatypeRegistry
-
dataComponents
-
viewRepository
-
userSettingsTools
-
settingsRegistry
-
entityStates
-
actions
-
uiComponentsGenerator
-
aggregations
-
aggregatableDelegate
-
uiTestIdsSupport
-
locale
-
internalStyles
-
columns
-
columnsOrder
-
sortable
protected boolean sortable -
editable
protected boolean editable -
itemClickAction
-
enterPressAction
-
itemDescriptionProvider
-
iconProvider
-
styleProviders
-
requiredColumns
-
fieldDatasources
-
componentComposition
-
topPanel
protected com.vaadin.ui.CssLayout topPanel -
buttonsPanel
-
pagination
-
aggregationCells
-
presentations
-
defaultTableSettings
-
columnCollapseListener
protected com.vaadin.v7.ui.Table.ColumnCollapseListener columnCollapseListener -
distributionProvider
-
printables
-
dataBinding
-
ignoreUnfetchedAttributes
protected boolean ignoreUnfetchedAttributes -
VALUE_PROVIDER_GENERATOR
protected com.vaadin.v7.ui.Table.ColumnGenerator VALUE_PROVIDER_GENERATOR -
emptyStateClickLinkHandler
-
-
Constructor Details
-
AbstractTable
protected AbstractTable()
-
-
Method Details
-
afterPropertiesSet
public void afterPropertiesSet()- Specified by:
afterPropertiesSetin interfaceorg.springframework.beans.factory.InitializingBean
-
setUiComponentProperties
-
setIconResolver
-
setAccessManager
-
setMetadataTools
-
setMetadata
-
setMessageTools
-
setMessages
-
setCurrentAuthentication
-
setDatatypeRegistry
-
setDataComponents
-
setViewRepository
-
setUserSettingsTools
-
setSettingsRegistry
@Autowired(required=false) public void setSettingsRegistry(ComponentSettingsRegistry settingsRegistry) -
setEntityStates
-
setActions
-
setUiComponentsGenerator
-
setAggregations
-
setUiTestIdsSupport
-
getInnerComponents
- Specified by:
getInnerComponentsin interfaceHasInnerComponents
-
getSelectedItemIds
-
getSingleSelected
Description copied from interface:ListComponentReturns an instance of entity corresponding to the selected row of the list component. If nothing is selected, the method returnsnull. If multiple selection mode is enabled, returns the first selected instance.- Specified by:
getSingleSelectedin interfaceListComponent<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>- Returns:
- an instance of entity corresponding to the selected row of the list component
-
getSelected
Description copied from interface:ListComponentReturns a set of entity instances corresponding to the selected rows of the list component. If nothing is selected, the method returns aCollections.emptySet().- Specified by:
getSelectedin interfaceListComponent<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>- Returns:
- a set of entity instances corresponding to the selected rows of the list component
-
setSelected
Description copied from interface:ListComponentSelects a row of the list component for a given entity instance.- Specified by:
setSelectedin interfaceListComponent<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>- Parameters:
item- entity instance to select the row,nullto reset the selection
-
setSelected
Description copied from interface:ListComponentSelects the rows of the list component for a given collection of entity instances.- Specified by:
setSelectedin interfaceListComponent<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>- Parameters:
items- collection of entity instances to select rows
-
setSelectedIds
-
attachAction
- Overrides:
attachActionin classAbstractActionsHolderComponent<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>
-
focus
public void focus()Description copied from interface:Component.FocusableSets focus to this component- Specified by:
focusin interfaceComponent.Focusable
-
isMultiSelect
public boolean isMultiSelect()- Specified by:
isMultiSelectin interfaceListComponent<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>- Returns:
- true if multiple selection mode is enabled
-
setMultiSelect
public void setMultiSelect(boolean multiselect) Description copied from interface:TableSets whether multiple selection mode is enabled.- Specified by:
setMultiSelectin interfaceTable<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>- Parameters:
multiselect- whether multiple selection mode is enabled
-
getColumns
Description copied from interface:TableReturns a copy of currently configured columns in their current visual order in this Table.- Specified by:
getColumnsin interfaceTable<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>- Returns:
- unmodifiable copy of current columns
- See Also:
-
getColumnsInternal
-
getRequiredColumnsInternal
-
getColumn
Description copied from interface:TableReturns a column by id.- Specified by:
getColumnin interfaceTable<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>- Parameters:
id- the column id- Returns:
- the column or
nullif not found
-
addColumn
Description copied from interface:TableAdds the given column to Table.Note that column id should be an instance of
MetaPropertyPath.- Specified by:
addColumnin interfaceTable<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>- Parameters:
column- the column to add- See Also:
-
addColumn
Description copied from interface:TableAdds the given column at the specified index to Table.Note that column id should be an instance of
MetaPropertyPath.- Specified by:
addColumnin interfaceTable<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>- Parameters:
column- the column to addindex- index of a new column- See Also:
-
addColumn
Description copied from interface:TableCreates new column with given Id, then adds this column to Table.- Specified by:
addColumnin interfaceTable<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>- Parameters:
id- the column id or the instance ofMetaPropertyPathrepresenting a relative path to a property from certainMetaClass- Returns:
- the newly created column
- See Also:
-
addColumn
Description copied from interface:TableCreates new column with given Id at the specified index, then adds this column to Table.- Specified by:
addColumnin interfaceTable<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>- Parameters:
id- the column id or the instance ofMetaPropertyPathrepresenting a relative path to a property from certainMetaClassindex- index of a new column- Returns:
- the newly created column
- See Also:
-
createColumn
-
getColumnType
-
addColumnInternal
-
setColumnAggregationDescriptionByType
-
removeColumn
Description copied from interface:TableRemoves the given column from Table or do nothing if column isnull.- Specified by:
removeColumnin interfaceTable<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>- Parameters:
column- the column to remove
-
getInstanceContainer
Description copied from interface:TableThis method returns the InstanceContainer 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.carsTable.addGeneratedColumn("name", car -> { TextField<String> textField = uiComponents.create(TextField.NAME); textField.setValueSource(new ContainerValueSource<>(carsTable.getInstanceContainer(car),"name")); textField.setValue(car.getName()); return textField; });- Specified by:
getInstanceContainerin interfaceTable<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>- Parameters:
item- entity item- Returns:
- InstanceContainer containing the item
-
addGeneratedColumnInternal
protected void addGeneratedColumnInternal(Object id, com.vaadin.v7.ui.Table.ColumnGenerator generator) -
removeGeneratedColumnInternal
-
addPrintable
Description copied from interface:TableAddsTable.Printablerepresentation for column.
Explicitly added Printable will be used instead of inherited from generated column.- Specified by:
addPrintablein interfaceTable<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>- Parameters:
columnId- column idprintable- printable representation
-
removePrintable
Description copied from interface:TableRemovesTable.Printablerepresentation of column.
Unable to remove Printable representation inherited from generated column.- Specified by:
removePrintablein interfaceTable<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>- Parameters:
columnId- column id
-
getPrintable
Description copied from interface:TableGetsTable.Printablerepresentation for column.- Specified by:
getPrintablein interfaceTable<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>- Parameters:
column- table column- Returns:
- printable
-
getPrintable
Description copied from interface:TableGetsTable.Printablerepresentation for column.- Specified by:
getPrintablein interfaceTable<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>- Parameters:
columnId- column id- Returns:
- printable
-
isEditable
public boolean isEditable()- Specified by:
isEditablein interfaceComponent.Editable
-
setEditable
public void setEditable(boolean editable) - Specified by:
setEditablein interfaceComponent.Editable
-
enableEditableColumns
protected void enableEditableColumns(EntityTableItems<E> entityTableSource, Collection<MetaPropertyPath> propertyIds) -
disableEditableColumns
protected void disableEditableColumns(EntityTableItems<E> entityTableSource, Collection<MetaPropertyPath> propertyIds) -
createLinkCellClickListener
-
setEditableColumns
-
isSortable
public boolean isSortable()- Specified by:
isSortablein interfaceTable<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>- Returns:
trueif individual column sortable attribute can be set totrue,falseotherwise
-
setSortable
public void setSortable(boolean sortable) Description copied from interface:TableDefines if sortable attribute can be changed for individual column or not. Default value istrue.- Specified by:
setSortablein interfaceTable<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>- Parameters:
sortable-trueif individual column sortable attribute can be set totrue,falseotherwise
-
getColumnReorderingAllowed
public boolean getColumnReorderingAllowed()Description copied from interface:TableReturns whether column reordering is allowed. Default value istrue.- Specified by:
getColumnReorderingAllowedin interfaceTable<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>- Returns:
trueif reordering is allowed
-
addColumnReorderListener
Description copied from interface:TableRegisters a new column reorder listener.- Specified by:
addColumnReorderListenerin interfaceTable<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>- Parameters:
listener- the listener to add- Returns:
- a registration object for removing an event listener
-
setColumnReorderingAllowed
public void setColumnReorderingAllowed(boolean columnReorderingAllowed) Description copied from interface:TableSets whether or not column reordering is allowed. Default value istrue.- Specified by:
setColumnReorderingAllowedin interfaceTable<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>- Parameters:
columnReorderingAllowed- specifies whether column reordering is allowed
-
getColumnControlVisible
public boolean getColumnControlVisible()- Specified by:
getColumnControlVisiblein interfaceTable<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>- Returns:
- whether user can hide columns using the columnControlButton dropdown on the right side of the table header
-
setColumnControlVisible
public void setColumnControlVisible(boolean columnControlVisible) Description copied from interface:TableSets whether user can hide columns using the columnControlButton dropdown on the right side of the table header.- Specified by:
setColumnControlVisiblein interfaceTable<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>- Parameters:
columnControlVisible- whether user can hide columns using the columnControlButton dropdown on the right side of the table header
-
sort
Description copied from interface:TableSorts the Table data for passed column id in the chosen sort direction.- Specified by:
sortin interfaceTable<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>- Parameters:
columnId- id of the column to sortdirection- sort direction
-
getSortInfo
- Specified by:
getSortInfoin interfaceTable<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>- Returns:
- current sort information or null if no column is sorted
-
getPagination
- Specified by:
getPaginationin interfaceHasPagination- Returns:
- pagination component
-
setPagination
Description copied from interface:HasPaginationSets pagination component.- Specified by:
setPaginationin interfaceHasPagination
-
setupPaginationDataSourceProvider
public void setupPaginationDataSourceProvider() -
updateCompositionStylesTopPanelVisible
protected void updateCompositionStylesTopPanelVisible() -
isMultiLineCells
public boolean isMultiLineCells()- Specified by:
isMultiLineCellsin interfaceTable<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>- Returns:
- whether multi-line display is enabled for cells containing several lines of text
-
setMultiLineCells
public void setMultiLineCells(boolean multiLineCells) Description copied from interface:TableSets whether multi-line display is enabled for cells containing several lines of text. The default value is false.- Specified by:
setMultiLineCellsin interfaceTable<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>- Parameters:
multiLineCells- whether multi-line display is enabled for cells containing several lines of text
-
isAggregatable
public boolean isAggregatable()- Specified by:
isAggregatablein interfaceTable<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>- Returns:
- true if the Table is aggregatable
-
setAggregatable
public void setAggregatable(boolean aggregatable) Description copied from interface:TableSets whether aggregation is enabled. Default value is false.- Specified by:
setAggregatablein interfaceTable<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>- Parameters:
aggregatable- whether aggregation is enabled.
-
getAggregationResults
Description copied from interface:TableReturns a map with aggregation results, where keys are table column ids and values are aggregation values.- Specified by:
getAggregationResultsin interfaceTable<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>- Returns:
- map with aggregation results
-
getAggregationStyle
- Specified by:
getAggregationStylein interfaceTable<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>- Returns:
- the location of the aggregation row
-
setAggregationStyle
Description copied from interface:TableSets the location of the aggregation row.- Specified by:
setAggregationStylein interfaceTable<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>- Parameters:
aggregationStyle- the location of the aggregation row
-
isShowTotalAggregation
public boolean isShowTotalAggregation()- Specified by:
isShowTotalAggregationin interfaceTable<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>- Returns:
trueif the aggregation column should show changes in total aggregation,falseif in the group aggregation
-
setShowTotalAggregation
public void setShowTotalAggregation(boolean showAggregation) Description copied from interface:TableShows in which aggregation the changes occurred: in the total or group.- Specified by:
setShowTotalAggregationin interfaceTable<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>- Parameters:
showAggregation-trueif the aggregation column should show changes in total aggregation,falseif in the group aggregation
-
getComposition
public com.vaadin.ui.Component getComposition()- Specified by:
getCompositionin interfaceComponent.Wrapper- Overrides:
getCompositionin classAbstractComponent<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>
-
isContextMenuEnabled
public boolean isContextMenuEnabled()- Specified by:
isContextMenuEnabledin interfaceTable<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>- Returns:
- whether context menu is enabled
-
setContextMenuEnabled
public void setContextMenuEnabled(boolean contextMenuEnabled) Description copied from interface:TableSets whether context menu is enabled.- Specified by:
setContextMenuEnabledin interfaceTable<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>- Parameters:
contextMenuEnabled- whether context menu is enabled
-
getTabIndex
public int getTabIndex()Description copied from interface:Component.FocusableGets the tabulator index of theHasTabIndexcomponent.- Specified by:
getTabIndexin interfaceComponent.Focusable- Returns:
- tab index set for the
HasTabIndexcomponent
-
setTabIndex
public void setTabIndex(int tabIndex) Description copied from interface:Component.FocusableSets the tabulator index of theFocusablecomponent. The tab index property is used to specify the order in which the fields are focused when the user presses the Tab key. Components with a defined tab index are focused sequentially first, and then the components with no tab index.- Specified by:
setTabIndexin interfaceComponent.Focusable- Parameters:
tabIndex- tab index
-
setTablePresentationsLayout
-
initComponent
-
onColumnReorder
protected void onColumnReorder(com.vaadin.v7.ui.Table.ColumnReorderEvent e) -
getColumnsOrderInternal
-
onAfterUnregisterComponent
protected void onAfterUnregisterComponent(com.vaadin.ui.Component component) -
onBeforeRefreshRowCache
protected void onBeforeRefreshRowCache() -
tableSelectionChanged
protected void tableSelectionChanged(com.vaadin.v7.data.Property.ValueChangeEvent event) -
fireSelectionEvent
protected void fireSelectionEvent(com.vaadin.v7.data.Property.ValueChangeEvent e) -
formatCellValue
-
formatFileRef
-
createFieldFactory
-
setClientCaching
protected void setClientCaching() -
refreshActionsState
protected void refreshActionsState() -
createStyleGenerator
-
getGeneratedCellStyle
-
generateCellDescription
-
createContextMenuButton
- Specified by:
createContextMenuButtonin classAbstractActionsHolderComponent<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>
-
beforeContextMenuButtonHandlerPerformed
protected void beforeContextMenuButtonHandlerPerformed()- Overrides:
beforeContextMenuButtonHandlerPerformedin classAbstractActionsHolderComponent<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>
-
handleClickAction
protected void handleClickAction() -
setLookupSelectHandler
- Specified by:
setLookupSelectHandlerin interfaceLookupComponent<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>- Parameters:
selectHandler- handler that should be executed when a user select an item in the lookup screen
-
removeAllClickListeners
protected void removeAllClickListeners() -
getLookupSelectedItems
- Specified by:
getLookupSelectedItemsin interfaceLookupComponent<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>- Returns:
- items selected in lookup component
-
getEnterAction
-
createColumns
protected void createColumns(com.vaadin.v7.data.Container ds) -
getItems
- Specified by:
getItemsin interfaceListComponent<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>- Specified by:
getItemsin interfaceTable<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>- Returns:
- the Table data source
-
setItems
Description copied from interface:TableSets an instance ofTableItemsas the Table data source.- Specified by:
setItemsin interfaceTable<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>- Parameters:
tableItems- the Table data source
-
setUiTestId
-
getPropertyColumns
protected List<Object> getPropertyColumns(EntityTableItems<E> entityTableSource, List<Table.Column<E>> columnsOrder) -
setupColumnSettings
-
setupAutowiredColumns
-
getAutowiredProperties
protected Collection<MetaPropertyPath> getAutowiredProperties(EntityTableItems<E> entityTableSource) -
tableSourceItemSetChanged
- Specified by:
tableSourceItemSetChangedin interfaceTableItemsEventsDelegate<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>
-
clearFieldDatasources
protected void clearFieldDatasources() -
tableSourcePropertyValueChanged
- Specified by:
tableSourcePropertyValueChangedin interfaceTableItemsEventsDelegate<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>
-
handleAggregation
protected void handleAggregation() -
tableSourceSelectedItemChanged
- Specified by:
tableSourceSelectedItemChangedin interfaceTableItemsEventsDelegate<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>
-
tableSourceStateChanged
- Specified by:
tableSourceStateChangedin interfaceTableItemsEventsDelegate<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>
-
createTableDataContainer
-
canBeSorted
-
setDebugId
Description copied from interface:HasDebugIdINTERNAL. Managed by debug Id system.- Specified by:
setDebugIdin interfaceHasDebugId- Overrides:
setDebugIdin classAbstractComponent<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>
-
setId
Description copied from interface:ComponentSet component ID- Specified by:
setIdin interfaceComponent- Overrides:
setIdin classAbstractComponent<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>
-
getColumnCaption
-
getColumnCaption
-
createStubsForGeneratedColumns
protected void createStubsForGeneratedColumns() -
getInitialVisibleColumnIds
-
setVisibleColumns
-
setColumnHeader
-
setRowHeaderMode
Description copied from interface:TableSets the row header mode.- Specified by:
setRowHeaderModein interfaceTable<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>- Parameters:
rowHeaderMode- row header mode
-
setRequired
Description copied from interface:TableSets whether the component inside a column must contain a non-null value.- Specified by:
setRequiredin interfaceTable<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>- Parameters:
column- a columnrequired- requiredmessage- required message
-
getStyleName
Description copied from interface:ComponentStyles implementation is client-type-specific.- Specified by:
getStyleNamein interfaceComponent- Overrides:
getStyleNamein classAbstractComponent<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>- Returns:
- current style name.
-
setStyleName
Description copied from interface:ComponentSets one or more style names of the component, replacing any previous styles. Multiple styles can be specified as a space-separated list of style names. Styles implementation is client-type-specific.- Specified by:
setStyleNamein interfaceComponent- Overrides:
setStyleNamein classAbstractComponent<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>- Parameters:
name- one or more style names separated by space.
-
setStyleProvider
Description copied from interface:TableSets the cell style provider for the table.
All style providers added before this call will be removed.- Specified by:
setStyleProviderin interfaceTable<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>- Parameters:
styleProvider- a style provider to set
-
addStyleProvider
Description copied from interface:TableAdd style provider for the table.
Table can use several providers to obtain many style names for cells and rows.- Specified by:
addStyleProviderin interfaceTable<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>- Parameters:
styleProvider- a style provider to add
-
removeStyleProvider
Description copied from interface:TableRemoves style provider for the table.- Specified by:
removeStyleProviderin interfaceTable<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>- Parameters:
styleProvider- a style provider to remove
-
setIconProvider
Description copied from interface:TableSets the row icon provider for the Table.- Specified by:
setIconProviderin interfaceTable<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>- Parameters:
iconProvider- an icon provider to set- See Also:
-
getItemIcon
-
setItemDescriptionProvider
Description copied from interface:TableSets the item description provider that is used for generating tooltip descriptions for items.All unhandled exceptions from ItemDescriptionProvider in Web components by default are logged with ERROR level and not shown to users.
- Specified by:
setItemDescriptionProviderin interfaceTable<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>- Parameters:
provider- the item description provider to use ornullto remove a previously set provider if any
-
getItemDescriptionProvider
Description copied from interface:TableGets the item description provider.- Specified by:
getItemDescriptionProviderin interfaceTable<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>- Returns:
- the item description provider
-
getRowHeaderWidth
public int getRowHeaderWidth()- Specified by:
getRowHeaderWidthin interfaceTable<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>- Returns:
- width of row header column in px
-
setRowHeaderWidth
public void setRowHeaderWidth(int width) Description copied from interface:TableSets the width of row header column. Row header shows icons if Icon Provider is specified.- Specified by:
setRowHeaderWidthin interfaceTable<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>- Parameters:
width- width of row header column in px
-
getEnterPressAction
- Specified by:
getEnterPressActionin interfaceTable<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>- Returns:
- an action to be executed on Enter key press, assigned by
Table.setEnterPressAction(Action)
-
setEnterPressAction
Description copied from interface:TableAssign action to be executed on Enter key press.If such action is not set, the table responds to pressing Enter by trying to find and execute the following actions:
- action, assigned by
Table.setItemClickAction(Action) - action, assigned to Enter key press by setting its
shortcutproperty - action named "edit"
- action named "view"
- Specified by:
setEnterPressActionin interfaceTable<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>
- action, assigned by
-
getItemClickAction
- Specified by:
getItemClickActionin interfaceTable<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>- Returns:
- an action that is performed when the user double-clicks inside a table row
- See Also:
-
setItemClickAction
Description copied from interface:TableAssign action to be executed on double click inside a table row.If such action is not set, the table responds to double click by trying to find and execute the following actions:
- action, assigned to Enter key press by setting its
shortcutproperty - action named "edit"
- action named "view"
- Specified by:
setItemClickActionin interfaceTable<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>
- action, assigned to Enter key press by setting its
-
getCaption
- Specified by:
getCaptionin interfaceComponent.HasCaption- Overrides:
getCaptionin classAbstractComponent<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>- Returns:
- the caption of the component
-
setCaption
Description copied from interface:Component.HasCaptionSets the component's caption.- Specified by:
setCaptionin interfaceComponent.HasCaption- Overrides:
setCaptionin classAbstractComponent<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>- Parameters:
caption- the new component's caption
-
isCaptionAsHtml
public boolean isCaptionAsHtml()- Specified by:
isCaptionAsHtmlin interfaceHasHtmlCaption- Overrides:
isCaptionAsHtmlin classAbstractComponent<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>- Returns:
trueif the caption is rendered as HTML,falseif rendered as plain text
-
setCaptionAsHtml
public void setCaptionAsHtml(boolean captionAsHtml) Description copied from interface:HasHtmlCaptionSets whether the caption is rendered as HTML.- Specified by:
setCaptionAsHtmlin interfaceHasHtmlCaption- Overrides:
setCaptionAsHtmlin classAbstractComponent<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>- Parameters:
captionAsHtml-trueif the caption is rendered as HTML,falseif rendered as plain text- See Also:
-
getButtonsPanel
- Specified by:
getButtonsPanelin interfaceHasButtonsPanel- Returns:
- a buttons panel component.
-
setButtonsPanel
Description copied from interface:HasButtonsPanelSets aButtonsPanelcomponent.- Specified by:
setButtonsPanelin interfaceHasButtonsPanel- Parameters:
panel- a buttons panel component
-
createTopPanel
protected com.vaadin.ui.CssLayout createTopPanel() -
addGeneratedColumn
Description copied from interface:TableAdds a generated column to the table.- Specified by:
addGeneratedColumnin interfaceTable<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>- Parameters:
columnId- column identifier as defined in XML descriptor. May or may not correspond to an entity property.generator- column generator instance
-
addGeneratedColumn
public void addGeneratedColumn(String columnId, int index, Table.ColumnGenerator<? super E> generator) Description copied from interface:TableAdds a generated column at the specified index to Table.- Specified by:
addGeneratedColumnin interfaceTable<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>- Parameters:
columnId- column identifier as defined in XML descriptor. May correspond to an entity propertyindex- index of a new columngenerator- column generator instance
-
addGeneratedColumn
public void addGeneratedColumn(String columnId, Table.ColumnGenerator<? super E> generator, Class<? extends Component> componentClass) Description copied from interface:TableAdds a generated column to the table.
This method useful for desktop UI. Table can make additional look, feel and performance tweaks if it knows the class of components that will be generated.- Specified by:
addGeneratedColumnin interfaceTable<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>- Parameters:
columnId- column identifier as defined in XML descriptor. May or may not correspond to an entity property.generator- column generator instancecomponentClass- class of components that generator will provide
-
removeGeneratedColumn
Description copied from interface:TableRemoves generated column from the Table by column id.- Specified by:
removeGeneratedColumnin interfaceTable<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>- Parameters:
columnId- the column id
-
isTextSelectionEnabled
public boolean isTextSelectionEnabled()- Specified by:
isTextSelectionEnabledin interfaceTable<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>- Returns:
- whether text selection in Table cells is enabled
-
setTextSelectionEnabled
public void setTextSelectionEnabled(boolean textSelectionEnabled) Description copied from interface:TableSets whether text selection in Table cells is enabled.- Specified by:
setTextSelectionEnabledin interfaceTable<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>- Parameters:
textSelectionEnabled- whether text selection in Table cells is enabled
-
repaint
public void repaint()Description copied from interface:TableRepaints UI representation of the table (columns, generated columns) without refreshing the table data.- Specified by:
repaintin interfaceTable<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>
-
selectAll
public void selectAll()Description copied from interface:TableMarks all the items in the current data source as selected.- Specified by:
selectAllin interfaceTable<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>
-
checkAggregation
-
getAggregatableDelegate
-
__aggregateValues
protected Map<Object,Object> __aggregateValues(AggregationContainer container, AggregationContainer.Context context) -
__aggregate
protected Map<Object,Object> __aggregate(AggregationContainer container, AggregationContainer.Context context) -
getAggregationInfos
-
convertAggregationKeyMapToColumnIdKeyMap
protected Map<Object,Object> convertAggregationKeyMapToColumnIdKeyMap(AggregationContainer container, Map<AggregationInfo, ?> aggregationInfoMap) -
__handleAggregationResults
-
getFormattedValue
-
removeAggregationCell
-
addAggregationCell
-
handleSpecificVariables
-
handlePresentationVariables
-
updatePresentationSettings
-
getSettingsBinder
-
isSettingsAvailable
protected boolean isSettingsAvailable() -
needUpdatePresentation
-
getNotCollapsedColumns
- Specified by:
getNotCollapsedColumnsin interfaceTable<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>- Returns:
- a list of visible columns
-
resetPresentation
public void resetPresentation()- Specified by:
resetPresentationin interfaceHasTablePresentations
-
loadPresentations
public void loadPresentations()- Specified by:
loadPresentationsin interfaceHasTablePresentations
-
getPresentations
- Specified by:
getPresentationsin interfaceHasTablePresentations
-
applyPresentation
- Specified by:
applyPresentationin interfaceHasTablePresentations
-
applyPresentationAsDefault
- Specified by:
applyPresentationAsDefaultin interfaceHasTablePresentations
-
applyPresentation
-
applyPresentationSettings
-
getSettingsFromPresentation
-
createTablePresentationsLayout
-
createTablePresentations
-
getDefaultPresentationId
- Specified by:
getDefaultPresentationIdin interfaceHasTablePresentations
-
setDefaultSettings
Description copied from interface:HasTablePresentationsSets default settings for a component. When the presentation is reset it will be applied for the component.- Specified by:
setDefaultSettingsin interfaceHasTablePresentations- Parameters:
wrapper- settings wrapper
-
getDefaultSettings
- Specified by:
getDefaultSettingsin interfaceHasTablePresentations- Returns:
- default settings for a component or null if not set
-
addColumnCollapseListener
Description copied from interface:TableAdds a listener for column collapse events.- Specified by:
addColumnCollapseListenerin interfaceTable<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>- Parameters:
listener- a listener to add- Returns:
- a
Subscriptionobject
-
internalRemoveColumnCollapseListener
protected void internalRemoveColumnCollapseListener(Consumer<Table.ColumnCollapseEvent<E>> listener) -
onColumnCollapseStateChange
protected void onColumnCollapseStateChange(com.vaadin.v7.ui.Table.ColumnCollapseEvent e) -
addSelectionListener
Description copied from interface:TableRegisters a new selection listener- Specified by:
addSelectionListenerin interfaceTable<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>- Parameters:
listener- the listener to register
-
showCustomPopup
Description copied from interface:TableShows popup inside of Table, relative to last cell click event.
Call this method fromTable.Column.ClickEventimplementation.- Specified by:
showCustomPopupin interfaceTable<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>- Parameters:
popupComponent- popup content
-
showCustomPopupActions
Description copied from interface:TableShows autocloseable popup view with actions, relative to last cell click event.
Call this method fromTable.Column.ClickEventimplementation.
Autocloseable means that after any click on action popup will be closed.- Specified by:
showCustomPopupActionsin interfaceTable<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>- Parameters:
actions- actions
-
isColumnHeaderVisible
public boolean isColumnHeaderVisible()- Specified by:
isColumnHeaderVisiblein interfaceTable<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>- Returns:
- whether table header is displayed
-
setColumnHeaderVisible
public void setColumnHeaderVisible(boolean visible) Description copied from interface:TableSets whether table header is displayed.- Specified by:
setColumnHeaderVisiblein interfaceTable<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>- Parameters:
visible- whether table header is displayed
-
isShowSelection
public boolean isShowSelection()- Specified by:
isShowSelectionin interfaceTable<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>- Returns:
- whether a current row is highlighted
-
setShowSelection
public void setShowSelection(boolean showSelection) Description copied from interface:TableSets whether a current row is highlighted.- Specified by:
setShowSelectionin interfaceTable<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>- Parameters:
showSelection- whether a current row is highlighted
-
generateCellStyle
-
isValueGeneratedColumn
-
generateDefaultCellStyle
@Nullable protected String generateDefaultCellStyle(Object itemId, Object propertyId, @Nullable MetaPropertyPath propertyPath) -
generateClickableCellStyles
@Nullable protected String generateClickableCellStyles(Object itemId, Table.Column column, MetaPropertyPath propertyPath) -
setAggregationDistributionProvider
public void setAggregationDistributionProvider(@Nullable Table.AggregationDistributionProvider<E> distributionProvider) Description copied from interface:TableSets aggregation distribution provider to handle distribution of data on rows. Supports only TOP aggregation style.- Specified by:
setAggregationDistributionProviderin interfaceTable<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>- Parameters:
distributionProvider- distribution provider
-
distributeAggregation
protected boolean distributeAggregation(JmixEnhancedTable.AggregationInputValueChangeContext context) -
getAggregationDistributionProvider
- Specified by:
getAggregationDistributionProviderin interfaceTable<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>- Returns:
- aggregation distribution provider
-
requestFocus
Description copied from interface:TableSets focus on inner field of editable/generated column.- Specified by:
requestFocusin interfaceTable<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>- Parameters:
item- entitycolumnId- column id
-
scrollTo
Description copied from interface:TableScrolls table to specified row.- Specified by:
scrollToin interfaceTable<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>- Parameters:
item- entity
-
handleColumnCollapsed
protected void handleColumnCollapsed(com.vaadin.v7.ui.Table.ColumnCollapseEvent event) -
beforeComponentPaint
protected void beforeComponentPaint() -
getValueExIgnoreUnfetched
-
addLookupValueChangeListener
public Subscription addLookupValueChangeListener(Consumer<LookupComponent.LookupSelectionChangeEvent<E>> listener) Description copied from interface:LookupComponent.LookupSelectionChangeNotifierAdds a listener that invoked when lookup selected items set is changed.- Specified by:
addLookupValueChangeListenerin interfaceLookupComponent.LookupSelectionChangeNotifier<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>- Parameters:
listener- a listener to add- Returns:
Subscription
-
createInstallHandler
@Nullable public Object createInstallHandler(Class<?> targetObjectType, FrameOwner frameOwner, Method method) - Specified by:
createInstallHandlerin interfaceInstallTargetHandler
-
setEmptyStateMessage
Description copied from interface:TableSets a message to the middle of Table body that should be appeared when Table is empty.- Specified by:
setEmptyStateMessagein interfaceTable<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>- Parameters:
message- message that appears when Table is empty
-
getEmptyStateMessage
- Specified by:
getEmptyStateMessagein interfaceTable<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>- Returns:
- message that should be appeared when Table is empty
-
setEmptyStateLinkMessage
Description copied from interface:TableSets a link message to the middle of Table body that should be appeared when Table is empty.- Specified by:
setEmptyStateLinkMessagein interfaceTable<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>- Parameters:
linkMessage- message that appears when Table is empty- See Also:
-
getEmptyStateLinkMessage
- Specified by:
getEmptyStateLinkMessagein interfaceTable<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>- Returns:
- link message that should be appeared when Table is empty
-
setEmptyStateLinkClickHandler
public void setEmptyStateLinkClickHandler(@Nullable Consumer<Table.EmptyStateClickEvent<E>> handler) Description copied from interface:TableSets click handler for link message. Link message can be shown when Table is empty.- Specified by:
setEmptyStateLinkClickHandlerin interfaceTable<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>- Parameters:
handler- handler to set- See Also:
-
getEmptyStateLinkClickHandler
- Specified by:
getEmptyStateLinkClickHandlerin interfaceTable<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>- Returns:
- click handler for link message
-
getMinHeight
- Specified by:
getMinHeightin interfaceHasMinSize- Specified by:
getMinHeightin interfaceTable<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>- Returns:
min-heightCSS property value of the Table (not a composition) ornullif not set
-
getMinHeightSizeUnit
- Specified by:
getMinHeightSizeUnitin interfaceHasMinSize- Specified by:
getMinHeightSizeUnitin interfaceTable<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>- Returns:
- unit size of
min-heightCSS property value of the Table (not a composition)
-
setMinHeight
Description copied from interface:TableSetsminHeightCSS property value to the Table (not a composition). To set CSS properties to the composition usecssattribute in the XML descriptor orHtmlAttributes.applyCss(Component, String).- Specified by:
setMinHeightin interfaceHasMinSize- Specified by:
setMinHeightin interfaceTable<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>- Parameters:
minHeight- property value
-
getMinWidth
- Specified by:
getMinWidthin interfaceHasMinSize- Specified by:
getMinWidthin interfaceTable<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>- Returns:
min-widthCSS property value of the Table (not a composition) ornullif not set
-
getMinWidthSizeUnit
- Specified by:
getMinWidthSizeUnitin interfaceHasMinSize- Specified by:
getMinWidthSizeUnitin interfaceTable<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>- Returns:
- unit size of
min-widthCSS property value of the Table (not a composition)
-
setMinWidth
Description copied from interface:TableSetsminWidthCSS property value to the Table (not a composition). To set CSS properties to the composition usecssattribute in the XML descriptor orHtmlAttributes.applyCss(Component, String).- Specified by:
setMinWidthin interfaceHasMinSize- Specified by:
setMinWidthin interfaceTable<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>- Parameters:
minWidth- property value
-
attached
public void attached()Description copied from interface:AttachNotifierNotifies all listeners that component has been attached.- Specified by:
attachedin interfaceAttachNotifier- Overrides:
attachedin classAbstractComponent<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>
-
detached
public void detached()Description copied from interface:AttachNotifierNotifies all listeners that component has been detached.- Specified by:
detachedin interfaceAttachNotifier- Overrides:
detachedin classAbstractComponent<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>
-
getParsedAggregationValue
@Nullable protected Object getParsedAggregationValue(String value, Object columnId) throws ParseException - Throws:
ParseException
-
showParseErrorNotification
-
initEmptyState
protected void initEmptyState() -
showEmptyStateIfPossible
protected void showEmptyStateIfPossible()
-