-
Notifications
You must be signed in to change notification settings - Fork 6
/
textbox_date.go
267 lines (234 loc) · 7.71 KB
/
textbox_date.go
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
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
package control
import (
"context"
"encoding/gob"
"strings"
"time"
time2 "github.com/goradd/goradd/pkg/time"
"github.com/goradd/goradd/pkg/page"
)
type DateTextboxI interface {
TextboxI
SetFormats(formats []string) DateTextboxI
Date() time.Time
Formats() []string
}
// DateTextbox is a textbox that only permits dates and/or times to be entered into it.
//
// Dates and times will be converted to Browser local time.
type DateTextbox struct {
Textbox
formats []string // Variety of formats it will accept. Same as what time.format expects.
time time.Time // Converting from text to a datetime is expensive.
// We maintain a copy of the conversion to prevent duplication of effort.
}
// NewDateTextbox creates a new DateTextbox.
func NewDateTextbox(parent page.ControlI, id string) *DateTextbox {
d := &DateTextbox{}
d.Self = d
d.Init(parent, id)
return d
}
// Init initializes the control.
func (d *DateTextbox) Init(parent page.ControlI, id string) {
d.Textbox.Init(parent, id)
d.ValidateWith(DateValidator{})
d.formats = []string{time2.UsDateTime}
}
// SetFormats sets the format of the text allowed. The format is any allowable format
// that datetime or time can convert.
func (d *DateTextbox) SetFormats(formats []string) DateTextboxI {
d.formats = formats
return d
}
// Formats returns the format string specified previously
func (d *DateTextbox) Formats() []string {
return d.formats
}
// SetValue will set the DateTextbox to the given value if possible.
func (d *DateTextbox) SetValue(val interface{}) page.ControlI {
switch v := val.(type) {
case string:
d.SetText(v)
case time.Time:
d.SetDate(v.UTC())
}
return d
}
func (d *DateTextbox) layouts() []string {
return d.formats
}
func (d *DateTextbox) parseDate(ctx context.Context, s string) (result time.Time, layoutUsed string, err error) {
var grctx *page.Context
if ctx != nil {
grctx = page.GetContext(ctx)
}
for _, layoutUsed = range d.layouts() {
if grctx != nil && time2.LayoutHasDate(layoutUsed) && time2.LayoutHasTime(layoutUsed) {
result, err = time2.ParseInOffset(layoutUsed, s, grctx.ClientTimezone(), grctx.ClientTimezoneOffset())
} else {
result, err = time2.ParseForgiving(layoutUsed, s)
}
if err == nil {
break
}
}
return
}
// SetText sets the DateTime to the given text. If you attempt set the text to something that is not
// convertible to a date, an empty string will be entered. The resulting datetime will be in UTC time.
// Use SetDate if you want to make sure the date is in a certain timezone.
func (d *DateTextbox) SetText(s string) page.ControlI {
v, layout, err := d.parseDate(nil, s)
if err == nil {
d.Textbox.SetText(v.Format(layout))
d.time = v
} else {
d.Textbox.SetText("")
d.time = time.Time{}
}
return d
}
// SetDate will set the textbox to the give time
func (d *DateTextbox) SetDate(t time.Time) {
s := t.Format(d.layouts()[0])
d.Textbox.SetText(s)
d.time = t
}
// Value returns the value as an interface, but the underlying value will be a datetime.
// If a bad value was entered into the textbox, it will return an empty datetime.
func (d *DateTextbox) Value() interface{} {
return d.time
}
// Date returns the value as a DateTime value based on the format.
// If a bad value was entered into the textbox, it will return an empty datetime.
func (d *DateTextbox) Date() time.Time {
return d.time
}
func (d *DateTextbox) UpdateFormValues(ctx context.Context) {
d.Textbox.UpdateFormValues(ctx)
if d.readonly {
// This would happen if someone was attempting to hack the browser.
return
}
if _, ok := page.GetContext(ctx).FormValue(d.ID()); !ok {
return
}
t := d.Text()
if t == "" {
d.time = time.Time{}
return
}
v, layout, err := d.parseDate(ctx, t)
if err == nil {
d.Textbox.SetText(v.Format(layout))
d.time = v
} else {
d.time = time.Time{} // set to zero value to indicate an error
}
}
// Serialize encodes the control into the pagestate
func (d *DateTextbox) Serialize(e page.Encoder) {
d.Textbox.Serialize(e)
if err := e.Encode(d.formats); err != nil {
panic(err)
}
if err := e.Encode(d.time); err != nil {
panic(err)
}
}
// Deserialize recreates the control from the pagestate
func (d *DateTextbox) Deserialize(dec page.Decoder) {
d.Textbox.Deserialize(dec)
if err := dec.Decode(&d.formats); err != nil {
panic(err)
}
if err := dec.Decode(&d.time); err != nil {
panic(err)
}
}
// DateValidator specifies the message to show when the date is not validated.
type DateValidator struct {
Message string
}
// Validate is called by the framework to validate the control.
func (v DateValidator) Validate(c page.ControlI, s string) (msg string) {
if s == "" {
return "" // empty string is valid
}
// By the time the validator fires, we will have already parsed and validated the value.
// We just need to check to see if we were successful.
ctrl := c.(DateTextboxI)
if ctrl.Date().IsZero() {
if v.Message == "" {
return c.GT("Enter one of these formats: ") + strings.Join(ctrl.Formats(), ", ")
} else {
return v.Message
}
}
return
}
// DateTextboxCreator creates an date textbox.
// Pass it to AddControls of a control, or as a Child of
// a FormFieldWrapper.
type DateTextboxCreator struct {
// ID is the control id of the html widget and must be unique to the page
ID string
// Placeholder is the placeholder attribute of the textbox and shows as help text inside the field
Placeholder string
// Type is the type attribute of the textbox
Type string
// MinLength is the minimum number of characters that the user is required to enter. If the
// length is less than this number, a validation error will be shown.
MinLength int
// MaxLength is the maximum number of characters that the user is required to enter. If the
// length is more than this number, a validation error will be shown.
MaxLength int
// ColumnCount is the number of characters wide the textbox will be, and becomes the width attribute in the tag.
// The actual width is browser dependent. For better control, use a width style property.
ColumnCount int
// ReadOnly sets the readonly attribute of the textbox, which prevents it from being changed by the user.
ReadOnly bool
// SaveState will save the text in the textbox, to be restored if the user comes back to the page.
// It is particularly helpful when the textbox is being used to filter the results of a query, so that
// when the user comes back to the page, he does not have to type the filter text again.
SaveState bool
// Text is the initial value of the textbox. Often its best to load the value in a separate Load step after creating the control.
Text string
// Formats is the time.format strings to use to decode the text into a date or to display the date. By default it is datetime.UsDateTime.
Formats []string
page.ControlOptions
}
// Create creates a new control from the creator.
func (c DateTextboxCreator) Create(ctx context.Context, parent page.ControlI) page.ControlI {
ctrl := NewDateTextbox(parent, c.ID)
c.Init(ctx, ctrl)
return ctrl
}
// Init initializes the creator.
func (c DateTextboxCreator) Init(ctx context.Context, ctrl DateTextboxI) {
if c.Formats != nil {
ctrl.SetFormats(c.Formats)
}
// Reuse subclass
sub := TextboxCreator{
Placeholder: c.Placeholder,
MinLength: c.MinLength,
MaxLength: c.MaxLength,
Type: c.Type,
ColumnCount: c.ColumnCount,
ReadOnly: c.ReadOnly,
ControlOptions: c.ControlOptions,
SaveState: c.SaveState,
Text: c.Text,
}
sub.Init(ctx, ctrl)
}
// GetDateTextbox is a convenience method to return the control with the given id from the page.
func GetDateTextbox(c page.ControlI, id string) *DateTextbox {
return c.Page().GetControl(id).(*DateTextbox)
}
func init() {
gob.Register(DateValidator{})
page.RegisterControl(&DateTextbox{})
}