com.vaadin.v7.shared.ui.grid.GridState Maven / Gradle / Ivy
/*
* Copyright (C) 2000-2024 Vaadin Ltd
*
* This program is available under Vaadin Commercial License and Service Terms.
*
* See for the full
* license.
*/
package com.vaadin.v7.shared.ui.grid;
import java.util.ArrayList;
import java.util.List;
import com.vaadin.shared.annotations.DelegateToWidget;
import com.vaadin.shared.data.sort.SortDirection;
import com.vaadin.shared.ui.ContentMode;
import com.vaadin.shared.ui.TabIndexState;
/**
* The shared state for the {@link com.vaadin.ui.components.grid.Grid}
* component.
*
* @since 7.4
* @author Vaadin Ltd
*/
public class GridState extends TabIndexState {
/**
* A description of which of the three bundled SelectionModels is currently
* in use.
*
* Used as a data transfer object instead of the client/server ones, because
* they don't know about each others classes.
*
* @see com.vaadin.ui.components.grid.Grid.SelectionMode
* @see com.vaadin.client.ui.grid.Grid.SelectionMode
*/
public enum SharedSelectionMode {
/**
* Representation of a single selection mode.
*
* @see com.vaadin.ui.components.grid.Grid.SelectionMode#SINGLE
* @see com.vaadin.client.ui.grid.Grid.SelectionMode#SINGLE
*/
SINGLE,
/**
* Representation of a multiselection mode.
*
* @see com.vaadin.ui.components.grid.Grid.SelectionMode#MULTI
* @see com.vaadin.client.ui.grid.Grid.SelectionMode#MULTI
*/
MULTI,
/**
* Representation of a no-selection mode.
*
* @see com.vaadin.ui.components.grid.Grid.SelectionMode#NONE
* @see com.vaadin.client.ui.grid.Grid.SelectionMode#NONE
*/
NONE;
}
/**
* The default value for height-by-rows for both GWT widgets
* {@link com.vaadin.ui.components.grid Grid} and
* {@link com.vaadin.client.ui.grid.Escalator Escalator}.
*/
public static final double DEFAULT_HEIGHT_BY_ROWS = 10.0d;
/**
* The key in which a row's data can be found.
*
* @see com.vaadin.shared.data.DataProviderRpc#setRowData(int, String)
*/
public static final String JSONKEY_DATA = "d";
/**
* The key in which a row's own key can be found.
*
* @see com.vaadin.shared.data.DataProviderRpc#setRowData(int, String)
*/
public static final String JSONKEY_ROWKEY = "k";
/**
* The key in which a row's generated style can be found.
*
* @see com.vaadin.shared.data.DataProviderRpc#setRowData(int, String)
*/
public static final String JSONKEY_ROWSTYLE = "rs";
/**
* The key in which a generated styles for a row's cells can be found.
*
* @see com.vaadin.shared.data.DataProviderRpc#setRowData(int, String)
*/
public static final String JSONKEY_CELLSTYLES = "cs";
/**
* The key in which a row's description can be found.
*
* @since 7.6
* @see com.vaadin.shared.data.DataProviderRpc#setRowData(int, String)
*/
public static final String JSONKEY_ROWDESCRIPTION = "rd";
/**
* The key in which a cell's description can be found.
*
* @since 7.6
* @see com.vaadin.shared.data.DataProviderRpc#setRowData(int, String)
*/
public static final String JSONKEY_CELLDESCRIPTION = "cd";
/**
* The key that tells whether details are visible for the row.
*
* @since 7.5.0
*
* @see com.vaadin.ui.Grid#setDetailsGenerator(com.vaadin.ui.Grid.DetailsGenerator)
* @see com.vaadin.ui.Grid#setDetailsVisible(Object, boolean)
* @see com.vaadin.shared.data.DataProviderRpc#setRowData(int,
* elemental.json.JsonArray)
*/
public static final String JSONKEY_DETAILS_VISIBLE = "dv";
/**
* The key that tells whether row is selected.
*
* @since 7.6
*/
public static final String JSONKEY_SELECTED = "s";
{
primaryStyleName = "v-grid";
}
/**
* Column resize mode in grid.
*
* @since 7.7.5
*/
public ColumnResizeMode columnResizeMode = ColumnResizeMode.ANIMATED;
/**
* Columns in grid.
*/
public List columns = new ArrayList();
/**
* Column order in grid.
*/
public List columnOrder = new ArrayList();
public GridStaticSectionState header = new GridStaticSectionState();
public GridStaticSectionState footer = new GridStaticSectionState();
/** The number of frozen columns. */
public int frozenColumnCount = 0;
/** The height of the Grid in terms of body rows. */
@DelegateToWidget
public double heightByRows = DEFAULT_HEIGHT_BY_ROWS;
/** The mode by which Grid defines its height. */
@DelegateToWidget
public HeightMode heightMode = HeightMode.CSS;
/** Keys of the currently sorted columns. */
public String[] sortColumns = new String[0];
/** Directions for each sorted column. */
public SortDirection[] sortDirs = new SortDirection[0];
/** The enabled state of the editor interface. */
public boolean editorEnabled = false;
/**
* Buffered editor mode.
*
* @since 7.6
*/
@DelegateToWidget
public boolean editorBuffered = true;
/**
* Whether rows and/or cells have generated descriptions (tooltips).
*
* @since 7.6
*/
public boolean hasDescriptions;
/** The caption for the save button in the editor. */
@DelegateToWidget
public String editorSaveCaption = GridConstants.DEFAULT_SAVE_CAPTION;
/** The caption for the cancel button in the editor. */
@DelegateToWidget
public String editorCancelCaption = GridConstants.DEFAULT_CANCEL_CAPTION;
/** Whether the columns can be reordered. */
@DelegateToWidget
public boolean columnReorderingAllowed;
/**
* The content mode used for cell tooltips.
*
* @since 8.3.2
*/
public ContentMode cellTooltipContentMode = ContentMode.PREFORMATTED;
/**
* The content mode used for row tooltips.
*
* @since 8.3.2
*/
public ContentMode rowTooltipContentMode = ContentMode.PREFORMATTED;
/**
* Is the Grid read-only or not.
*
* @since 8.23
*/
public boolean readOnly = false;
}