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
|
/*
* Copyright 2000-2016 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.ui.renderers;
import java.time.LocalDateTime;
import java.time.format.DateTimeFormatter;
import java.time.format.FormatStyle;
import java.util.Locale;
import com.vaadin.shared.ui.grid.renderers.LocalDateTimeRendererState;
import elemental.json.JsonValue;
/**
* A renderer for presenting {@code LocalDateTime} objects.
*
* @author Vaadin Ltd
* @since 8.1
*/
public class LocalDateTimeRenderer
extends AbstractRenderer<Object, LocalDateTime> {
private DateTimeFormatter formatter;
private boolean getLocaleFromGrid;
/**
* Creates a new LocalDateTimeRenderer.
* <p>
* The renderer is configured to render with the grid's locale it is
* attached to, with the format style being {@code FormatStyle.LONG} for the
* date and {@code FormatStyle.SHORT} for time, with an empty string as its
* null representation.
*
* @see <a href=
* "https://docs.oracle.com/javase/8/docs/api/java/time/format/FormatStyle.html#LONG">
* FormatStyle.LONG</a>
* @see <a href=
* "https://docs.oracle.com/javase/8/docs/api/java/time/format/FormatStyle.html#SHORT">
* FormatStyle.SHORT</a>
*/
public LocalDateTimeRenderer() {
this(DateTimeFormatter.ofLocalizedDateTime(FormatStyle.LONG,
FormatStyle.SHORT), "");
getLocaleFromGrid = true;
}
/**
* Creates a new LocalDateTimeRenderer.
* <p>
* The renderer is configured to render with the given formatter, with the
* empty string as its null representation.
*
* @param formatter
* the formatter to use, not {@code null}
*
* @throws IllegalArgumentException
* if formatter is null
*/
public LocalDateTimeRenderer(DateTimeFormatter formatter) {
this(formatter, "");
}
/**
* Creates a new LocalDateTimeRenderer.
* <p>
* The renderer is configured to render with the given formatter.
*
* @param formatter
* the formatter to use, not {@code null}
* @param nullRepresentation
* the textual representation of the {@code null} value
*
* @throws IllegalArgumentException
* if formatter is null
*/
public LocalDateTimeRenderer(DateTimeFormatter formatter, String nullRepresentation) {
super(LocalDateTime.class, nullRepresentation);
if (formatter == null) {
throw new IllegalArgumentException("formatter may not be null");
}
this.formatter = formatter;
}
/**
* Creates a new LocalDateTimeRenderer.
* <p>
* The renderer is configured to render with the given string format, as
* displayed in the grid's locale it is attached to, with an empty string as
* its null representation.
*
* @param formatPattern
* the format pattern to format the date with, not {@code null}
*
* @throws IllegalArgumentException
* if format pattern is null
*
* @see <a href=
* "https://docs.oracle.com/javase/8/docs/api/java/time/format/DateTimeFormatter.html#patterns">
* Format Pattern Syntax</a>
*/
public LocalDateTimeRenderer(String formatPattern) {
this(formatPattern, Locale.getDefault());
getLocaleFromGrid = true;
}
/**
* Creates a new LocalDateTimeRenderer.
* <p>
* The renderer is configured to render with the given string format, as
* displayed in the given locale, with an empty string as its null
* representation.
*
* @param formatPattern
* the format pattern to format the date with, not {@code null}
* @param locale
* the locale to use, not {@code null}
* @param nullRepresentation
* the textual representation of the {@code null} value
*
* @throws IllegalArgumentException
* if format pattern is null
* @throws IllegalArgumentException
* if locale is null
*
* @see <a href=
* "https://docs.oracle.com/javase/8/docs/api/java/time/format/DateTimeFormatter.html#patterns">
* Format Pattern Syntax</a>
*/
public LocalDateTimeRenderer(String formatPattern, Locale locale) {
this(formatPattern, locale, "");
}
/**
* Creates a new LocalDateTimeRenderer.
* <p>
* The renderer is configured to render with the given string format, as
* displayed in the given locale.
*
* @param formatPattern
* the format pattern to format the date with, not {@code null}
* @param locale
* the locale to use, not {@code null}
* @param nullRepresentation
* the textual representation of the {@code null} value
*
* @throws IllegalArgumentException
* if format pattern is null
* @throws IllegalArgumentException
* if locale is null
*
* @see <a href=
* "https://docs.oracle.com/javase/8/docs/api/java/time/format/DateTimeFormatter.html#patterns">
* Format Pattern Syntax</a>
*/
public LocalDateTimeRenderer(String formatPattern, Locale locale,
String nullRepresentation) {
super(LocalDateTime.class, nullRepresentation);
if (formatPattern == null) {
throw new IllegalArgumentException(
"format pattern may not be null");
}
if (locale == null) {
throw new IllegalArgumentException("locale may not be null");
}
formatter = DateTimeFormatter.ofPattern(formatPattern, locale);
}
@Override
public JsonValue encode(LocalDateTime value) {
String dateString;
if (value == null) {
dateString = getNullRepresentation();
} else if (getLocaleFromGrid) {
if (getParentGrid() == null) {
throw new IllegalStateException(
"Could not find a locale to format with: "
+ "this renderer should either be attached to a grid "
+ "or constructed with locale information");
}
dateString = value
.format(formatter.withLocale(getParentGrid().getLocale()));
} else {
dateString = value.format(formatter);
}
return encode(dateString, String.class);
}
@Override
protected LocalDateTimeRendererState getState() {
return (LocalDateTimeRendererState) super.getState();
}
@Override
protected LocalDateTimeRendererState getState(boolean markAsDirty) {
return (LocalDateTimeRendererState) super.getState(markAsDirty);
}
}
|
