Package com.vaadin.v7.ui

Class Grid

    • Constructor Detail

      • Grid

        public Grid()
        Deprecated.
        Creates a new Grid with a new IndexedContainer as the data source.

      • Grid

        public Grid​(Container.Indexed dataSource)
        Deprecated.
        Creates a new Grid using the given data source.
        Parameters:
        dataSource - the indexed container to use as a data source

      • Grid

        public Grid​(String caption)
        Deprecated.
        Creates a new Grid with the given caption and a new IndexedContainer data source.
        Parameters:
        caption - the caption of the grid

      • Grid

        public Grid​(String caption,
            Container.Indexed dataSource)
        Deprecated.
        Creates a new Grid with the given caption and data source. If the data source is null, a new IndexedContainer will be used.
        Parameters:
        caption - the caption of the grid
        dataSource - the indexed container to use as a data source

    • Method Detail

      • setContainerDataSource

        public void setContainerDataSource​(Container.Indexed container)
        Deprecated.
        Sets the grid data source.

        Note Grid columns are based on properties and try to detect a correct converter for the data type. The columns are not reinitialized automatically if the container is changed, and if the same properties are present after container change, the columns are reused. Properties with same names, but different data types will lead to unpredictable behavior.

        Parameters:
        container - The container data source. Cannot be null.
        Throws:
        IllegalArgumentException - if the data source is null

      • getContainerDataSource

        public Container.Indexed getContainerDataSource()
        Deprecated.
        Returns the grid data source.
        Returns:
        the container data source of the grid

      • getColumn

        public Grid.Column getColumn​(Object propertyId)
        Deprecated.
        Returns a column based on the property id.
        Parameters:
        propertyId - the property id of the column
        Returns:
        the column or null if not found

      • getColumns

        public List<Grid.Column> getColumns()
        Deprecated.
        Returns a copy of currently configures columns in their current visual order in this Grid.
        Returns:
        unmodifiable copy of current columns in visual order

      • addColumn

        public Grid.Column addColumn​(Object propertyId)
                      throws IllegalStateException
        Deprecated.
        Adds a new Column to Grid. Also adds the property to container with data type String, if property for column does not exist in it. Default value for the new property is an empty String.

        Note that adding a new property is only done for the default container that Grid sets up with the default constructor.

        Parameters:
        propertyId - the property id of the new column
        Returns:
        the new column
        Throws:
        IllegalStateException - if column for given property already exists in this grid

      • addColumn

        public Grid.Column addColumn​(Object propertyId,
                             Class<?> type)
        Deprecated.
        Adds a new Column to Grid. This function makes sure that the property with the given id and data type exists in the container. If property does not exists, it will be created.

        Default value for the new property is 0 if type is Integer, Double and Float. If type is String, default value is an empty string. For all other types the default value is null.

        Note that adding a new property is only done for the default container that Grid sets up with the default constructor.

        Parameters:
        propertyId - the property id of the new column
        type - the data type for the new property
        Returns:
        the new column
        Throws:
        IllegalStateException - if column for given property already exists in this grid or property already exists in the container with wrong type

      • removeAllColumns

        public void removeAllColumns()
        Deprecated.
        Removes all columns from this Grid.

      • isColumnReorderingAllowed

        public boolean isColumnReorderingAllowed()
        Deprecated.
        Returns whether column reordering is allowed. Default value is false.
        Returns:
        true if reordering is allowed
        Since:
        7.5.0

      • setColumnReorderingAllowed

        public void setColumnReorderingAllowed​(boolean columnReorderingAllowed)
        Deprecated.
        Sets whether or not column reordering is allowed. Default value is false.
        Parameters:
        columnReorderingAllowed - specifies whether column reordering is allowed
        Since:
        7.5.0

      • isReadOnly

        public boolean isReadOnly()
        Deprecated.
        Returns the read-only state.
        Overrides:
        isReadOnly in class AbstractComponent
        Since:
        8.22
        See Also:
        AbstractLegacyComponent#isReadOnly(boolean)

      • setColumnResizeMode

        public void setColumnResizeMode​(ColumnResizeMode mode)
        Deprecated.
        Sets the column resize mode to use. The default mode is ColumnResizeMode.ANIMATED.
        Parameters:
        mode - a ColumnResizeMode value
        Since:
        7.7.5

      • getColumnResizeMode

        public ColumnResizeMode getColumnResizeMode()
        Deprecated.
        Returns the current column resize mode. The default mode is ColumnResizeMode.ANIMATED.
        Returns:
        a ColumnResizeMode value
        Since:
        7.7.5

      • removeColumn

        public void removeColumn​(Object propertyId)
                  throws IllegalArgumentException
        Deprecated.
        Removes a column from Grid based on a property id.
        Parameters:
        propertyId - The property id of column to be removed
        Throws:
        IllegalArgumentException - if there is no column for given property id in this grid

      • setColumns

        public void setColumns​(Object... propertyIds)
        Deprecated.
        Sets the columns and their order for the grid. Current columns whose property id is not in propertyIds are removed. Similarly, a column is added for any property id in propertyIds that has no corresponding column in this Grid.
        Parameters:
        propertyIds - properties in the desired column order
        Since:
        7.5.0

      • setColumnOrder

        public void setColumnOrder​(Object... propertyIds)
        Deprecated.
        Sets a new column order for the grid. All columns which are not ordered here will remain in the order they were before as the last columns of grid.
        Parameters:
        propertyIds - properties in the order columns should be

      • setFrozenColumnCount

        public void setFrozenColumnCount​(int numberOfColumns)
        Deprecated.
        Sets the number of frozen columns in this grid. Setting the count to 0 means that no data columns will be frozen, but the built-in selection checkbox column will still be frozen if it's in use. Setting the count to -1 will also disable the selection column.

        The default value is 0.

        Parameters:
        numberOfColumns - the number of columns that should be frozen
        Throws:
        IllegalArgumentException - if the column count is < 0 or > the number of visible columns

      • getFrozenColumnCount

        public int getFrozenColumnCount()
        Deprecated.
        Gets the number of frozen columns in this grid. 0 means that no data columns will be frozen, but the built-in selection checkbox column will still be frozen if it's in use. -1 means that not even the selection column is frozen.

        NOTE: this count includes hidden columns in the count.

        Returns:
        the number of frozen columns
        See Also:
        setFrozenColumnCount(int)

      • scrollTo

        public void scrollTo​(Object itemId,
                     ScrollDestination destination)
              throws IllegalArgumentException
        Deprecated.
        Scrolls to a certain item, using user-specified scroll destination.

        If the item has visible details, its size will also be taken into account.

        Parameters:
        itemId - id of item to scroll to.
        destination - value specifying desired position of scrolled-to row.
        Throws:
        IllegalArgumentException - if the provided id is not recognized by the data source.

      • scrollToStart

        public void scrollToStart()
        Deprecated.
        Scrolls to the beginning of the first data row.

      • scrollToEnd

        public void scrollToEnd()
        Deprecated.
        Scrolls to the end of the last data row.

      • setHeightByRows

        public void setHeightByRows​(double rows)
        Deprecated.
        Sets the number of rows that should be visible in Grid's body, while getHeightMode() is HeightMode.ROW.

        If Grid is currently not in HeightMode.ROW, the given value is remembered, and applied once the mode is applied.

        Parameters:
        rows - The height in terms of number of rows displayed in Grid's body. If Grid doesn't contain enough rows, white space is displayed instead. If null is given, then Grid's height is undefined
        Throws:
        IllegalArgumentException - if rows is zero or less
        IllegalArgumentException - if rows is infinite
        IllegalArgumentException - if rows is NaN

      • setHeightMode

        public void setHeightMode​(HeightMode heightMode)
        Deprecated.
        Defines the mode in which the Grid widget's height is calculated.

        If HeightMode.CSS is given, Grid will respect the values given via a setHeight-method, and behave as a traditional Component.

        If HeightMode.ROW is given, Grid will make sure that the body will display as many rows as getHeightByRows() defines. Note: If headers/footers are inserted or removed, the widget will resize itself to still display the required amount of rows in its body. It also takes the horizontal scrollbar into account.

        Parameters:
        heightMode - the mode in to which Grid should be set

      • getHeightMode

        public HeightMode getHeightMode()
        Deprecated.
        Returns the current HeightMode the Grid is in.

        Defaults to HeightMode.CSS.

        Returns:
        the current HeightMode

      • setSelectionModel

        public void setSelectionModel​(Grid.SelectionModel selectionModel)
                       throws IllegalArgumentException
        Deprecated.
        Takes a new Grid.SelectionModel into use.

        The SelectionModel that is previously in use will have all its items deselected. If any items were selected, this will fire a SelectionEvent.

        If the given SelectionModel is already in use, this method does nothing.

        Parameters:
        selectionModel - the new SelectionModel to use
        Throws:
        IllegalArgumentException - if selectionModel is null

      • setSelectionMode

        public Grid.SelectionModel setSelectionMode​(Grid.SelectionMode selectionMode)
                                     throws IllegalArgumentException
        Deprecated.
        Sets the Grid's selection mode.

        Grid supports three selection modes: multiselect, single select and no selection, and this is a convenience method for choosing between one of them.

        Technically, this method is a shortcut that can be used instead of calling setSelectionModel with a specific SelectionModel instance. Grid comes with three built-in SelectionModel classes, and the Grid.SelectionMode enum represents each of them.

        Essentially, the two following method calls are equivalent: 

        
 grid.setSelectionMode(SelectionMode.MULTI);
 grid.setSelectionModel(new MultiSelectionMode());
        Parameters:
        selectionMode - the selection mode to switch to
        Returns:
        The Grid.SelectionModel instance that was taken into use
        Throws:
        IllegalArgumentException - if selectionMode is null
        See Also:
        Grid.SelectionModel

      • isSelected

        public boolean isSelected​(Object itemId)
        Deprecated.
        Checks whether an item is selected or not.
        Parameters:
        itemId - the item id to check for
        Returns:
        true if the item is selected

      • getSelectedRows

        public Collection<Object> getSelectedRows()
        Deprecated.
        Returns a collection of all the currently selected itemIds.

        This method is a shorthand that delegates to the selection model.

        Returns:
        a collection of all the currently selected itemIds

      • getSelectedRow

        public Object getSelectedRow()
                      throws IllegalStateException
        Deprecated.
        Gets the item id of the currently selected item.

        This method is a shorthand that delegates to the selection model. Only SelectionModel.Single is supported.

        Returns:
        the item id of the currently selected item, or null if nothing is selected
        Throws:
        IllegalStateException - if the selection model does not implement SelectionModel.Single

      • deselectAll

        public boolean deselectAll()
                    throws IllegalStateException
        Deprecated.
        Marks all items as unselected.

        This method is a shorthand that delegates to the selection model. Only SelectionModel.Single and SelectionModel.Multi are supported.

        Returns:
        true if the selection state changed, false if the itemId was already selected
        Throws:
        IllegalStateException - if the deselection was illegal. One such reason might be that the implementation requires one or more items to be selected at all times.
        IllegalStateException - if the selection model does not implement SelectionModel.Single or {code SelectionModel.Multi}

      • fireSelectionEvent

        public void fireSelectionEvent​(Collection<Object> oldSelection,
                               Collection<Object> newSelection)
        Deprecated.
        Fires a selection change event.

        Note: This is not a method that should be called by application logic. This method is publicly accessible only so that SelectionModels would be able to inform Grid of these events.

        Parameters:
        newSelection - the selection that was added by this event
        oldSelection - the selection that was removed by this event

      • addColumnReorderListener

        public void addColumnReorderListener​(Grid.ColumnReorderListener listener)
        Deprecated.
        Registers a new column reorder listener.
        Parameters:
        listener - the listener to register
        Since:
        7.5.0

      • removeColumnReorderListener

        public void removeColumnReorderListener​(Grid.ColumnReorderListener listener)
        Deprecated.
        Removes a previously registered column reorder listener.
        Parameters:
        listener - the listener to remove
        Since:
        7.5.0

      • addColumnResizeListener

        public void addColumnResizeListener​(Grid.ColumnResizeListener listener)
        Deprecated.
        Registers a new column resize listener.
        Parameters:
        listener - the listener to register

      • removeColumnResizeListener

        public void removeColumnResizeListener​(Grid.ColumnResizeListener listener)
        Deprecated.
        Removes a previously registered column resize listener.
        Parameters:
        listener - the listener to remove

      • sort

        public void sort​(Sort s)
        Deprecated.
        Sets the current sort order using the fluid Sort API. Read the documentation for Sort for more information.

        Note: Sorting by a property that has no column in Grid will hide all possible sorting indicators.

        Parameters:
        s - a sort instance
        Throws:
        IllegalStateException - if container is not sortable (does not implement Container.Sortable)
        IllegalArgumentException - if trying to sort by non-existing property

      • sort

        public void sort​(Object propertyId)
        Deprecated.
        Sort this Grid in ascending order by a specified property.

        Note: Sorting by a property that has no column in Grid will hide all possible sorting indicators.

        Parameters:
        propertyId - a property ID
        Throws:
        IllegalStateException - if container is not sortable (does not implement Container.Sortable)
        IllegalArgumentException - if trying to sort by non-existing property

      • sort

        public void sort​(Object propertyId,
                 com.vaadin.shared.data.sort.SortDirection direction)
        Deprecated.
        Sort this Grid in user-specified SortOrder by a property.

        Note: Sorting by a property that has no column in Grid will hide all possible sorting indicators.

        Parameters:
        propertyId - a property ID
        direction - a sort order value (ascending/descending)
        Throws:
        IllegalStateException - if container is not sortable (does not implement Container.Sortable)
        IllegalArgumentException - if trying to sort by non-existing property

      • clearSortOrder

        public void clearSortOrder()
        Deprecated.
        Clear the current sort order, and re-sort the grid.

      • setSortOrder

        public void setSortOrder​(List<SortOrder> order)
        Deprecated.
        Sets the sort order to use.

        Note: Sorting by a property that has no column in Grid will hide all possible sorting indicators.

        Parameters:
        order - a sort order list.
        Throws:
        IllegalStateException - if container is not sortable (does not implement Container.Sortable)
        IllegalArgumentException - if order is null or trying to sort by non-existing property

      • getSortOrder

        public List<SortOrder> getSortOrder()
        Deprecated.
        Get the current sort order list.
        Returns:
        a sort order list

      • addSortListener

        public com.vaadin.shared.Registration addSortListener​(SortEvent.SortListener listener)
        Deprecated.
        Adds a sort order change listener that gets notified when the sort order changes.
        Specified by:
        addSortListener in interface SortEvent.SortNotifier
        Parameters:
        listener - the sort order change listener to add
        Returns:
        a registration object for removing the listener

      • getHeader

        protected Grid.Header getHeader()
        Deprecated.
        Returns the header section of this grid. The default header contains a single row displaying the column captions.
        Returns:
        the header

      • getHeaderRow

        public Grid.HeaderRow getHeaderRow​(int rowIndex)
        Deprecated.
        Gets the header row at given index.
        Parameters:
        rowIndex - 0 based index for row. Counted from top to bottom
        Returns:
        header row at given index
        Throws:
        IllegalArgumentException - if no row exists at given index

      • getDefaultHeaderRow

        public Grid.HeaderRow getDefaultHeaderRow()
        Deprecated.
        Returns the current default row of the header section. The default row is a special header row providing a user interface for sorting columns. Setting a header text for column updates cells in the default header.
        Returns:
        the default row or null if no default row set

      • getHeaderRowCount

        public int getHeaderRowCount()
        Deprecated.
        Gets the row count for the header section.
        Returns:
        row count

      • setDefaultHeaderRow

        public void setDefaultHeaderRow​(Grid.HeaderRow row)
        Deprecated.
        Sets the default row of the header. The default row is a special header row providing a user interface for sorting columns.
        Parameters:
        row - the new default row, or null for no default row
        Throws:
        IllegalArgumentException - header does not contain the row

      • setHeaderVisible

        public void setHeaderVisible​(boolean visible)
        Deprecated.
        Sets the visibility of the header section.
        Parameters:
        visible - true to show header section, false to hide

      • isHeaderVisible

        public boolean isHeaderVisible()
        Deprecated.
        Returns the visibility of the header section.
        Returns:
        true if visible, false otherwise.

      • getFooter

        protected Grid.Footer getFooter()
        Deprecated.
        Returns the footer section of this grid. The default header contains a single row displaying the column captions.
        Returns:
        the footer

      • getFooterRow

        public Grid.FooterRow getFooterRow​(int rowIndex)
        Deprecated.
        Gets the footer row at given index.
        Parameters:
        rowIndex - 0 based index for row. Counted from top to bottom
        Returns:
        footer row at given index
        Throws:
        IllegalArgumentException - if no row exists at given index

      • getFooterRowCount

        public int getFooterRowCount()
        Deprecated.
        Gets the row count for the footer.
        Returns:
        row count

      • setFooterVisible

        public void setFooterVisible​(boolean visible)
        Deprecated.
        Sets the visibility of the footer section.
        Parameters:
        visible - true to show footer section, false to hide

      • isFooterVisible

        public boolean isFooterVisible()
        Deprecated.
        Returns the visibility of the footer section.
        Returns:
        true if visible, false otherwise.

      • setCellDescriptionGenerator

        public void setCellDescriptionGenerator​(Grid.CellDescriptionGenerator generator,
                                        com.vaadin.shared.ui.ContentMode contentMode)
        Deprecated.
        Sets the CellDescriptionGenerator instance and content mode for generating optional descriptions (tooltips) for individual Grid cells. If a Grid.RowDescriptionGenerator is also set, the row description it generates is displayed for cells for which generator returns null.
        Parameters:
        generator - the description generator to use or null to remove a previously set generator if any
        contentMode - the content mode for cell tooltips, not null
        Since:
        8.3.2
        See Also:
        setRowDescriptionGenerator(RowDescriptionGenerator)

      • getCellDescriptionGenerator

        public Grid.CellDescriptionGenerator getCellDescriptionGenerator()
        Deprecated.
        Returns the CellDescriptionGenerator instance used to generate descriptions (tooltips) for Grid cells.
        Returns:
        the description generator or null if no generator is set
        Since:
        7.6

      • setRowDescriptionGenerator

        public void setRowDescriptionGenerator​(Grid.RowDescriptionGenerator generator,
                                       com.vaadin.shared.ui.ContentMode contentMode)
        Deprecated.
        Sets the RowDescriptionGenerator instance for generating optional descriptions (tooltips) for Grid rows. If a Grid.CellDescriptionGenerator is also set, the row description generated by generator is used for cells for which the cell description generator returns null.
        Parameters:
        generator - the description generator to use or null to remove a previously set generator if any
        contentMode - the content mode for row tooltips, not null
        Since:
        8.3.2
        See Also:
        setCellDescriptionGenerator(CellDescriptionGenerator)

      • getRowDescriptionGenerator

        public Grid.RowDescriptionGenerator getRowDescriptionGenerator()
        Deprecated.
        Returns the RowDescriptionGenerator instance used to generate descriptions (tooltips) for Grid rows.
        Returns:
        the description generator or null if no generator is set
        Since:
        7.6

      • setCellStyleGenerator

        public void setCellStyleGenerator​(Grid.CellStyleGenerator cellStyleGenerator)
        Deprecated.
        Sets the style generator that is used for generating styles for cells.
        Parameters:
        cellStyleGenerator - the cell style generator to set, or null to remove a previously set generator

      • getCellStyleGenerator

        public Grid.CellStyleGenerator getCellStyleGenerator()
        Deprecated.
        Gets the style generator that is used for generating styles for cells.
        Returns:
        the cell style generator, or null if no generator is set

      • setRowStyleGenerator

        public void setRowStyleGenerator​(Grid.RowStyleGenerator rowStyleGenerator)
        Deprecated.
        Sets the style generator that is used for generating styles for rows.
        Parameters:
        rowStyleGenerator - the row style generator to set, or null to remove a previously set generator

      • getRowStyleGenerator

        public Grid.RowStyleGenerator getRowStyleGenerator()
        Deprecated.
        Gets the style generator that is used for generating styles for rows.
        Returns:
        the row style generator, or null if no generator is set

      • addRow

        public Object addRow​(Object... values)
        Deprecated.
        Adds a row to the underlying container. The order of the parameters should match the current visible column order.

        Please note that it's generally only safe to use this method during initialization. After Grid has been initialized and the visible column order might have been changed, it's better to instead add items directly to the underlying container and use Item.getItemProperty(Object) to make sure each value is assigned to the intended property.

        Parameters:
        values - the cell values of the new row, in the same order as the visible column order, not null.
        Returns:
        the item id of the new row
        Throws:
        IllegalArgumentException - if values is null
        IllegalArgumentException - if its length does not match the number of visible columns
        IllegalArgumentException - if a parameter value is not an instance of the corresponding property type
        UnsupportedOperationException - if the container does not support adding new items

      • refreshRows

        public void refreshRows​(Object... itemIds)
        Deprecated.
        Refreshes, i.e. causes the client side to re-render the rows with the given item ids.

        Calling this for a row which is not currently rendered on the client side has no effect.

        Parameters:
        itemIds - the item id(s) of the row to refresh.

      • refreshAllRows

        public void refreshAllRows()
        Deprecated.
        Refreshes, i.e. causes the client side to re-render all rows.
        Since:
        7.7.7

      • setEditorEnabled

        public void setEditorEnabled​(boolean isEnabled)
                      throws IllegalStateException
        Deprecated.
        Sets whether or not the item editor UI is enabled for this grid. When the editor is enabled, the user can open it by double-clicking a row or hitting enter when a row is focused. The editor can also be opened programmatically using the editItem(Object) method.
        Parameters:
        isEnabled - true to enable the feature, false otherwise
        Throws:
        IllegalStateException - if an item is currently being edited
        See Also:
        getEditedItemId()

      • isEditorEnabled

        public boolean isEditorEnabled()
        Deprecated.
        Checks whether the item editor UI is enabled for this grid.
        Returns:
        true if the editor is enabled for this grid
        See Also:
        setEditorEnabled(boolean), getEditedItemId()

      • getEditedItemId

        public Object getEditedItemId()
        Deprecated.
        Gets the id of the item that is currently being edited.
        Returns:
        the id of the item that is currently being edited, or null if no item is being edited at the moment

      • getEditorFieldGroup

        public FieldGroup getEditorFieldGroup()
        Deprecated.
        Gets the field group that is backing the item editor of this grid.
        Returns:
        the backing field group

      • setEditorFieldGroup

        public void setEditorFieldGroup​(FieldGroup fieldGroup)
        Deprecated.
        Sets the field group that is backing the item editor of this grid.
        Parameters:
        fieldGroup - the backing field group
        Throws:
        IllegalStateException - if the editor is currently active

      • isEditorActive

        public boolean isEditorActive()
        Deprecated.
        Returns whether an item is currently being edited in the editor.
        Returns:
        true if the editor is open

      • doEditItem

        protected void doEditItem()
        Deprecated.

      • cancelEditor

        public void cancelEditor()
        Deprecated.
        Cancels the currently active edit if any. Hides the editor and discards possible unsaved changes in the editor fields.

      • doCancelEditor

        protected void doCancelEditor()
        Deprecated.

      • setEditorFieldFactory

        public void setEditorFieldFactory​(FieldGroupFieldFactory fieldFactory)
        Deprecated.
        Sets the field factory for the FieldGroup. The field factory is only used when FieldGroup creates a new field.

        Note: This is a pass-through call to the backing field group.

        Parameters:
        fieldFactory - The field factory to use

      • setEditorErrorHandler

        public void setEditorErrorHandler​(Grid.EditorErrorHandler editorErrorHandler)
                           throws IllegalArgumentException
        Deprecated.
        Sets the error handler for the editor. The error handler is called whenever there is an exception in the editor.
        Parameters:
        editorErrorHandler - The editor error handler to use
        Throws:
        IllegalArgumentException - if the error handler is null

      • getEditorFieldFactory

        public FieldGroupFieldFactory getEditorFieldFactory()
        Deprecated.
        Gets the field factory for the FieldGroup. The field factory is only used when FieldGroup creates a new field.

        Note: This is a pass-through call to the backing field group.

        Returns:
        The field factory in use

      • setEditorSaveCaption

        public void setEditorSaveCaption​(String saveCaption)
                          throws IllegalArgumentException
        Deprecated.
        Sets the caption on the save button in the Grid editor.
        Parameters:
        saveCaption - the caption to set
        Throws:
        IllegalArgumentException - if saveCaption is null

      • getEditorSaveCaption

        public String getEditorSaveCaption()
        Deprecated.
        Gets the current caption of the save button in the Grid editor.
        Returns:
        the current caption of the save button

      • setEditorCancelCaption

        public void setEditorCancelCaption​(String cancelCaption)
                            throws IllegalArgumentException
        Deprecated.
        Sets the caption on the cancel button in the Grid editor.
        Parameters:
        cancelCaption - the caption to set
        Throws:
        IllegalArgumentException - if cancelCaption is null

      • getEditorCancelCaption

        public String getEditorCancelCaption()
        Deprecated.
        Gets the current caption of the cancel button in the Grid editor.
        Returns:
        the current caption of the cancel button

      • setEditorBuffered

        public void setEditorBuffered​(boolean editorBuffered)
                       throws IllegalStateException
        Deprecated.
        Sets the buffered editor mode. The default mode is buffered ( true).
        Parameters:
        editorBuffered - true to enable buffered editor, false to disable it
        Throws:
        IllegalStateException - If editor is active while attempting to change the buffered mode.
        Since:
        7.6

      • isEditorBuffered

        public boolean isEditorBuffered()
        Deprecated.
        Gets the buffered editor mode.
        Returns:
        true if buffered editor is enabled, false otherwise
        Since:
        7.6

      • recalculateColumnWidths

        public void recalculateColumnWidths()
        Deprecated.
        Requests that the column widths should be recalculated.

        In most cases Grid will know when column widths need to be recalculated but this method can be used to force recalculation in situations when grid does not recalculate automatically.

        Since:
        7.4.1

      • addColumnVisibilityChangeListener

        public void addColumnVisibilityChangeListener​(Grid.ColumnVisibilityChangeListener listener)
        Deprecated.
        Registers a new column visibility change listener.
        Parameters:
        listener - the listener to register
        Since:
        7.5.0

      • removeColumnVisibilityChangeListener

        public void removeColumnVisibilityChangeListener​(Grid.ColumnVisibilityChangeListener listener)
        Deprecated.
        Removes a previously registered column visibility change listener.
        Parameters:
        listener - the listener to remove
        Since:
        7.5.0

      • setDetailsGenerator

        public void setDetailsGenerator​(Grid.DetailsGenerator detailsGenerator)
                         throws IllegalArgumentException
        Deprecated.
        Sets a new details generator for row details.

        The currently opened row details will be re-rendered.

        Parameters:
        detailsGenerator - the details generator to set
        Throws:
        IllegalArgumentException - if detailsGenerator is null;
        Since:
        7.5.0

      • getDetailsGenerator

        public Grid.DetailsGenerator getDetailsGenerator()
        Deprecated.
        Gets the current details generator for row details.
        Returns:
        the detailsGenerator the current details generator
        Since:
        7.5.0

      • setDetailsVisible

        public void setDetailsVisible​(Object itemId,
                              boolean visible)
        Deprecated.
        Shows or hides the details for a specific item.
        Parameters:
        itemId - the id of the item for which to set details visibility
        visible - true to show the details, or false to hide them
        Since:
        7.5.0

      • isDetailsVisible

        public boolean isDetailsVisible​(Object itemId)
        Deprecated.
        Checks whether details are visible for the given item.
        Parameters:
        itemId - the id of the item for which to check details visibility
        Returns:
        true if the details are visible
        Since:
        7.5.0