1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
|
/*
* Copyright 2000-2022 Vaadin Ltd.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the 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.
* <p>
* 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<GridColumnState> columns = new ArrayList<GridColumnState>();
/**
* Column order in grid.
*/
public List<String> columnOrder = new ArrayList<String>();
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;
}
|
