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
Modifier and TypeClassDescriptionprotected class
protected class
static class
protected static class
protected class
protected class
Nested 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.Wrapper
Nested classes/interfaces inherited from interface io.jmix.ui.component.HasContextHelp
HasContextHelp.ContextHelpIconClickEvent
Nested 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
Modifier and TypeFieldDescriptionprotected AccessManager
protected Actions
protected AggregatableDelegate<Object>
protected Map<Table.Column,
String> protected Aggregations
static final String
static final String
protected ButtonsPanel
protected com.vaadin.v7.ui.Table.ColumnCollapseListener
protected Map<Object,
Table.Column<E>> protected List<Table.Column<E>>
protected TableComposition
protected UiComponentProperties
protected static final String
protected TableDataContainer<E>
protected DataComponents
protected DatatypeRegistry
protected TableSettings
protected Table.AggregationDistributionProvider<E>
protected static final String
protected boolean
protected Consumer<Table.EmptyStateClickEvent<E>>
protected Action
protected EntityStates
protected static final String
protected IconResolver
protected boolean
protected Action
protected BiFunction<? super E,
String, String> protected Locale
static final int
protected Messages
protected MessageTools
protected Metadata
protected MetadataTools
protected PaginationComponent
protected TablePresentations
protected Map<String,
Table.Printable> protected Map<Table.Column,
String> protected static final Object
protected ComponentSettingsRegistry
protected boolean
protected List<Table.StyleProvider>
protected com.vaadin.ui.CssLayout
protected UiComponentsGenerator
protected UiTestIdsSupport
protected UserSettingsTools
protected com.vaadin.v7.ui.Table.ColumnGenerator
protected static final String
protected FetchPlanRepository
protected static final com.vaadin.v7.ui.Table.ColumnGenerator
Fields inherited from class io.jmix.ui.component.impl.AbstractActionsHolderComponent
actionButtons, actionList, actionPropertyChangeListener, actionsPermissions, contextMenuPopup, shortcutsDelegate, showIconsForPopupMenuActions
Fields inherited from class io.jmix.ui.component.impl.AbstractComponent
alignment, applicationContext, component, contextHelpIconClickHandler, contextHelpIconClickListener, descriptionAsHtml, element, frame, htmlSanitizerEnabled, icon, ICON_STYLE, id, parent
Fields inherited from interface io.jmix.ui.component.Component
AUTO_SIZE, AUTO_SIZE_PX, FULL_SIZE
-
Constructor Summary
-
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 void
addAggregationCell
(Table.Column column) void
addColumn
(Table.Column<E> column) Adds the given column to Table.void
addColumn
(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 void
addColumnInternal
(Table.Column<E> column, int index) addColumnReorderListener
(Consumer<Table.ColumnReorderEvent<E>> listener) Registers a new column reorder listener.void
addGeneratedColumn
(String columnId, int index, Table.ColumnGenerator<? super E> generator) Adds a generated column at the specified index to Table.void
addGeneratedColumn
(String columnId, Table.ColumnGenerator<? super E> generator) Adds a generated column to the table.void
addGeneratedColumn
(String columnId, Table.ColumnGenerator<? super E> generator, Class<? extends Component> componentClass) Adds a generated column to the table.protected void
addGeneratedColumnInternal
(Object id, com.vaadin.v7.ui.Table.ColumnGenerator generator) Adds a listener that invoked when lookup selected items set is changed.void
addPrintable
(String columnId, Table.Printable<? super E, ?> printable) AddsTable.Printable
representation for column.addSelectionListener
(Consumer<Table.SelectionEvent<E>> listener) Registers a new selection listenervoid
addStyleProvider
(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.void
protected void
void
void
protected void
protected void
attachAction
(Action action) void
attached()
Notifies all listeners that component has been attached.protected void
protected void
protected boolean
canBeSorted
(TableItems<E> tableItems) protected void
checkAggregation
(AggregationInfo aggregationInfo) protected void
convertAggregationKeyMapToColumnIdKeyMap
(AggregationContainer container, Map<AggregationInfo, ?> aggregationInfoMap) protected AbstractTable.ColumnImpl<E>
createColumn
(Object id, AbstractTable<?, E> owner) protected void
createColumns
(com.vaadin.v7.data.Container ds) protected JmixButton
protected TableFieldFactoryImpl
createInstallHandler
(Class<?> targetObjectType, FrameOwner frameOwner, Method method) protected Consumer<Table.Column.ClickEvent>
protected void
protected AbstractTable<T,
E>.StyleGeneratorAdapter protected TableDataContainer<E>
createTableDataContainer
(TableItems<E> tableItems) protected TablePresentations
protected TablePresentationsLayout
protected com.vaadin.ui.CssLayout
void
detached()
Notifies all listeners that component has been detached.protected void
disableEditableColumns
(EntityTableItems<E> entityTableSource, Collection<MetaPropertyPath> propertyIds) protected boolean
protected void
enableEditableColumns
(EntityTableItems<E> entityTableSource, Collection<MetaPropertyPath> propertyIds) protected void
fireSelectionEvent
(com.vaadin.v7.data.Property.ValueChangeEvent e) void
focus()
Sets focus to this componentprotected String
formatCellValue
(Object rowId, Object colId, com.vaadin.v7.data.Property<?> property) protected String
generateCellDescription
(Object itemId, Object propertyId) protected String
generateCellStyle
(Object itemId, Object propertyId) protected String
generateClickableCellStyles
(Object itemId, Table.Column column, MetaPropertyPath propertyPath) protected String
generateDefaultCellStyle
(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 String
getColumnCaption
(Object columnId) protected String
getColumnCaption
(Object columnId, Table.Column column) boolean
boolean
Returns 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 Class
getColumnType
(Table.Column<E> column) com.vaadin.ui.Component
protected Action
protected String
getFormattedValue
(Table.Column<E> column, Object value) protected String
getGeneratedCellStyle
(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.Resource
getItemIcon
(Object itemId) getItems()
protected Object
getParsedAggregationValue
(String value, Object columnId) getPrintable
(Table.Column column) GetsTable.Printable
representation for column.getPrintable
(String columnId) GetsTable.Printable
representation for column.getPropertyColumns
(EntityTableItems<E> entityTableSource, List<Table.Column<E>> columnsOrder) int
Returns a set of entity instances corresponding to the selected rows of the list component.protected ComponentSettingsBinder
protected ComponentSettings
Returns an instance of entity corresponding to the selected row of the list component.Styles implementation is client-type-specific.int
Gets the tabulator index of theHasTabIndex
component.protected Object
getValueExIgnoreUnfetched
(Object instance, String[] properties) protected void
protected void
protected void
handleColumnCollapsed
(com.vaadin.v7.ui.Table.ColumnCollapseEvent event) protected void
handlePresentationVariables
(Map<String, Object> variables) protected boolean
handleSpecificVariables
(Map<String, Object> variables) protected void
initComponent
(T component) protected void
protected void
boolean
boolean
boolean
boolean
boolean
boolean
boolean
protected boolean
boolean
boolean
boolean
boolean
protected boolean
isValueGeneratedColumn
(Object propertyId) void
protected boolean
needUpdatePresentation
(Map<String, Object> variables) protected void
onAfterUnregisterComponent
(com.vaadin.ui.Component component) protected void
protected void
onColumnCollapseStateChange
(com.vaadin.v7.ui.Table.ColumnCollapseEvent e) protected void
onColumnReorder
(com.vaadin.v7.ui.Table.ColumnReorderEvent e) protected void
protected void
removeAggregationCell
(Table.Column column) protected void
void
removeColumn
(Table.Column column) Removes the given column from Table or do nothing if column isnull
.void
removeGeneratedColumn
(String columnId) Removes generated column from the Table by column id.protected void
void
removePrintable
(String columnId) RemovesTable.Printable
representation of column.void
removeStyleProvider
(Table.StyleProvider<? super E> styleProvider) Removes style provider for the table.void
repaint()
Repaints UI representation of the table (columns, generated columns) without refreshing the table data.void
requestFocus
(E item, String columnId) Sets focus on inner field of editable/generated column.void
void
Scrolls table to specified row.void
Marks all the items in the current data source as selected.void
setAccessManager
(AccessManager accessManager) void
setActions
(Actions actions) void
setAggregatable
(boolean aggregatable) Sets whether aggregation is enabled.void
setAggregationDistributionProvider
(Table.AggregationDistributionProvider<E> distributionProvider) Sets aggregation distribution provider to handle distribution of data on rows.void
setAggregations
(Aggregations aggregations) void
setAggregationStyle
(Table.AggregationStyle aggregationStyle) Sets the location of the aggregation row.void
setButtonsPanel
(ButtonsPanel panel) Sets aButtonsPanel
component.void
setCaption
(String caption) Sets the component's caption.void
setCaptionAsHtml
(boolean captionAsHtml) Sets whether the caption is rendered as HTML.protected void
protected void
setColumnAggregationDescriptionByType
(Table.Column<E> column, Object columnId) void
setColumnControlVisible
(boolean columnControlVisible) Sets whether user can hide columns using the columnControlButton dropdown on the right side of the table header.protected void
setColumnHeader
(Object columnId, String caption) void
setColumnHeaderVisible
(boolean visible) Sets whether table header is displayed.void
setColumnReorderingAllowed
(boolean columnReorderingAllowed) Sets whether or not column reordering is allowed.void
setContextMenuEnabled
(boolean contextMenuEnabled) Sets whether context menu is enabled.void
setCurrentAuthentication
(CurrentAuthentication currentAuthentication) void
setDataComponents
(DataComponents dataComponents) void
setDatatypeRegistry
(DatatypeRegistry datatypeRegistry) void
setDebugId
(String id) INTERNAL.void
setDefaultSettings
(SettingsWrapper wrapper) Sets default settings for a component.void
setEditable
(boolean editable) protected void
setEditableColumns
(List<MetaPropertyPath> editableColumns) void
Sets click handler for link message.void
setEmptyStateLinkMessage
(String linkMessage) Sets a link message to the middle of Table body that should be appeared when Table is empty.void
setEmptyStateMessage
(String message) Sets a message to the middle of Table body that should be appeared when Table is empty.void
setEnterPressAction
(Action action) Assign action to be executed on Enter key press.void
setEntityStates
(EntityStates entityStates) void
setIconProvider
(Function<? super E, String> iconProvider) Sets the row icon provider for the Table.void
setIconResolver
(IconResolver iconResolver) void
Set component IDvoid
setItemClickAction
(Action action) Assign action to be executed on double click inside a table row.void
setItemDescriptionProvider
(BiFunction<? super E, String, String> provider) Sets the item description provider that is used for generating tooltip descriptions for items.void
setItems
(TableItems<E> tableItems) Sets an instance ofTableItems
as the Table data source.void
setLookupSelectHandler
(Consumer<Collection<E>> selectHandler) void
setMessages
(Messages messages) void
setMessageTools
(MessageTools messageTools) void
setMetadata
(Metadata metadata) void
setMetadataTools
(MetadataTools metadataTools) void
setMinHeight
(String minHeight) SetsminHeight
CSS property value to the Table (not a composition).void
setMinWidth
(String minWidth) SetsminWidth
CSS property value to the Table (not a composition).void
setMultiLineCells
(boolean multiLineCells) Sets whether multi-line display is enabled for cells containing several lines of text.void
setMultiSelect
(boolean multiselect) Sets whether multiple selection mode is enabled.void
setPagination
(PaginationComponent pagination) Sets pagination component.void
setRequired
(Table.Column column, boolean required, String message) Sets whether the component inside a column must contain a non-null value.void
setRowHeaderMode
(Table.RowHeaderMode rowHeaderMode) Sets the row header mode.void
setRowHeaderWidth
(int width) Sets the width of row header column.void
setSelected
(E item) Selects a row of the list component for a given entity instance.void
setSelected
(Collection<E> items) Selects the rows of the list component for a given collection of entity instances.protected void
setSelectedIds
(Collection<Object> itemIds) void
setSettingsRegistry
(ComponentSettingsRegistry settingsRegistry) void
setShowSelection
(boolean showSelection) Sets whether a current row is highlighted.void
setShowTotalAggregation
(boolean showAggregation) Shows in which aggregation the changes occurred: in the total or group.void
setSortable
(boolean sortable) Defines if sortable attribute can be changed for individual column or not.void
setStyleName
(String name) Sets one or more style names of the component, replacing any previous styles.void
setStyleProvider
(Table.StyleProvider<? super E> styleProvider) Sets the cell style provider for the table.
All style providers added before this call will be removed.void
setTabIndex
(int tabIndex) Sets the tabulator index of theFocusable
component.protected void
setTablePresentationsLayout
(TablePresentationsLayout tablePresentations) void
setTextSelectionEnabled
(boolean textSelectionEnabled) Sets whether text selection in Table cells is enabled.void
setUiComponentProperties
(UiComponentProperties componentProperties) void
setUiComponentsGenerator
(UiComponentsGenerator uiComponentsGenerator) protected void
setUiTestId
(TableItems<E> items) void
setUiTestIdsSupport
(UiTestIdsSupport uiTestIdsSupport) protected void
setupAutowiredColumns
(EntityTableItems<E> entityTableSource) protected void
setupColumnSettings
(EntityTableItems<E> entityTableSource) void
void
setUserSettingsTools
(UserSettingsTools userSettingsTools) void
setViewRepository
(FetchPlanRepository viewRepository) protected void
setVisibleColumns
(List<?> columnsOrder) void
showCustomPopup
(Component popupComponent) Shows popup inside of Table, relative to last cell click event.
Call this method fromTable.Column.ClickEvent
implementation.void
showCustomPopupActions
(List<Action> actions) Shows autocloseable popup view with actions, relative to last cell click event.
Call this method fromTable.Column.ClickEvent
implementation.
Autocloseable means that after any click on action popup will be closed.protected void
protected void
showParseErrorNotification
(String message) void
sort
(String columnId, Table.SortDirection direction) Sorts the Table data for passed column id in the chosen sort direction.protected void
tableSelectionChanged
(com.vaadin.v7.data.Property.ValueChangeEvent event) void
void
void
void
protected void
protected void
Methods 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, setThemeConstantsManager
Methods 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, withUnwrappedComposition
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
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, 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, withUnwrappedComposition
Methods inherited from interface io.jmix.ui.component.Component.BelongToFrame
getFrame, setFrame
Methods inherited from interface io.jmix.ui.component.Component.Editable
isEditableWithParent
Methods inherited from interface io.jmix.ui.component.Component.Focusable
isFocusable, setFocusable
Methods inherited from interface io.jmix.ui.component.Component.HasDescription
getDescription, setDescription
Methods inherited from interface io.jmix.ui.component.Component.HasIcon
getIcon, setIcon, setIconFromSet
Methods inherited from interface io.jmix.ui.component.HasContextHelp
getContextHelpIconClickHandler, getContextHelpText, isContextHelpTextHtmlEnabled, setContextHelpIconClickHandler, setContextHelpText, setContextHelpTextHtmlEnabled
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.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:
afterPropertiesSet
in 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:
getInnerComponents
in interfaceHasInnerComponents
-
getSelectedItemIds
-
getSingleSelected
Description copied from interface:ListComponent
Returns 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:
getSingleSelected
in 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:ListComponent
Returns 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:
getSelected
in 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:ListComponent
Selects a row of the list component for a given entity instance.- Specified by:
setSelected
in interfaceListComponent<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>
- Parameters:
item
- entity instance to select the row,null
to reset the selection
-
setSelected
Description copied from interface:ListComponent
Selects the rows of the list component for a given collection of entity instances.- Specified by:
setSelected
in interfaceListComponent<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>
- Parameters:
items
- collection of entity instances to select rows
-
setSelectedIds
-
attachAction
- Overrides:
attachAction
in classAbstractActionsHolderComponent<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>
-
focus
public void focus()Description copied from interface:Component.Focusable
Sets focus to this component- Specified by:
focus
in interfaceComponent.Focusable
-
isMultiSelect
public boolean isMultiSelect()- Specified by:
isMultiSelect
in 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:Table
Sets whether multiple selection mode is enabled.- Specified by:
setMultiSelect
in interfaceTable<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>
- Parameters:
multiselect
- whether multiple selection mode is enabled
-
getColumns
Description copied from interface:Table
Returns a copy of currently configured columns in their current visual order in this Table.- Specified by:
getColumns
in interfaceTable<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>
- Returns:
- unmodifiable copy of current columns
- See Also:
-
getColumnsInternal
-
getRequiredColumnsInternal
-
getColumn
Description copied from interface:Table
Returns a column by id.- Specified by:
getColumn
in interfaceTable<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>
- Parameters:
id
- the column id- Returns:
- the column or
null
if not found
-
addColumn
Description copied from interface:Table
Adds the given column to Table.Note that column id should be an instance of
MetaPropertyPath
.- Specified by:
addColumn
in interfaceTable<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>
- Parameters:
column
- the column to add- See Also:
-
addColumn
Description copied from interface:Table
Adds the given column at the specified index to Table.Note that column id should be an instance of
MetaPropertyPath
.- Specified by:
addColumn
in 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:Table
Creates new column with given Id, then adds this column to Table.- Specified by:
addColumn
in interfaceTable<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>
- Parameters:
id
- the column id or the instance ofMetaPropertyPath
representing a relative path to a property from certainMetaClass
- Returns:
- the newly created column
- See Also:
-
addColumn
Description copied from interface:Table
Creates new column with given Id at the specified index, then adds this column to Table.- Specified by:
addColumn
in interfaceTable<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>
- Parameters:
id
- the column id or the instance ofMetaPropertyPath
representing a relative path to a property from certainMetaClass
index
- index of a new column- Returns:
- the newly created column
- See Also:
-
createColumn
-
getColumnType
-
addColumnInternal
-
setColumnAggregationDescriptionByType
-
removeColumn
Description copied from interface:Table
Removes the given column from Table or do nothing if column isnull
.- Specified by:
removeColumn
in interfaceTable<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>
- Parameters:
column
- the column to remove
-
getInstanceContainer
Description copied from interface:Table
This 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:
getInstanceContainer
in 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:Table
AddsTable.Printable
representation for column.
Explicitly added Printable will be used instead of inherited from generated column.- Specified by:
addPrintable
in interfaceTable<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>
- Parameters:
columnId
- column idprintable
- printable representation
-
removePrintable
Description copied from interface:Table
RemovesTable.Printable
representation of column.
Unable to remove Printable representation inherited from generated column.- Specified by:
removePrintable
in interfaceTable<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>
- Parameters:
columnId
- column id
-
getPrintable
Description copied from interface:Table
GetsTable.Printable
representation for column.- Specified by:
getPrintable
in interfaceTable<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>
- Parameters:
column
- table column- Returns:
- printable
-
getPrintable
Description copied from interface:Table
GetsTable.Printable
representation for column.- Specified by:
getPrintable
in interfaceTable<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>
- Parameters:
columnId
- column id- Returns:
- printable
-
isEditable
public boolean isEditable()- Specified by:
isEditable
in interfaceComponent.Editable
-
setEditable
public void setEditable(boolean editable) - Specified by:
setEditable
in 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:
isSortable
in interfaceTable<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>
- Returns:
true
if individual column sortable attribute can be set totrue
,false
otherwise
-
setSortable
public void setSortable(boolean sortable) Description copied from interface:Table
Defines if sortable attribute can be changed for individual column or not. Default value istrue
.- Specified by:
setSortable
in interfaceTable<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>
- Parameters:
sortable
-true
if individual column sortable attribute can be set totrue
,false
otherwise
-
getColumnReorderingAllowed
public boolean getColumnReorderingAllowed()Description copied from interface:Table
Returns whether column reordering is allowed. Default value istrue
.- Specified by:
getColumnReorderingAllowed
in interfaceTable<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>
- Returns:
true
if reordering is allowed
-
addColumnReorderListener
Description copied from interface:Table
Registers a new column reorder listener.- Specified by:
addColumnReorderListener
in 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:Table
Sets whether or not column reordering is allowed. Default value istrue
.- Specified by:
setColumnReorderingAllowed
in interfaceTable<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>
- Parameters:
columnReorderingAllowed
- specifies whether column reordering is allowed
-
getColumnControlVisible
public boolean getColumnControlVisible()- Specified by:
getColumnControlVisible
in 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:Table
Sets whether user can hide columns using the columnControlButton dropdown on the right side of the table header.- Specified by:
setColumnControlVisible
in 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:Table
Sorts the Table data for passed column id in the chosen sort direction.- Specified by:
sort
in interfaceTable<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>
- Parameters:
columnId
- id of the column to sortdirection
- sort direction
-
getSortInfo
- Specified by:
getSortInfo
in interfaceTable<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>
- Returns:
- current sort information or null if no column is sorted
-
getPagination
- Specified by:
getPagination
in interfaceHasPagination
- Returns:
- pagination component
-
setPagination
Description copied from interface:HasPagination
Sets pagination component.- Specified by:
setPagination
in interfaceHasPagination
-
setupPaginationDataSourceProvider
public void setupPaginationDataSourceProvider() -
updateCompositionStylesTopPanelVisible
protected void updateCompositionStylesTopPanelVisible() -
isMultiLineCells
public boolean isMultiLineCells()- Specified by:
isMultiLineCells
in 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:Table
Sets whether multi-line display is enabled for cells containing several lines of text. The default value is false.- Specified by:
setMultiLineCells
in 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:
isAggregatable
in 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:Table
Sets whether aggregation is enabled. Default value is false.- Specified by:
setAggregatable
in interfaceTable<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>
- Parameters:
aggregatable
- whether aggregation is enabled.
-
getAggregationResults
Description copied from interface:Table
Returns a map with aggregation results, where keys are table column ids and values are aggregation values.- Specified by:
getAggregationResults
in interfaceTable<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>
- Returns:
- map with aggregation results
-
getAggregationStyle
- Specified by:
getAggregationStyle
in interfaceTable<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>
- Returns:
- the location of the aggregation row
-
setAggregationStyle
Description copied from interface:Table
Sets the location of the aggregation row.- Specified by:
setAggregationStyle
in interfaceTable<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>
- Parameters:
aggregationStyle
- the location of the aggregation row
-
isShowTotalAggregation
public boolean isShowTotalAggregation()- Specified by:
isShowTotalAggregation
in interfaceTable<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>
- Returns:
true
if the aggregation column should show changes in total aggregation,false
if in the group aggregation
-
setShowTotalAggregation
public void setShowTotalAggregation(boolean showAggregation) Description copied from interface:Table
Shows in which aggregation the changes occurred: in the total or group.- Specified by:
setShowTotalAggregation
in interfaceTable<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>
- Parameters:
showAggregation
-true
if the aggregation column should show changes in total aggregation,false
if in the group aggregation
-
getComposition
public com.vaadin.ui.Component getComposition()- Specified by:
getComposition
in interfaceComponent.Wrapper
- Overrides:
getComposition
in classAbstractComponent<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>
-
isContextMenuEnabled
public boolean isContextMenuEnabled()- Specified by:
isContextMenuEnabled
in 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:Table
Sets whether context menu is enabled.- Specified by:
setContextMenuEnabled
in 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.Focusable
Gets the tabulator index of theHasTabIndex
component.- Specified by:
getTabIndex
in interfaceComponent.Focusable
- Returns:
- tab index set for the
HasTabIndex
component
-
setTabIndex
public void setTabIndex(int tabIndex) Description copied from interface:Component.Focusable
Sets the tabulator index of theFocusable
component. 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:
setTabIndex
in 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
-
createFieldFactory
-
setClientCaching
protected void setClientCaching() -
refreshActionsState
protected void refreshActionsState() -
createStyleGenerator
-
getGeneratedCellStyle
-
generateCellDescription
-
createContextMenuButton
- Specified by:
createContextMenuButton
in classAbstractActionsHolderComponent<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>
-
beforeContextMenuButtonHandlerPerformed
protected void beforeContextMenuButtonHandlerPerformed()- Overrides:
beforeContextMenuButtonHandlerPerformed
in classAbstractActionsHolderComponent<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>
-
handleClickAction
protected void handleClickAction() -
setLookupSelectHandler
- Specified by:
setLookupSelectHandler
in 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:
getLookupSelectedItems
in 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:
getItems
in interfaceListComponent<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>
- Specified by:
getItems
in interfaceTable<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>
- Returns:
- the Table data source
-
setItems
Description copied from interface:Table
Sets an instance ofTableItems
as the Table data source.- Specified by:
setItems
in 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:
tableSourceItemSetChanged
in interfaceTableItemsEventsDelegate<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>
-
clearFieldDatasources
protected void clearFieldDatasources() -
tableSourcePropertyValueChanged
- Specified by:
tableSourcePropertyValueChanged
in interfaceTableItemsEventsDelegate<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>
-
handleAggregation
protected void handleAggregation() -
tableSourceSelectedItemChanged
- Specified by:
tableSourceSelectedItemChanged
in interfaceTableItemsEventsDelegate<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>
-
tableSourceStateChanged
- Specified by:
tableSourceStateChanged
in interfaceTableItemsEventsDelegate<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>
-
createTableDataContainer
-
canBeSorted
-
setDebugId
Description copied from interface:HasDebugId
INTERNAL. Managed by debug Id system.- Specified by:
setDebugId
in interfaceHasDebugId
- Overrides:
setDebugId
in classAbstractComponent<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>
-
setId
Description copied from interface:Component
Set component ID- Specified by:
setId
in interfaceComponent
- Overrides:
setId
in classAbstractComponent<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>
-
getColumnCaption
-
getColumnCaption
-
createStubsForGeneratedColumns
protected void createStubsForGeneratedColumns() -
getInitialVisibleColumnIds
-
setVisibleColumns
-
setColumnHeader
-
setRowHeaderMode
Description copied from interface:Table
Sets the row header mode.- Specified by:
setRowHeaderMode
in interfaceTable<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>
- Parameters:
rowHeaderMode
- row header mode
-
setRequired
Description copied from interface:Table
Sets whether the component inside a column must contain a non-null value.- Specified by:
setRequired
in interfaceTable<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>
- Parameters:
column
- a columnrequired
- requiredmessage
- required message
-
getStyleName
Description copied from interface:Component
Styles implementation is client-type-specific.- Specified by:
getStyleName
in interfaceComponent
- Overrides:
getStyleName
in classAbstractComponent<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>
- Returns:
- current style name.
-
setStyleName
Description copied from interface:Component
Sets 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:
setStyleName
in interfaceComponent
- Overrides:
setStyleName
in classAbstractComponent<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>
- Parameters:
name
- one or more style names separated by space.
-
setStyleProvider
Description copied from interface:Table
Sets the cell style provider for the table.
All style providers added before this call will be removed.- Specified by:
setStyleProvider
in interfaceTable<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>
- Parameters:
styleProvider
- a style provider to set
-
addStyleProvider
Description copied from interface:Table
Add style provider for the table.
Table can use several providers to obtain many style names for cells and rows.- Specified by:
addStyleProvider
in interfaceTable<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>
- Parameters:
styleProvider
- a style provider to add
-
removeStyleProvider
Description copied from interface:Table
Removes style provider for the table.- Specified by:
removeStyleProvider
in interfaceTable<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>
- Parameters:
styleProvider
- a style provider to remove
-
setIconProvider
Description copied from interface:Table
Sets the row icon provider for the Table.- Specified by:
setIconProvider
in interfaceTable<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>
- Parameters:
iconProvider
- an icon provider to set- See Also:
-
getItemIcon
-
setItemDescriptionProvider
Description copied from interface:Table
Sets 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:
setItemDescriptionProvider
in interfaceTable<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>
- Parameters:
provider
- the item description provider to use ornull
to remove a previously set provider if any
-
getItemDescriptionProvider
Description copied from interface:Table
Gets the item description provider.- Specified by:
getItemDescriptionProvider
in interfaceTable<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>
- Returns:
- the item description provider
-
getRowHeaderWidth
public int getRowHeaderWidth()- Specified by:
getRowHeaderWidth
in 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:Table
Sets the width of row header column. Row header shows icons if Icon Provider is specified.- Specified by:
setRowHeaderWidth
in interfaceTable<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>
- Parameters:
width
- width of row header column in px
-
getEnterPressAction
- Specified by:
getEnterPressAction
in 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:Table
Assign 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
shortcut
property - action named "edit"
- action named "view"
- Specified by:
setEnterPressAction
in interfaceTable<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>
- action, assigned by
-
getItemClickAction
- Specified by:
getItemClickAction
in 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:Table
Assign 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
shortcut
property - action named "edit"
- action named "view"
- Specified by:
setItemClickAction
in interfaceTable<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>
- action, assigned to Enter key press by setting its
-
getCaption
- Specified by:
getCaption
in interfaceComponent.HasCaption
- Overrides:
getCaption
in classAbstractComponent<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>
- Returns:
- the caption of the component
-
setCaption
Description copied from interface:Component.HasCaption
Sets the component's caption.- Specified by:
setCaption
in interfaceComponent.HasCaption
- Overrides:
setCaption
in classAbstractComponent<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>
- Parameters:
caption
- the new component's caption
-
isCaptionAsHtml
public boolean isCaptionAsHtml()- Specified by:
isCaptionAsHtml
in interfaceHasHtmlCaption
- Overrides:
isCaptionAsHtml
in classAbstractComponent<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>
- Returns:
true
if the caption is rendered as HTML,false
if rendered as plain text
-
setCaptionAsHtml
public void setCaptionAsHtml(boolean captionAsHtml) Description copied from interface:HasHtmlCaption
Sets whether the caption is rendered as HTML.- Specified by:
setCaptionAsHtml
in interfaceHasHtmlCaption
- Overrides:
setCaptionAsHtml
in classAbstractComponent<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>
- Parameters:
captionAsHtml
-true
if the caption is rendered as HTML,false
if rendered as plain text- See Also:
-
getButtonsPanel
- Specified by:
getButtonsPanel
in interfaceHasButtonsPanel
- Returns:
- a buttons panel component.
-
setButtonsPanel
Description copied from interface:HasButtonsPanel
Sets aButtonsPanel
component.- Specified by:
setButtonsPanel
in interfaceHasButtonsPanel
- Parameters:
panel
- a buttons panel component
-
createTopPanel
protected com.vaadin.ui.CssLayout createTopPanel() -
addGeneratedColumn
Description copied from interface:Table
Adds a generated column to the table.- Specified by:
addGeneratedColumn
in 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:Table
Adds a generated column at the specified index to Table.- Specified by:
addGeneratedColumn
in 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:Table
Adds 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:
addGeneratedColumn
in 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:Table
Removes generated column from the Table by column id.- Specified by:
removeGeneratedColumn
in interfaceTable<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>
- Parameters:
columnId
- the column id
-
isTextSelectionEnabled
public boolean isTextSelectionEnabled()- Specified by:
isTextSelectionEnabled
in 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:Table
Sets whether text selection in Table cells is enabled.- Specified by:
setTextSelectionEnabled
in 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:Table
Repaints UI representation of the table (columns, generated columns) without refreshing the table data.- Specified by:
repaint
in interfaceTable<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>
-
selectAll
public void selectAll()Description copied from interface:Table
Marks all the items in the current data source as selected.- Specified by:
selectAll
in 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:
getNotCollapsedColumns
in interfaceTable<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>
- Returns:
- a list of visible columns
-
resetPresentation
public void resetPresentation()- Specified by:
resetPresentation
in interfaceHasTablePresentations
-
loadPresentations
public void loadPresentations()- Specified by:
loadPresentations
in interfaceHasTablePresentations
-
getPresentations
- Specified by:
getPresentations
in interfaceHasTablePresentations
-
applyPresentation
- Specified by:
applyPresentation
in interfaceHasTablePresentations
-
applyPresentationAsDefault
- Specified by:
applyPresentationAsDefault
in interfaceHasTablePresentations
-
applyPresentation
-
applyPresentationSettings
-
getSettingsFromPresentation
-
createTablePresentationsLayout
-
createTablePresentations
-
getDefaultPresentationId
- Specified by:
getDefaultPresentationId
in interfaceHasTablePresentations
-
setDefaultSettings
Description copied from interface:HasTablePresentations
Sets default settings for a component. When the presentation is reset it will be applied for the component.- Specified by:
setDefaultSettings
in interfaceHasTablePresentations
- Parameters:
wrapper
- settings wrapper
-
getDefaultSettings
- Specified by:
getDefaultSettings
in interfaceHasTablePresentations
- Returns:
- default settings for a component or null if not set
-
addColumnCollapseListener
Description copied from interface:Table
Adds a listener for column collapse events.- Specified by:
addColumnCollapseListener
in interfaceTable<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>
- Parameters:
listener
- a listener to add- Returns:
- a
Subscription
object
-
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:Table
Registers a new selection listener- Specified by:
addSelectionListener
in interfaceTable<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>
- Parameters:
listener
- the listener to register
-
showCustomPopup
Description copied from interface:Table
Shows popup inside of Table, relative to last cell click event.
Call this method fromTable.Column.ClickEvent
implementation.- Specified by:
showCustomPopup
in interfaceTable<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>
- Parameters:
popupComponent
- popup content
-
showCustomPopupActions
Description copied from interface:Table
Shows autocloseable popup view with actions, relative to last cell click event.
Call this method fromTable.Column.ClickEvent
implementation.
Autocloseable means that after any click on action popup will be closed.- Specified by:
showCustomPopupActions
in interfaceTable<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>
- Parameters:
actions
- actions
-
isColumnHeaderVisible
public boolean isColumnHeaderVisible()- Specified by:
isColumnHeaderVisible
in 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:Table
Sets whether table header is displayed.- Specified by:
setColumnHeaderVisible
in interfaceTable<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>
- Parameters:
visible
- whether table header is displayed
-
isShowSelection
public boolean isShowSelection()- Specified by:
isShowSelection
in 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:Table
Sets whether a current row is highlighted.- Specified by:
setShowSelection
in 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:Table
Sets aggregation distribution provider to handle distribution of data on rows. Supports only TOP aggregation style.- Specified by:
setAggregationDistributionProvider
in interfaceTable<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>
- Parameters:
distributionProvider
- distribution provider
-
distributeAggregation
protected boolean distributeAggregation(JmixEnhancedTable.AggregationInputValueChangeContext context) -
getAggregationDistributionProvider
- Specified by:
getAggregationDistributionProvider
in interfaceTable<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>
- Returns:
- aggregation distribution provider
-
requestFocus
Description copied from interface:Table
Sets focus on inner field of editable/generated column.- Specified by:
requestFocus
in interfaceTable<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>
- Parameters:
item
- entitycolumnId
- column id
-
scrollTo
Description copied from interface:Table
Scrolls table to specified row.- Specified by:
scrollTo
in 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.LookupSelectionChangeNotifier
Adds a listener that invoked when lookup selected items set is changed.- Specified by:
addLookupValueChangeListener
in 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:
createInstallHandler
in interfaceInstallTargetHandler
-
setEmptyStateMessage
Description copied from interface:Table
Sets a message to the middle of Table body that should be appeared when Table is empty.- Specified by:
setEmptyStateMessage
in interfaceTable<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>
- Parameters:
message
- message that appears when Table is empty
-
getEmptyStateMessage
- Specified by:
getEmptyStateMessage
in interfaceTable<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>
- Returns:
- message that should be appeared when Table is empty
-
setEmptyStateLinkMessage
Description copied from interface:Table
Sets a link message to the middle of Table body that should be appeared when Table is empty.- Specified by:
setEmptyStateLinkMessage
in interfaceTable<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>
- Parameters:
linkMessage
- message that appears when Table is empty- See Also:
-
getEmptyStateLinkMessage
- Specified by:
getEmptyStateLinkMessage
in 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:Table
Sets click handler for link message. Link message can be shown when Table is empty.- Specified by:
setEmptyStateLinkClickHandler
in interfaceTable<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>
- Parameters:
handler
- handler to set- See Also:
-
getEmptyStateLinkClickHandler
- Specified by:
getEmptyStateLinkClickHandler
in interfaceTable<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>
- Returns:
- click handler for link message
-
getMinHeight
- Specified by:
getMinHeight
in interfaceHasMinSize
- Specified by:
getMinHeight
in interfaceTable<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>
- Returns:
min-height
CSS property value of the Table (not a composition) ornull
if not set
-
getMinHeightSizeUnit
- Specified by:
getMinHeightSizeUnit
in interfaceHasMinSize
- Specified by:
getMinHeightSizeUnit
in interfaceTable<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>
- Returns:
- unit size of
min-height
CSS property value of the Table (not a composition)
-
setMinHeight
Description copied from interface:Table
SetsminHeight
CSS property value to the Table (not a composition). To set CSS properties to the composition usecss
attribute in the XML descriptor orHtmlAttributes.applyCss(Component, String)
.- Specified by:
setMinHeight
in interfaceHasMinSize
- Specified by:
setMinHeight
in interfaceTable<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>
- Parameters:
minHeight
- property value
-
getMinWidth
- Specified by:
getMinWidth
in interfaceHasMinSize
- Specified by:
getMinWidth
in interfaceTable<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>
- Returns:
min-width
CSS property value of the Table (not a composition) ornull
if not set
-
getMinWidthSizeUnit
- Specified by:
getMinWidthSizeUnit
in interfaceHasMinSize
- Specified by:
getMinWidthSizeUnit
in interfaceTable<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>
- Returns:
- unit size of
min-width
CSS property value of the Table (not a composition)
-
setMinWidth
Description copied from interface:Table
SetsminWidth
CSS property value to the Table (not a composition). To set CSS properties to the composition usecss
attribute in the XML descriptor orHtmlAttributes.applyCss(Component, String)
.- Specified by:
setMinWidth
in interfaceHasMinSize
- Specified by:
setMinWidth
in interfaceTable<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>
- Parameters:
minWidth
- property value
-
attached
public void attached()Description copied from interface:AttachNotifier
Notifies all listeners that component has been attached.- Specified by:
attached
in interfaceAttachNotifier
- Overrides:
attached
in classAbstractComponent<T extends com.vaadin.v7.ui.Table & JmixEnhancedTable>
-
detached
public void detached()Description copied from interface:AttachNotifier
Notifies all listeners that component has been detached.- Specified by:
detached
in interfaceAttachNotifier
- Overrides:
detached
in 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()
-