Package com.vaadin.ui

Class Table

    • Constructor Detail

      • Table

        public Table()
        Creates a new empty table.

      • Table

        public Table​(String caption)
        Creates a new empty table with caption.
        Parameters:
        caption -

      • Table

        public Table​(String caption,
             Container dataSource)
        Creates a new table with caption and connect it to a Container.
        Parameters:
        caption -
        dataSource -

    • Method Detail

      • getVisibleColumns

        public Object[] getVisibleColumns()
        Gets the array of visible column id:s, including generated columns.

        The columns are show in the order of their appearance in this array.

        Returns:
        an array of currently visible propertyIds and generated column ids.

      • setVisibleColumns

        public void setVisibleColumns​(Object... visibleColumns)
        Sets the array of visible column property id:s.

        The columns are show in the order of their appearance in this array.

        Parameters:
        visibleColumns - the Array of shown property id:s.

      • getColumnHeaders

        public String[] getColumnHeaders()
        Gets the headers of the columns.

        The headers match the property id:s given by the set visible column headers. The table must be set in either COLUMN_HEADER_MODE_EXPLICIT or COLUMN_HEADER_MODE_EXPLICIT_DEFAULTS_ID mode to show the headers. In the defaults mode any nulls in the headers array are replaced with id.toString().

        Returns:
        the Array of column headers.

      • setColumnHeaders

        public void setColumnHeaders​(String... columnHeaders)
        Sets the headers of the columns.

        The headers match the property id:s given by the set visible column headers. The table must be set in either COLUMN_HEADER_MODE_EXPLICIT or COLUMN_HEADER_MODE_EXPLICIT_DEFAULTS_ID mode to show the headers. In the defaults mode any nulls in the headers array are replaced with id.toString() outputs when rendering.

        Parameters:
        columnHeaders - the Array of column headers that match the getVisibleColumns() method.

      • setColumnWidth

        public void setColumnWidth​(Object propertyId,
                           int width)
        Sets columns width (in pixels). Theme may not necessarily respect very small or very big values. Setting width to -1 (default) means that theme will make decision of width.

        Column can either have a fixed width or expand ratio. The latter one set is used. See @link setColumnExpandRatio(Object, float).

        Parameters:
        propertyId - columns property id
        width - width to be reserved for columns content
        Since:
        4.0.3

      • setColumnExpandRatio

        public void setColumnExpandRatio​(Object propertyId,
                                 float expandRatio)
        Sets the column expand ratio for given column.

        Expand ratios can be defined to customize the way how excess space is divided among columns. Table can have excess space if it has its width defined and there is horizontally more space than columns consume naturally. Excess space is the space that is not used by columns with explicit width (see setColumnWidth(Object, int)) or with natural width (no width nor expand ratio).

        By default (without expand ratios) the excess space is divided proportionally to columns natural widths.

        Only expand ratios of visible columns are used in final calculations.

        Column can either have a fixed width or expand ratio. The latter one set is used.

        A column with expand ratio is considered to be minimum width by default (if no excess space exists). The minimum width is defined by terminal implementation.

        If terminal implementation supports re-sizable columns the column becomes fixed width column if users resizes the column.

        Parameters:
        propertyId - columns property id
        expandRatio - the expandRatio used to divide excess space for this column

      • getColumnExpandRatio

        public float getColumnExpandRatio​(Object propertyId)
        Gets the column expand ratio for a column. See setColumnExpandRatio(Object, float)
        Parameters:
        propertyId - columns property id
        Returns:
        the expandRatio used to divide excess space for this column

      • getColumnWidth

        public int getColumnWidth​(Object propertyId)
        Gets the pixel width of column
        Parameters:
        propertyId -
        Returns:
        width of column or -1 when value not set

      • getPageLength

        public int getPageLength()
        Gets the page length.

        Setting page length 0 disables paging.

        Returns:
        the Length of one page.

      • setPageLength

        public void setPageLength​(int pageLength)
        Sets the page length.

        Setting page length 0 disables paging. The page length defaults to 15.

        If Table has height set (AbstractComponent.setHeight(float, Unit) ) the client side may update the page length automatically the correct value.

        Parameters:
        pageLength - the length of one page.

      • setCacheRate

        public void setCacheRate​(double cacheRate)
        This method adjusts a possible caching mechanism of table implementation.

        Table component may fetch and render some rows outside visible area. With complex tables (for example containing layouts and components), the client side may become unresponsive. Setting the value lower, UI will become more responsive. With higher values scrolling in client will hit server less frequently.

        The amount of cached rows will be cacheRate multiplied with pageLength ( setPageLength(int) both below and above visible area..

        Parameters:
        cacheRate - a value over 0 (fastest rendering time). Higher value will cache more rows on server (smoother scrolling). Default value is 2.

      • getCacheRate

        public double getCacheRate()
        Returns:
        the current cache rate value
        See Also:
        setCacheRate(double)

      • getCurrentPageFirstItemId

        public Object getCurrentPageFirstItemId()
        Getter for property currentPageFirstItem.
        Returns:
        the Value of property currentPageFirstItem.

      • setCurrentPageFirstItemId

        public void setCurrentPageFirstItemId​(Object currentPageFirstItemId)
        Setter for property currentPageFirstItemId.
        Parameters:
        currentPageFirstItemId - the New value of property currentPageFirstItemId.

      • indexOfId

        protected int indexOfId​(Object itemId)

      • getColumnIcon

        public Resource getColumnIcon​(Object propertyId)
        Gets the icon Resource for the specified column.
        Parameters:
        propertyId - the propertyId identifying the column.
        Returns:
        the icon for the specified column; null if the column has no icon set, or if the column is not visible.

      • setColumnIcon

        public void setColumnIcon​(Object propertyId,
                          Resource icon)
        Sets the icon Resource for the specified column.

        Throws IllegalArgumentException if the specified column is not visible.

        Parameters:
        propertyId - the propertyId identifying the column.
        icon - the icon Resource to set.

      • getColumnHeader

        public String getColumnHeader​(Object propertyId)
        Gets the header for the specified column.
        Parameters:
        propertyId - the propertyId identifying the column.
        Returns:
        the header for the specified column if it has one.

      • setColumnHeader

        public void setColumnHeader​(Object propertyId,
                            String header)
        Sets the column header for the specified column;
        Parameters:
        propertyId - the propertyId identifying the column.
        header - the header to set.

      • getColumnAlignment

        public Table.Align getColumnAlignment​(Object propertyId)
        Gets the specified column's alignment.
        Parameters:
        propertyId - the propertyID identifying the column.
        Returns:
        the specified column's alignment if it as one; Table.Align.LEFT otherwise.

      • setColumnAlignment

        public void setColumnAlignment​(Object propertyId,
                               Table.Align alignment)
        Sets the specified column's alignment.

        Throws IllegalArgumentException if the alignment is not one of the following: Table.Align.LEFT, Table.Align.CENTER or Table.Align.RIGHT

        Parameters:
        propertyId - the propertyID identifying the column.
        alignment - the desired alignment.

      • isColumnCollapsed

        public boolean isColumnCollapsed​(Object propertyId)
        Checks if the specified column is collapsed.
        Parameters:
        propertyId - the propertyID identifying the column.
        Returns:
        true if the column is collapsed; false otherwise;

      • setColumnCollapsed

        public void setColumnCollapsed​(Object propertyId,
                               boolean collapsed)
                        throws IllegalStateException
        Sets whether the specified column is collapsed or not.
        Parameters:
        propertyId - the propertyID identifying the column.
        collapsed - the desired collapsedness.
        Throws:
        IllegalStateException - if column collapsing is not allowed
        IllegalArgumentException - if the property id does not exist

      • isColumnCollapsingAllowed

        public boolean isColumnCollapsingAllowed()
        Checks if column collapsing is allowed.
        Returns:
        true if columns can be collapsed; false otherwise.

      • setColumnCollapsingAllowed

        public void setColumnCollapsingAllowed​(boolean collapsingAllowed)
        Sets whether column collapsing is allowed or not.
        Parameters:
        collapsingAllowed - specifies whether column collapsing is allowed.

      • setColumnCollapsible

        public void setColumnCollapsible​(Object propertyId,
                                 boolean collapsible)
        Sets whether the given column is collapsible. Note that collapsible columns can only be actually collapsed (via UI or with setColumnCollapsed()) if isColumnCollapsingAllowed() is true. By default all columns are collapsible.
        Parameters:
        propertyId - the propertyID identifying the column.
        collapsible - true if the column should be collapsible, false otherwise.

      • isColumnCollapsible

        public boolean isColumnCollapsible​(Object propertyId)
        Checks if the given column is collapsible. Note that even if this method returns true, the column can only be actually collapsed (via UI or with setColumnCollapsed()) if isColumnCollapsingAllowed() is also true.
        Returns:
        true if the column can be collapsed; false otherwise.

      • isColumnReorderingAllowed

        public boolean isColumnReorderingAllowed()
        Checks if column reordering is allowed.
        Returns:
        true if columns can be reordered; false otherwise.

      • setColumnReorderingAllowed

        public void setColumnReorderingAllowed​(boolean columnReorderingAllowed)
        Sets whether column reordering is allowed or not.
        Parameters:
        columnReorderingAllowed - specifies whether column reordering is allowed.

      • getCurrentPageFirstItemIndex

        public int getCurrentPageFirstItemIndex()
        Getter for property currentPageFirstItem.
        Returns:
        the Value of property currentPageFirstItem.

      • setCurrentPageFirstItemIndex

        public void setCurrentPageFirstItemIndex​(int newIndex)
        Setter for property currentPageFirstItem.
        Parameters:
        newIndex - the New value of property currentPageFirstItem.

      • isSelectable

        public boolean isSelectable()
        Returns whether table is selectable.

        The table is not selectable until it's explicitly set as selectable or at least one Property.ValueChangeListener is added.

        Returns:
        whether table is selectable.

      • setSelectable

        public void setSelectable​(boolean selectable)
        Setter for property selectable.

        The table is not selectable until it's explicitly set as selectable via this method or alternatively at least one Property.ValueChangeListener is added.

        Parameters:
        selectable - the New value of property selectable.

      • getColumnHeaderMode

        public Table.ColumnHeaderMode getColumnHeaderMode()
        Getter for property columnHeaderMode.
        Returns:
        the Value of property columnHeaderMode.

      • setColumnHeaderMode

        public void setColumnHeaderMode​(Table.ColumnHeaderMode columnHeaderMode)
        Setter for property columnHeaderMode.
        Parameters:
        columnHeaderMode - the New value of property columnHeaderMode.

      • refreshRenderedCells

        protected void refreshRenderedCells()
        Refreshes the rows in the internal cache. Only if resetPageBuffer() is called before this then all values are guaranteed to be recreated.

      • getItemIds

        protected List<Object> getItemIds​(int firstIndex,
                                  int rows)

      • registerComponent

        protected void registerComponent​(Component component)

      • unregisterComponent

        protected void unregisterComponent​(Component component)
        This method cleans up a Component that has been generated when Table is in editable mode. The component needs to be detached from its parent and if it is a field, it needs to be detached from its property data source in order to allow garbage collection to take care of removing the unused component from memory. Override this method and getPropertyValue(Object, Object, Property) with custom logic if you need to deal with buffered fields.
        Parameters:
        component - component that should be unregistered.
        See Also:
        getPropertyValue(Object, Object, Property)

      • addItem

        public Object addItem​(Object[] cells,
                      Object itemId)
               throws UnsupportedOperationException
        Adds the new row to table and fill the visible cells (except generated columns) with given values.
        Parameters:
        cells - the Object array that is used for filling the visible cells new row. The types must be settable to visible column property types.
        itemId - the Id the new row. If null, a new id is automatically assigned. If given, the table cannot already have a item with given id.
        Returns:
        Returns item id for the new row. Returns null if operation fails.
        Throws:
        UnsupportedOperationException

      • refreshRowCache

        public void refreshRowCache()
        Discards and recreates the internal row cache. Call this if you make changes that affect the rows but the information about the changes are not automatically propagated to the Table.

        Do not call this e.g. if you have updated the data model through a Property. These types of changes are automatically propagated to the Table.

        A typical case when this is needed is if you update a generator (e.g. CellStyleGenerator) and want to ensure that the rows are redrawn with new styles.

        Note that calling this method is not cheap so avoid calling it unnecessarily.

        Since:
        6.7.2

      • setContainerDataSource

        public void setContainerDataSource​(Container newDataSource,
                                   Collection<?> visibleIds)
        Sets the container data source and the columns that will be visible. Columns are shown in the collection's iteration order.

        Keeps propertyValueConverters if the corresponding id exists in the new data source and is of a compatible type.

        Parameters:
        newDataSource - the new data source.
        visibleIds - IDs of the visible columns
        See Also:
        setContainerDataSource(Container), setVisibleColumns(Object[]), Table#setConverter(Object, Converter)

      • disableContentRefreshing

        protected boolean disableContentRefreshing()
        Go to mode where content updates are not done. This is due we want to bypass expensive content for some reason (like when we know we may have other content changes on their way).
        Returns:
        true if content refresh flag was enabled prior this call

      • enableContentRefreshing

        protected void enableContentRefreshing​(boolean refreshContent)
        Go to mode where content content refreshing has effect.
        Parameters:
        refreshContent - true if content refresh needs to be done

      • beforeClientResponse

        public void beforeClientResponse​(boolean initial)
        Description copied from interface: ClientConnector
        Called before the shared state and RPC invocations are sent to the client. Gives the connector an opportunity to set computed/dynamic state values or to invoke last minute RPC methods depending on other component features.
        Specified by:
        beforeClientResponse in interface ClientConnector
        Overrides:
        beforeClientResponse in class AbstractField<Object>
        Parameters:
        initial - true if the client-side connector will be created and initialized after this method has been invoked. false if there is already an initialized client-side connector.

      • isRowCacheInvalidated

        protected boolean isRowCacheInvalidated()

      • isPartialRowUpdate

        protected boolean isPartialRowUpdate()
        Subclass and override this to enable partial row updates and additions, which bypass the normal caching mechanism. This is useful for e.g. TreeTable.
        Returns:
        true if this update is a partial row update, false if not. For plain Table it is always false.

      • getFirstAddedItemIndex

        protected int getFirstAddedItemIndex()
        Subclass and override this to enable partial row additions, bypassing the normal caching mechanism. This is useful for e.g. TreeTable, where expanding a node should only fetch and add the items inside of that node.
        Returns:
        The index of the first added item. For plain Table it is always 0.

      • getAddedRowCount

        protected int getAddedRowCount()
        Subclass and override this to enable partial row additions, bypassing the normal caching mechanism. This is useful for e.g. TreeTable, where expanding a node should only fetch and add the items inside of that node.
        Returns:
        the number of rows to be added, starting at the index returned by getFirstAddedItemIndex(). For plain Table it is always 0.

      • shouldHideAddedRows

        protected boolean shouldHideAddedRows()
        Subclass and override this to enable removing of rows, bypassing the normal caching and lazy loading mechanism. This is useful for e.g. TreeTable, when you need to hide certain rows as a node is collapsed. This should return true if the rows pointed to by getFirstAddedItemIndex() and getAddedRowCount() should be hidden instead of added.
        Returns:
        whether the rows to add (see getFirstAddedItemIndex() and getAddedRowCount()) should be added or hidden. For plain Table it is always false.

      • getFirstUpdatedItemIndex

        protected int getFirstUpdatedItemIndex()
        Subclass and override this to enable partial row updates, bypassing the normal caching and lazy loading mechanism. This is useful for updating the state of certain rows, e.g. in the TreeTable the collapsed state of a single node is updated using this mechanism.
        Returns:
        the index of the first item to be updated. For plain Table it is always 0.

      • getUpdatedRowCount

        protected int getUpdatedRowCount()
        Subclass and override this to enable partial row updates, bypassing the normal caching and lazy loading mechanism. This is useful for updating the state of certain rows, e.g. in the TreeTable the collapsed state of a single node is updated using this mechanism.
        Returns:
        the number of rows to update, starting at the index returned by getFirstUpdatedItemIndex(). For plain table it is always 0.

      • rowHeadersAreEnabled

        protected boolean rowHeadersAreEnabled()
        Checks whether row headers are visible.
        Returns:
        false if row headers are hidden, true otherwise
        Since:
        7.3.9

      • paintRowAttributes

        protected void paintRowAttributes​(PaintTarget target,
                                  Object itemId)
                           throws PaintException
        A method where extended Table implementations may add their custom attributes for rows.
        Parameters:
        target -
        itemId -
        Throws:
        PaintException

      • getPropertyValue

        protected Object getPropertyValue​(Object rowId,
                                  Object colId,
                                  Property property)
        Gets the value of property. By default if the table is editable the fieldFactory is used to create editors for table cells. Otherwise formatPropertyValue is used to format the value representation.
        Parameters:
        rowId - the Id of the row (same as item Id).
        colId - the Id of the column.
        property - the Property to be presented.
        Returns:
        Object Either formatted value or Component for field.
        See Also:
        setTableFieldFactory(TableFieldFactory)

      • bindPropertyToField

        protected void bindPropertyToField​(Object rowId,
                                   Object colId,
                                   Property property,
                                   Field field)
        Binds an item property to a field generated by TableFieldFactory. The default behavior is to bind property straight to Field. If Property.Viewer type property (e.g. PropertyFormatter) is already set for field, the property is bound to that Property.Viewer.
        Parameters:
        rowId -
        colId -
        property -
        field -
        Since:
        6.7.3

      • formatPropertyValue

        protected String formatPropertyValue​(Object rowId,
                                     Object colId,
                                     Property<?> property)
        Formats table cell property values. By default the property.toString() and return a empty string for null properties.
        Parameters:
        rowId - the Id of the row (same as item Id).
        colId - the Id of the column.
        property - the Property to be formatted.
        Returns:
        the String representation of property and its value.
        Since:
        3.1

      • removeAllActionHandlers

        public void removeAllActionHandlers()
        Removes all action handlers

      • resetPageBuffer

        protected void resetPageBuffer()
        Clears the current page buffer. Call this before refreshRenderedCells() to ensure that all content is updated from the properties.

      • addContainerProperty

        public boolean addContainerProperty​(Object propertyId,
                                    Class<?> type,
                                    Object defaultValue,
                                    String columnHeader,
                                    Resource columnIcon,
                                    Table.Align columnAlignment)
                             throws UnsupportedOperationException
        Adds a new property to the table and show it as a visible column.
        Parameters:
        propertyId - the Id of the property
        type - the class of the property
        defaultValue - the default value given for all existing items
        columnHeader - the Explicit header of the column. If explicit header is not needed, this should be set null.
        columnIcon - the Icon of the column. If icon is not needed, this should be set null.
        columnAlignment - the Alignment of the column. Null implies align left.
        Throws:
        UnsupportedOperationException - if the operation is not supported.
        See Also:
        Container.addContainerProperty(Object, Class, Object)

      • addGeneratedColumn

        public void addGeneratedColumn​(Object id,
                               Table.ColumnGenerator generatedColumn)
        Adds a generated column to the Table.

        A generated column is a column that exists only in the Table, not as a property in the underlying Container. It shows up just as a regular column.

        A generated column will override a property with the same id, so that the generated column is shown instead of the column representing the property. Note that getContainerProperty() will still get the real property.

        Table will not listen to value change events from properties overridden by generated columns. If the content of your generated column depends on properties that are not directly visible in the table, attach value change listener to update the content on all depended properties. Otherwise your UI might not get updated as expected.

        Also note that getVisibleColumns() will return the generated columns, while getContainerPropertyIds() will not.

        Parameters:
        id - the id of the column to be added
        generatedColumn - the Table.ColumnGenerator to use for this column

      • removeGeneratedColumn

        public boolean removeGeneratedColumn​(Object columnId)
        Removes a generated column previously added with addGeneratedColumn.
        Parameters:
        columnId - id of the generated column to remove
        Returns:
        true if the column could be removed (existed in the Table)

      • getVisibleItemIds

        public Collection<?> getVisibleItemIds()
        Returns item identifiers of the items which are currently rendered on the client.

        Note, that some due to historical reasons the name of the method is bit misleading. Some items may be partly or totally out of the viewport of the table's scrollable area. Actually detecting rows which can be actually seen by the end user may be problematic due to the client server architecture. Using getCurrentPageFirstItemId() combined with getPageLength() may produce good enough estimates in some situations.

        Overrides:
        getVisibleItemIds in class AbstractSelect
        See Also:
        AbstractSelect.getVisibleItemIds()

      • isFirstId

        public boolean isFirstId​(Object itemId)
        Tests if the Item corresponding to the given Item ID is the first Item in the Container.
        Specified by:
        isFirstId in interface Container.Ordered
        Parameters:
        itemId - ID of an Item in the Container
        Returns:
        true if the Item is first visible item in the Container, false if not
        See Also:
        Container.Ordered.isFirstId(java.lang.Object)

      • setTableFieldFactory

        public void setTableFieldFactory​(TableFieldFactory fieldFactory)
        Sets the TableFieldFactory that is used to create editor for table cells. The TableFieldFactory is only used if the Table is editable. By default the DefaultFieldFactory is used.
        Parameters:
        fieldFactory - the field factory to set.
        See Also:
        isEditable(), DefaultFieldFactory

      • getTableFieldFactory

        public TableFieldFactory getTableFieldFactory()
        Gets the TableFieldFactory that is used to create editor for table cells. The FieldFactory is only used if the Table is editable.
        Returns:
        TableFieldFactory used to create the Field instances.
        See Also:
        isEditable()

      • isEditable

        public boolean isEditable()
        Is table editable. If table is editable a editor of type Field is created for each table cell. The assigned FieldFactory is used to create the instances. To provide custom editors for table cells create a class implementing the FieldFactory interface, and assign it to table, and set the editable property to true.
        Returns:
        true if table is editable, false otherwise.
        See Also:
        Field, FieldFactory

      • setEditable

        public void setEditable​(boolean editable)
        Sets the editable property. If table is editable a editor of type Field is created for each table cell. The assigned FieldFactory is used to create the instances. To provide custom editors for table cells create a class implementing the FieldFactory interface, and assign it to table, and set the editable property to true.
        Parameters:
        editable - true if table should be editable by user.
        See Also:
        Field, FieldFactory

      • sort

        public void sort()
        Sorts the table by currently selected sorting column.
        Throws:
        UnsupportedOperationException - if the container data source does not implement Container.Sortable

      • getSortContainerPropertyId

        public Object getSortContainerPropertyId()
        Gets the currently sorted column property ID.
        Returns:
        the Container property id of the currently sorted column.

      • setSortContainerPropertyId

        public void setSortContainerPropertyId​(Object propertyId)
        Sets the currently sorted column property id.
        Parameters:
        propertyId - the Container property id of the currently sorted column.

      • isSortAscending

        public boolean isSortAscending()
        Is the table currently sorted in ascending order.
        Returns:
        true if ascending, false if descending.

      • setSortAscending

        public void setSortAscending​(boolean ascending)
        Sets the table in ascending order.
        Parameters:
        ascending - true if ascending, false if descending.

      • isSortDisabled

        @Deprecated
public boolean isSortDisabled()
        Deprecated.
        As of 7.0, use isSortEnabled() instead
        Is sorting disabled altogether. True iff no sortable columns are given even in the case where data source would support this.
        Returns:
        True iff sorting is disabled.

      • isSortEnabled

        public boolean isSortEnabled()
        Checks if sorting is enabled.
        Returns:
        true if sorting by the user is allowed, false otherwise

      • setSortDisabled

        @Deprecated
public void setSortDisabled​(boolean sortDisabled)
        Deprecated.
        As of 7.0, use setSortEnabled(boolean) instead
        Disables the sorting by the user altogether.
        Parameters:
        sortDisabled - True iff sorting is disabled.

      • setSortEnabled

        public void setSortEnabled​(boolean sortEnabled)
        Enables or disables sorting.

        Setting this to false disallows sorting by the user. It is still possible to call sort().

        Parameters:
        sortEnabled - true to allow the user to sort the table, false to disallow it

      • setCellStyleGenerator

        public void setCellStyleGenerator​(Table.CellStyleGenerator cellStyleGenerator)
        Set cell style generator for Table.
        Parameters:
        cellStyleGenerator - New cell style generator or null to remove generator.

      • setEnabled

        public void setEnabled​(boolean enabled)
        Description copied from interface: Component
        Enables or disables the component. The user can not interact with disabled components, which are shown with a style that indicates the status, usually shaded in light gray color. Components are enabled by default. 
         Button enabled = new Button("Enabled");
 enabled.setEnabled(true); // The default
 layout.addComponent(enabled);

 Button disabled = new Button("Disabled");
 disabled.setEnabled(false);
 layout.addComponent(disabled);

        This method will trigger a RepaintRequestEvent for the component and, if it is a ComponentContainer, for all its children recursively.

        Specified by:
        setEnabled in interface Component
        Overrides:
        setEnabled in class AbstractComponent
        Parameters:
        enabled - a boolean value specifying if the component should be enabled or not

      • setDragMode

        public void setDragMode​(Table.TableDragMode newDragMode)
        Sets the drag start mode of the Table. Drag start mode controls how Table behaves as a drag source.
        Parameters:
        newDragMode -

      • getDragMode

        public Table.TableDragMode getDragMode()
        Returns:
        the current start mode of the Table. Drag start mode controls how Table behaves as a drag source.

      • getTransferable

        public Table.TableTransferable getTransferable​(Map<String,​Object> rawVariables)
        Description copied from interface: DragSource
        DragSource may convert data added by client side component to meaningful values for server side developer or add other data based on it.

        For example Tree converts item identifiers to generated string keys for the client side. Vaadin developer don't and can't know anything about these generated keys, only about item identifiers. When tree node is dragged client puts that key to Transferables client side counterpart. In Tree.getTransferable(Map) the key is converted back to item identifier that the server side developer can use.

        Specified by:
        getTransferable in interface DragSource
        Parameters:
        rawVariables - the data that client side initially included in Transferables client side counterpart.
        Returns:
        the Transferable instance that will be passed to DropHandler (and/or AcceptCriterion)

      • getDropHandler

        public DropHandler getDropHandler()
        Specified by:
        getDropHandler in interface DropTarget
        Returns:
        the drop hanler that will receive the dragged data or null if drops are not currently accepted

      • setDropHandler

        public void setDropHandler​(DropHandler dropHandler)

      • setMultiSelectMode

        public void setMultiSelectMode​(MultiSelectMode mode)
        Sets the behavior of how the multi-select mode should behave when the table is both selectable and in multi-select mode.

        Note, that on some clients the mode may not be respected. E.g. on touch based devices CTRL/SHIFT base selection method is invalid, so touch based browsers always use the MultiSelectMode.SIMPLE unless touch multi select is explicitly disabled .

        Parameters:
        mode - The select mode of the table
        See Also:
        setMultiSelectTouchDetectionEnabled(boolean)

      • getMultiSelectMode

        public MultiSelectMode getMultiSelectMode()
        Returns the select mode in which multi-select is used.
        Returns:
        The multi select mode

      • setMultiSelectTouchDetectionEnabled

        public void setMultiSelectTouchDetectionEnabled​(boolean multiSelectTouchDetectionEnabled)
        Default behavior on touch-reporting devices is to switch from CTRL/SHIFT based multi-selection to simple mode, but you can use this method to explicitly disable the touch device detection. Thus you can keep using keyboard-based multi selection on hybrid devices that have both a touch screen and a keyboard.
        Parameters:
        multiSelectTouchDetectionEnabled - Whether to enable or disable touch screen detection

      • isMultiSelectTouchDetectionEnabled

        public boolean isMultiSelectTouchDetectionEnabled()
        Returns if touch screen detection is used to toggle multi select mode.
        Returns:
        If touch screen detection for multi select is enabled

      • addHeaderClickListener

        public void addHeaderClickListener​(Table.HeaderClickListener listener)
        Adds a header click listener which handles the click events when the user clicks on a column header cell in the Table.

        The listener will receive events which contain information about which column was clicked and some details about the mouse event.

        Parameters:
        listener - The handler which should handle the header click events.

      • removeHeaderClickListener

        public void removeHeaderClickListener​(Table.HeaderClickListener listener)
        Removes a header click listener
        Parameters:
        listener - The listener to remove.

      • addFooterClickListener

        public void addFooterClickListener​(Table.FooterClickListener listener)
        Adds a footer click listener which handles the click events when the user clicks on a column footer cell in the Table.

        The listener will receive events which contain information about which column was clicked and some details about the mouse event.

        Parameters:
        listener - The handler which should handle the footer click events.

      • removeFooterClickListener

        public void removeFooterClickListener​(Table.FooterClickListener listener)
        Removes a footer click listener
        Parameters:
        listener - The listener to remove.

      • getColumnFooter

        public String getColumnFooter​(Object propertyId)
        Gets the footer caption beneath the rows
        Parameters:
        propertyId - The propertyId of the column *
        Returns:
        The caption of the footer or NULL if not set

      • setColumnFooter

        public void setColumnFooter​(Object propertyId,
                            String footer)
        Sets the column footer caption. The column footer caption is the text displayed beneath the column if footers have been set visible.
        Parameters:
        propertyId - The properyId of the column
        footer - The caption of the footer

      • setFooterVisible

        public void setFooterVisible​(boolean visible)
        Sets the footer visible in the bottom of the table.

        The footer can be used to add column related data like sums to the bottom of the Table using setColumnFooter(Object propertyId, String footer).

        Parameters:
        visible - Should the footer be visible

      • isFooterVisible

        public boolean isFooterVisible()
        Is the footer currently visible?
        Returns:
        Returns true if visible else false

      • addColumnResizeListener

        public void addColumnResizeListener​(Table.ColumnResizeListener listener)
        Adds a column resize listener to the Table. A column resize listener is called when a user resizes a columns width.
        Parameters:
        listener - The listener to attach to the Table

      • removeColumnResizeListener

        public void removeColumnResizeListener​(Table.ColumnResizeListener listener)
        Removes a column resize listener from the Table.
        Parameters:
        listener - The listener to remove

      • addColumnReorderListener

        public void addColumnReorderListener​(Table.ColumnReorderListener listener)
        Adds a column reorder listener to the Table. A column reorder listener is called when a user reorders columns.
        Parameters:
        listener - The listener to attach to the Table

      • removeColumnReorderListener

        public void removeColumnReorderListener​(Table.ColumnReorderListener listener)
        Removes a column reorder listener from the Table.
        Parameters:
        listener - The listener to remove

      • addColumnCollapseListener

        public void addColumnCollapseListener​(Table.ColumnCollapseListener listener)
        Adds a column collapse listener to the Table. A column collapse listener is called when the collapsed state of a column changes.
        Parameters:
        listener - The listener to attach
        Since:
        7.6

      • removeColumnCollapseListener

        public void removeColumnCollapseListener​(Table.ColumnCollapseListener listener)
        Removes a column reorder listener from the Table.
        Parameters:
        listener - The listener to remove
        Since:
        7.6

      • setItemDescriptionGenerator

        public void setItemDescriptionGenerator​(AbstractSelect.ItemDescriptionGenerator generator)
        Set the item description generator which generates tooltips for cells and rows in the Table
        Parameters:
        generator - The generator to use or null to disable

      • getItemDescriptionGenerator

        public AbstractSelect.ItemDescriptionGenerator getItemDescriptionGenerator()
        Get the item description generator which generates tooltips for cells and rows in the Table.

      • setRowGenerator

        public void setRowGenerator​(Table.RowGenerator generator)
        Assigns a row generator to the table. The row generator will be able to replace rows in the table when it is rendered.
        Parameters:
        generator - the new row generator

      • getRowGenerator

        public Table.RowGenerator getRowGenerator()
        Returns:
        the current row generator

      • setConverter

        public void setConverter​(Object propertyId,
                         Converter<String,​?> converter)
        Sets a converter for a property id.

        The converter is used to format the the data for the given property id before displaying it in the table.

        Parameters:
        propertyId - The propertyId to format using the converter
        converter - The converter to use for the property id

      • hasConverter

        protected boolean hasConverter​(Object propertyId)
        Checks if there is a converter set explicitly for the given property id.
        Parameters:
        propertyId - The propertyId to check
        Returns:
        true if a converter has been set for the property id, false otherwise

      • getConverter

        public Converter<String,​Object> getConverter​(Object propertyId)
        Returns the converter used to format the given propertyId.
        Parameters:
        propertyId - The propertyId to check
        Returns:
        The converter used to format the propertyId or null if no converter has been set

      • setVisible

        public void setVisible​(boolean visible)
        Description copied from interface: Component
        Sets the visibility of the component.

        Visible components are drawn in the user interface, while invisible ones are not. The effect is not merely a cosmetic CSS change - no information about an invisible component will be sent to the client. The effect is thus the same as removing the component from its parent. 

         TextField readonly = new TextField("Read-Only");
 readonly.setValue("You can't see this!");
 readonly.setVisible(false);
 layout.addComponent(readonly);

        A component is visible only if all of its parents are also visible. If a component is explicitly set to be invisible, changes in the visibility of its parents will not change the visibility of the component.

        Specified by:
        setVisible in interface Component
        Overrides:
        setVisible in class AbstractComponent
        Parameters:
        visible - the boolean value specifying if the component should be visible after the call or not.
        See Also:
        Component.isVisible()

      • iterator

        public Iterator<Component> iterator()
        Description copied from interface: HasComponents
        Gets an iterator to the collection of contained components. Using this iterator it is possible to step through all components contained in this container.
        Specified by:
        iterator in interface HasComponents
        Specified by:
        iterator in interface Iterable<Component>
        Returns:
        the component iterator.

      • readDesign

        public void readDesign​(org.jsoup.nodes.Element design,
                       DesignContext context)
        Description copied from interface: Component
        Reads the component state from the given design.

        The component is responsible not only for updating its own state but also for ensuring that its children update their state based on the design.

        It is assumed that the component is in its default state when this method is called. Reading should only take into consideration attributes specified in the design and not reset any unspecified attributes to their defaults.

        This method must not modify the design.

        Specified by:
        readDesign in interface Component
        Overrides:
        readDesign in class AbstractSelect
        Parameters:
        design - The element to obtain the state from
        context - The DesignContext instance used for parsing the design

      • readBody

        protected void readBody​(org.jsoup.nodes.Element design,
                        DesignContext context)

      • readItem

        protected Object readItem​(org.jsoup.nodes.Element tr,
                          Set<String> selected,
                          DesignContext context)
        Description copied from class: AbstractSelect
        Reads an Item from a design and inserts it into the data source. Hierarchical select components should override this method to recursively recursively read any child items as well.
        Overrides:
        readItem in class AbstractSelect
        Parameters:
        tr - a child element representing the item
        selected - A set accumulating selected items. If the item that is read is marked as selected, its item id should be added to this set.
        context - the DesignContext instance used in parsing
        Returns:
        the item id of the new item

      • writeDesign

        public void writeDesign​(org.jsoup.nodes.Element design,
                        DesignContext context)
        Description copied from interface: Component
        Writes the component state to the given design.

        The component is responsible not only for writing its own state but also for ensuring that its children write their state to the design.

        This method must not modify the component state.

        Specified by:
        writeDesign in interface Component
        Overrides:
        writeDesign in class AbstractSelect
        Parameters:
        design - The element to write the component state to. Any previous attributes or child nodes are not cleared.
        context - The DesignContext instance used for writing the design

      • writeItems

        protected void writeItems​(org.jsoup.nodes.Element design,
                          DesignContext context)
        Description copied from class: AbstractSelect
        Writes the data source items to a design. Hierarchical select components should override this method to only write the root items.
        Overrides:
        writeItems in class AbstractSelect
        Parameters:
        design - the element into which to insert the items
        context - the DesignContext instance used in writing

      • writeItem

        protected org.jsoup.nodes.Element writeItem​(org.jsoup.nodes.Element tbody,
                                            Object itemId,
                                            DesignContext context)
        Description copied from class: AbstractSelect
        Writes a data source Item to a design. Hierarchical select components should override this method to recursively write any child items as well.
        Overrides:
        writeItem in class AbstractSelect
        Parameters:
        tbody - the element into which to insert the item
        itemId - the id of the item to write
        context - the DesignContext instance used in writing
        Returns:

      • getState

        protected TableState getState()
        Description copied from class: AbstractComponent
        Returns the shared state bean with information to be sent from the server to the client. Subclasses should override this method and set any relevant fields of the state returned by super.getState().
        Overrides:
        getState in class AbstractSelect
        Returns:
        updated component shared state

      • setCollapseMenuContent

        public void setCollapseMenuContent​(CollapseMenuContent content)
        Sets whether only collapsible columns should be shown to the user in the column collapse menu. The default is CollapseMenuContent.ALL_COLUMNS.
        Parameters:
        content - the desired collapsible menu content setting
        Since:
        7.6

      • getCollapseMenuContent

        public CollapseMenuContent getCollapseMenuContent()
        Checks whether only collapsible columns are shown to the user in the column collapse menu. The default is CollapseMenuContent.ALL_COLUMNS .
        Returns:
        the current collapsible menu content setting
        Since:
        7.6