Class GridColumnState

  • All Implemented Interfaces:
    Serializable

    public class GridColumnState
    extends Object
    implements Serializable
    Column state DTO for transferring column properties from the server to the client.
    Since:
    7.4
    Author:
    Vaadin Ltd
    See Also:
    Serialized Form
    • Field Summary

      Fields 
      Modifier and Type Field Description
      boolean editable
      Whether the values in this column are editable when the editor interface is active.
      Connector editorConnector
      The connector for the field used to edit cells in this column when the editor interface is active.
      int expandRatio
      How much of the remaining space this column will reserve.
      String headerCaption
      Column header caption.
      boolean hidable
      Whether the column can be hidden by the user.
      boolean hidden
      Whether this column is currently hidden.
      String hidingToggleCaption
      The caption for the column hiding toggle.
      String id
      Id used by grid connector to map server side column with client side column.
      double maxWidth
      The maximum expansion width of this column. -1 for "no maximum".
      double minWidth
      The minimum expansion width of this column. -1 for "no minimum".
      Connector rendererConnector
      The connector for the renderer used to render the cells in this column.
      boolean resizable
      Whether this column is resizable by the user.
      boolean sortable
      Whether this column is sortable by the user.
      double width
      Column width in pixels.
    • Constructor Summary

      Constructors 
      Constructor Description
      GridColumnState()  
    • Field Detail

      • id

        public String id
        Id used by grid connector to map server side column with client side column.
      • width

        public double width
        Column width in pixels. Default column width is -1.0.
      • rendererConnector

        public Connector rendererConnector
        The connector for the renderer used to render the cells in this column.
      • editable

        public boolean editable
        Whether the values in this column are editable when the editor interface is active.
      • editorConnector

        public Connector editorConnector
        The connector for the field used to edit cells in this column when the editor interface is active.
      • sortable

        public boolean sortable
        Whether this column is sortable by the user.
      • expandRatio

        public int expandRatio
        How much of the remaining space this column will reserve.
      • maxWidth

        public double maxWidth
        The maximum expansion width of this column. -1 for "no maximum". If maxWidth is less than the calculated width, maxWidth is ignored.
      • minWidth

        public double minWidth
        The minimum expansion width of this column. -1 for "no minimum". If minWidth is less than the calculated width, minWidth will win.
      • hidden

        public boolean hidden
        Whether this column is currently hidden.
      • hidable

        public boolean hidable
        Whether the column can be hidden by the user.
      • hidingToggleCaption

        public String hidingToggleCaption
        The caption for the column hiding toggle.
      • headerCaption

        public String headerCaption
        Column header caption.
      • resizable

        public boolean resizable
        Whether this column is resizable by the user.
    • Constructor Detail

      • GridColumnState

        public GridColumnState()