-
Notifications
You must be signed in to change notification settings - Fork 6
/
table.go
944 lines (829 loc) · 28.2 KB
/
table.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
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
package control
import (
"bytes"
"context"
"fmt"
"github.com/goradd/gengen/pkg/maps"
"github.com/goradd/goradd/pkg/html"
"github.com/goradd/goradd/pkg/log"
"github.com/goradd/goradd/pkg/page"
"github.com/goradd/goradd/pkg/page/action"
"github.com/goradd/goradd/pkg/page/event"
"github.com/goradd/goradd/pkg/pool"
html2 "html"
"reflect"
"strconv"
)
const (
ColumnAction = iota + 2000
SortClick
)
// TableI is the table interface that lets you create a "subclass" of the Table object.
// The functions defined here are hooks that you can implement in your subclass.
type TableI interface {
page.ControlI
TableEmbedder
DataManagerEmbedder
}
// TableEmbedder is a workaround for a problem in GO interfaces. See https://github.com/golang/go/issues/6977
type TableEmbedder interface {
SetCaption(interface{}) TableI
DrawCaption(context.Context, *bytes.Buffer) error
GetHeaderRowAttributes(row int) html.Attributes
GetFooterRowAttributes(row int) html.Attributes
GetRowAttributes(row int, data interface{}) html.Attributes
HeaderCellDrawingInfo(ctx context.Context, col ColumnI, rowNum int, colNum int) (cellHtml string, cellAttributes html.Attributes)
FooterCellDrawingInfo(ctx context.Context, col ColumnI, rowNum int, colNum int) (cellHtml string, cellAttributes html.Attributes)
SetHideIfEmpty(h bool) TableI
SetHeaderRowCount(count int) TableI
SetFooterRowCount(count int) TableI
SetRowStyler(a TableRowAttributer) TableI
SetHeaderRowStyler(a TableHeaderRowAttributer) TableI
SetFooterRowStyler(a TableFooterRowAttributer) TableI
AddColumnAt(column ColumnI, loc int)
AddColumn(column ColumnI) ColumnI
GetColumn(loc int) ColumnI
GetColumnByID(id string) ColumnI
GetColumnByTitle(title string) ColumnI
RemoveColumn(loc int)
RemoveColumnByID(id string)
RemoveColumnByTitle(title string)
ClearColumns()
HideColumns()
ShowColumns()
MakeSortable() TableI
SetSortHistoryLimit(n int) TableI
}
// TableRowAttributer is used to style particular table rows.
type TableRowAttributer interface {
// TableRowAttributes returns attributes that should be used on the particular row indicated.
// Data is the data for that row.
TableRowAttributes(row int, data interface{}) html.Attributes
}
type TableHeaderRowAttributer interface {
// TableHeaderRowAttributes returns attributes to use for the particular header row indicated
TableHeaderRowAttributes(row int) html.Attributes
}
type TableFooterRowAttributer interface {
// TableFooterRowAttributes returns attributes to use for the particular footer row indicated
TableFooterRowAttributes(row int) html.Attributes
}
// Table is a goradd control that outputs a dynamic HTML table object, with table, tr, th and td tags,
// as well as optional col, thead, and tfoot tags.
//
// To use a Table, call NewTable and then add column objects to it. The columns use a CellTexter to draw the contents of
// a cell in the table. There are a number of predefined columns to draw text coming from slices of maps, slices, database objects,
// as well as custom functions you define. See the examples directory for examples of using a Table object.
// See also the PagedTable for a table that works with a Pager object to page through a large data set.
//
// Call MakeSortable() to make a table sortable, in which case the user can click in the header of a column to sort
// by that column. The Table maintains a history of what columns have been sorted by what row, so that you can
// implement multi-level sorting if you so desire. This is particularly helpful when some columns have duplicate
// data, that then get further identified by another column.
//
// You can provide data to the table when it is first created by calling SetData,
// or you can provide the data just before drawing by calling SetDataProvider at initialization of the table, and
// then providing the table data in response to the BindData function. The advantage of this approach is that if
// you are showing a lot of data, the data is only loaded in memory during drawing, and not kept in the pagestate
// after drawing.
type Table struct {
page.ControlBase
DataManager
columns []ColumnI
caption interface{}
hideIfEmpty bool
headerRowCount int
footerRowCount int
currentHeaderRowIndex int //??
currentRowIndex int //??
rowStyler TableRowAttributer
headerRowStyler TableHeaderRowAttributer
footerRowStyler TableFooterRowAttributer
columnIdCounter int
// Sort info. Sorting is difficult enough, and intertwined with tables enough, that we just make it built in to every column
sortColumns []string // keeps a historical list of columns sorted on
sortHistoryLimit int // how far back to go
// serialization helpers
captionId string
rowStylerId string
headerRowStylerId string
footerRowStylerId string
}
// NewTable creates a new table
func NewTable(parent page.ControlI, id string) *Table {
t := &Table{}
t.Self = t
t.Init(parent, id)
return t
}
// Init is an internal function that enables the object-oriented pattern of calling virtual functions used by the
// goradd controls. You would only call this if you were implementing a "subclass" of the Table. Call it immediately after
// creating your Table structure, passing the newly created table as "self".
func (t *Table) Init(parent page.ControlI, id string) {
t.ControlBase.Init(parent, id)
t.Tag = "table"
t.columns = []ColumnI{}
t.sortHistoryLimit = 1
}
// this returns the TableI interface for calling into "virtual" functions. This allows us to call functions defined
// by a subclass.
func (t *Table) this() TableI {
return t.Self.(TableI)
}
func (t *Table) SetHideIfEmpty(h bool) TableI {
if t.hideIfEmpty != h {
t.hideIfEmpty = h
t.Refresh()
}
return t.this()
}
// MakeSortable makes a table sortable. It will attach sortable events and show the header if its not shown.
func (t *Table) MakeSortable() TableI {
t.On(event.TableSort().Private(), action.Ajax(t.ID(), SortClick))
if t.headerRowCount == 0 {
t.headerRowCount = 1
}
return t.this()
}
// SetCaption sets the caption of the table. The default Table permits a caption to be either a string, or
// a goradd control.
func (t *Table) SetCaption(caption interface{}) TableI {
t.caption = caption
return t.this()
}
// SetHeaderRowCount sets the number of header rows shown. Each column will be asked to draw this number of header rows.
func (t *Table) SetHeaderRowCount(count int) TableI {
t.headerRowCount = count
return t.this()
}
// SetFooterRowCount sets the number of footer rows shown. Each column will be asked to draw this number of footer rows.
func (t *Table) SetFooterRowCount(count int) TableI {
t.footerRowCount = count
return t.this()
}
// DrawTag is called by the framework to draw the table. The Table overrides this to call into the DataProvider
// to load the table's data into memory just before drawing. The data will be unloaded after drawing.
func (t *Table) DrawTag(ctx context.Context) string {
log.FrameworkDebug("Drawing table tag")
if t.HasDataProvider() {
log.FrameworkDebug("Getting table data")
t.LoadData(ctx, t.this())
defer t.ResetData()
}
if t.hideIfEmpty && !t.HasData() {
return ""
}
for _, c := range t.columns {
c.PreRender()
}
return t.ControlBase.DrawTag(ctx)
}
// DrawingAttributes is an override to add attributes to the table, including not showing the table at all if there
// is no data to show. This will hide header and footer cells and potentially the outline of the table when there is no
// data in the table.
func (t *Table) DrawingAttributes(ctx context.Context) html.Attributes {
a := t.ControlBase.DrawingAttributes(ctx)
a.SetDataAttribute("grctl", "table")
if !t.HasData() && t.hideIfEmpty {
a.SetStyle("display", "none")
}
return a
}
// DrawInnerHtml is an override to draw the meat of the table.
func (t *Table) DrawInnerHtml(ctx context.Context, buf *bytes.Buffer) (err error) {
var t2 = t.this() // Get the sub class so we call into its hooks for drawing
buf1 := pool.GetBuffer()
defer pool.PutBuffer(buf1)
buf2 := pool.GetBuffer()
defer pool.PutBuffer(buf2)
defer func() { buf.WriteString(buf1.String()) }() // Make sure we write out the content of buf 1 even on an error
if err = t2.DrawCaption(ctx, buf1); err != nil {
return
}
if err = t.drawColumnTags(ctx, buf1); err != nil {
return
}
if t.headerRowCount > 0 {
err = t.drawHeaderRows(ctx, buf2)
buf1.WriteString(html.RenderTag("thead", nil, buf2.String()))
if err != nil {
return
}
buf2.Reset()
}
if t.footerRowCount > 0 {
err = t.drawFooterRows(ctx, buf2)
buf1.WriteString(html.RenderTag("tfoot", nil, buf2.String()))
if err != nil {
return
}
buf2.Reset()
}
t.RangeData(func(index int, value interface{}) bool {
err = t.drawRow(ctx, index, value, buf2)
if err != nil {
return false
}
return true
})
if err != nil {
return
}
buf1.WriteString(html.RenderTag("tbody", nil, buf2.String()))
return nil
}
// DrawCaption is called internally to draw the caption. Subclasses can override this to draw a custom caption.
func (t *Table) DrawCaption(ctx context.Context, buf *bytes.Buffer) (err error) {
switch obj := t.caption.(type) {
case string:
buf.WriteString(fmt.Sprintf("<caption>%s</caption>\n", html2.EscapeString(obj)))
case page.ControlI:
buf.WriteString("<caption>")
err = obj.Draw(ctx, buf)
if err != nil {
buf.WriteString("</caption>\n")
}
}
return
}
func (t *Table) drawColumnTags(ctx context.Context, buf *bytes.Buffer) (err error) {
var colNum int
var colCount = len(t.columns)
for colNum < colCount {
col := t.columns[colNum]
if !col.IsHidden() {
col.DrawColumnTag(ctx, buf)
}
colNum += col.Span()
}
return
}
func (t *Table) drawHeaderRows(ctx context.Context, buf *bytes.Buffer) (err error) {
var this = t.this() // Get the sub class so we call into its hooks for drawing
buf1 := pool.GetBuffer()
defer pool.PutBuffer(buf1)
for rowNum := 0; rowNum < t.headerRowCount; rowNum++ {
for colNum, col := range t.columns {
if !col.IsHidden() {
cellHtml, attr := this.HeaderCellDrawingInfo(ctx, col, rowNum, colNum)
buf1.WriteString(html.RenderTag("th", attr, cellHtml))
}
}
buf.WriteString(html.RenderTag("tr", t.GetHeaderRowAttributes(rowNum), buf1.String()))
buf1.Reset()
}
return
}
// HeaderCellDrawingInfo is called internally to provide the info for each header cell drawn. Subclasses can
// override this.
func (t *Table) HeaderCellDrawingInfo(ctx context.Context, col ColumnI, rowNum int, colNum int) (cellHtml string, cellAttributes html.Attributes) {
cellHtml = col.HeaderCellHtml(ctx, rowNum, colNum)
cellAttributes = col.HeaderAttributes(ctx, rowNum, colNum)
return
}
// FooterCellDrawingInfo is called internally to provide the info for each header cell drawn. Subclasses can
// override this.
func (t *Table) FooterCellDrawingInfo(ctx context.Context, col ColumnI, rowNum int, colNum int) (cellHtml string, cellAttributes html.Attributes) {
cellHtml = col.FooterCellHtml(ctx, rowNum, colNum)
cellAttributes = col.FooterAttributes(ctx, rowNum, colNum)
return
}
// GetHeaderRowAttributes is called internally to get the attributes for the tr tags in header rows.
func (t *Table) GetHeaderRowAttributes(row int) html.Attributes {
if t.headerRowStyler != nil {
return t.headerRowStyler.TableHeaderRowAttributes(row)
}
return nil
}
func (t *Table) drawFooterRows(ctx context.Context, buf *bytes.Buffer) (err error) {
var this = t.this() // Get the sub class so we call into its hooks for drawing
buf1 := pool.GetBuffer()
defer pool.PutBuffer(buf1)
for rowNum := 0; rowNum < t.footerRowCount; rowNum++ {
for colNum, col := range t.columns {
if !col.IsHidden() {
cellHtml, attr := this.FooterCellDrawingInfo(ctx, col, rowNum, colNum)
tag := "td"
if col.AsHeader() {
tag = "th"
}
buf1.WriteString(html.RenderTag(tag, attr, cellHtml))
}
}
buf.WriteString(html.RenderTag("tr", t.GetFooterRowAttributes(rowNum), buf1.String()))
buf1.Reset()
}
return
}
// GetFooterRowAttributes is called internally to get the attributes for the tr tags in footer rows.
func (t *Table) GetFooterRowAttributes(row int) html.Attributes {
if t.footerRowStyler != nil {
return t.footerRowStyler.TableFooterRowAttributes(row)
}
return nil
}
func (t *Table) drawRow(ctx context.Context, row int, data interface{}, buf *bytes.Buffer) (err error) {
var this = t.this() // Get the sub class so we call into its hooks for drawing
buf1 := pool.GetBuffer()
defer pool.PutBuffer(buf1)
for i, col := range t.columns {
col.DrawCell(ctx, row, i, data, buf1)
}
buf.WriteString(html.RenderTag("tr", this.GetRowAttributes(row, data), buf1.String()))
return
}
// GetRowAttributes is used internally to return the attributes for the tr tag of a data row.
func (t *Table) GetRowAttributes(row int, data interface{}) html.Attributes {
if t.rowStyler != nil {
return t.rowStyler.TableRowAttributes(row, data)
}
return nil
}
// AddColumnAt adds the given column at the column offset given. 0 is the first column location.
// Pass a negative number or a number bigger than the current number of columns to put it at the end.
func (t *Table) AddColumnAt(column ColumnI, loc int) {
t.columnIdCounter++
column.setParentTable(t)
if column.ID() == "" {
column.SetID(strconv.Itoa(t.columnIdCounter))
}
if loc < 0 || loc >= len(t.columns) {
t.columns = append(t.columns, column)
} else {
t.columns = append(t.columns, nil)
copy(t.columns[loc+1:], t.columns[loc:])
t.columns[loc] = column
}
column.AddActions(t)
t.Refresh()
}
// AddColumn adds the given column to the end of the column list.
func (t *Table) AddColumn(column ColumnI) ColumnI {
t.AddColumnAt(column, -1)
return column
}
// GetColumn returns the column at the given location
func (t *Table) GetColumn(loc int) ColumnI {
return t.columns[loc]
}
// GetColumnByID returns the column with the given id.
func (t *Table) GetColumnByID(id string) ColumnI {
for _, col := range t.columns {
if col.ID() == id {
return col
}
}
return nil
}
// GetColumnByTitle returns the column with the given title.
func (t *Table) GetColumnByTitle(title string) ColumnI {
for _, col := range t.columns {
if col.Title() == title {
return col
}
}
return nil
}
// RemoveColumn removes the column at the given location.
// If you attempt to remove a column that does not exist, it will panic.
func (t *Table) RemoveColumn(loc int) {
copy(t.columns[loc:], t.columns[loc+1:])
t.columns[len(t.columns)-1] = nil // or the zero value of T
t.columns = t.columns[:len(t.columns)-1]
t.Refresh()
}
// RemoveColumnByID removes the column with the given id. If the column does not exist, nothing will change.
func (t *Table) RemoveColumnByID(id string) {
for i, col := range t.columns {
if col.ID() == id {
t.RemoveColumn(i)
t.Refresh()
return
}
}
}
// RemoveColumnByTitle removes the given column with the given title. If the column does not exist, nothing will change.
func (t *Table) RemoveColumnByTitle(title string) {
for i, col := range t.columns {
if col.Title() == title {
t.RemoveColumn(i)
t.Refresh()
return
}
}
}
// ClearColumns removes all of the columns.
func (t *Table) ClearColumns() {
if len(t.columns) > 0 {
t.columns = []ColumnI{}
t.Refresh()
}
}
// HideColumns hides all of the columns, keeping them in the column list, but causing them not to draw.
func (t *Table) HideColumns() {
for _, col := range t.columns {
col.SetHidden(true)
}
t.Refresh()
}
// ShowColumns sets all of the columns to be shown.
func (t *Table) ShowColumns() {
for _, col := range t.columns {
col.SetHidden(false)
}
t.Refresh()
}
// SetRowStyler sets a styler that returns attributes to be used on a particular row.
func (t *Table) SetRowStyler(a TableRowAttributer) TableI {
t.rowStyler = a
return t.this()
}
func (t *Table) RowStyler() TableRowAttributer {
return t.rowStyler
}
// SetHeaderRowStyler sets a styler that returns attributes to be used on a particular header row.
func (t *Table) SetHeaderRowStyler(a TableHeaderRowAttributer) TableI {
t.headerRowStyler = a
return t.this()
}
// SetFooterRowStyler sets a styler that returns attributes to be used on a particular footer row.
func (t *Table) SetFooterRowStyler(a TableFooterRowAttributer) TableI {
t.footerRowStyler = a
return t.this()
}
// UpdateFormValues is used by the framework to cause the control to retrieve its values from the form
func (t *Table) UpdateFormValues(ctx *page.Context) {
for _, col := range t.columns {
col.UpdateFormValues(ctx)
}
}
// PrivateAction is called by the framework to allow controls to process actions internal to themselves.
func (t *Table) PrivateAction(ctx context.Context, p page.ActionParams) {
switch p.ID {
case ColumnAction:
var subId string
var a action.CallbackActionI
var ok bool
if a, ok = p.Action.(action.CallbackActionI); !ok {
panic("Column actions must be a callback action")
}
if subId = a.GetDestinationControlSubID(); subId == "" {
panic("Column actions must be a callback action")
}
c := t.GetColumnByID(subId)
if c != nil {
c.Action(ctx, p)
}
case SortClick:
t.sortClick(p.EventValueString())
t.Refresh()
}
}
// SetSortHistoryLimit sets the number of columns that the table will remember for the sort history. It defaults to 1,
// meaning it will remember only the current column. Setting it more than 1 will let the system report back on secondary
// sort columns that the user chose. For example, if the user clicks to sort a first name column, and then a last name column,
// it will let you know to sort by last name, and then first name.
func (t *Table) SetSortHistoryLimit(n int) TableI {
t.sortHistoryLimit = n
t.Refresh()
return t.this()
}
func (t *Table) sortClick(id string) {
var foundLoc = -1
var firstCol ColumnI
if t.sortColumns != nil {
firstCol = t.GetColumnByID(t.sortColumns[0])
if firstCol.SortDirection() == NotSortable {
return
}
}
if t.sortColumns != nil {
// If the column clicked is already the first one in the list, just change direction
if t.sortColumns[0] == id {
firstCol.SetSortDirection(firstCol.SortDirection() * -1)
return
}
firstCol.SetSortDirection(NotSorted) // tell the first one in the list to not be sorted
// remove the column from the sort list if it is there
for i := 0; i < len(t.sortColumns); i++ {
if t.sortColumns[i] == id {
foundLoc = i
break
}
}
if foundLoc != -1 {
t.sortColumns = append(t.sortColumns[:foundLoc], t.sortColumns[foundLoc+1:]...)
}
}
//push front
t.sortColumns = append([]string{id}, t.sortColumns...)
col := t.GetColumnByID(id)
col.SetSortDirection(SortAscending) // start out ascending
//remove back
if len(t.sortColumns) > t.sortHistoryLimit {
t.sortColumns = t.sortColumns[:len(t.sortColumns)-1]
}
}
// SortColumns returns a slice of columns in sort order
func (t *Table) SortColumns() (ret []ColumnI) {
for _, id := range t.sortColumns {
if col := t.GetColumnByID(id); col != nil {
ret = append(ret, col)
}
}
return ret
}
// MarshalState is an internal function to save the state of the control
func (t *Table) MarshalState(m maps.Setter) {
m.Set("sortColumns", t.sortColumns)
for _, col := range t.columns {
col.MarshalState(m)
}
}
// UnmarshalState is an internal function to restore the state of the control
func (t *Table) UnmarshalState(m maps.Loader) {
if v, ok := m.Load("sortColumns"); ok {
if s, ok := v.([]string); ok {
t.sortColumns = s
}
}
for _, col := range t.columns {
col.UnmarshalState(m)
}
}
type tableEncoded struct {
Caption interface{}
CaptionID string
HideIfEmpty bool
HeaderRowCount int
FooterRowCount int
CurrentHeaderRowIndex int //??
CurrentRowIndex int //??
RowStyler interface{}
HeaderRowStyler interface{}
FooterRowStyler interface{}
ColumnIdCounter int
SortColumns []string // keeps a historical list of columns sorted on
SortHistoryLimit int
}
func (t *Table) Serialize(e page.Encoder) (err error) {
if err = t.ControlBase.Serialize(e); err != nil {
return
}
if err = t.DataManager.Serialize(e); err != nil {
return
}
s := tableEncoded{
HideIfEmpty: t.hideIfEmpty,
HeaderRowCount: t.headerRowCount,
FooterRowCount: t.footerRowCount,
ColumnIdCounter: t.columnIdCounter,
SortColumns: t.sortColumns,
SortHistoryLimit: t.sortHistoryLimit,
RowStyler: t.rowStyler,
HeaderRowStyler: t.headerRowStyler,
FooterRowStyler: t.footerRowStyler,
}
// The caption can be a string, so we can't do the trick we do with objects below
if ctrl,ok := t.caption.(page.ControlI); ok {
s.CaptionID = ctrl.ID()
} else {
s.Caption = t.caption
}
if ctrl,ok := t.rowStyler.(page.ControlI); ok {
s.RowStyler = ctrl.ID()
}
if ctrl,ok := t.headerRowStyler.(page.ControlI); ok {
s.HeaderRowStyler = ctrl.ID()
}
if ctrl,ok := t.footerRowStyler.(page.ControlI); ok {
s.FooterRowStyler = ctrl.ID()
}
if err = e.Encode(s); err != nil {
return err
}
var l int = len(t.columns)
if err = e.Encode(l); err != nil {
return err
}
for _,col := range t.columns {
if err = e.Encode(columnRegistryID(col)); err != nil {
return
}
if err = col.Serialize(e); err != nil {
return err
}
}
return
}
func (t *Table) Deserialize(dec page.Decoder) (err error) {
if err = t.ControlBase.Deserialize(dec); err != nil {
panic(err)
}
if err = t.DataManager.Deserialize(dec); err != nil {
panic(err)
}
var s tableEncoded
if err = dec.Decode(&s); err != nil {
panic(err)
}
t.hideIfEmpty = s.HideIfEmpty
t.headerRowCount = s.HeaderRowCount
t.footerRowCount = s.FooterRowCount
t.columnIdCounter = s.ColumnIdCounter
t.sortColumns = s.SortColumns
t.sortHistoryLimit = s.SortHistoryLimit
if s.CaptionID != "" {
t.captionId = s.CaptionID
} else {
t.caption = s.Caption
}
if v,ok := s.RowStyler.(string); ok {
t.rowStylerId = v
}
if v,ok := s.HeaderRowStyler.(string); ok {
t.headerRowStylerId = v
}
if v,ok := s.FooterRowStyler.(string); ok {
t.footerRowStylerId = v
}
var l int
if err = dec.Decode(&l); err != nil {
panic(err)
}
for idx := 0; idx < l; idx++ {
var registryID int
if err = dec.Decode(®istryID); err != nil {
panic(err)
}
c := createRegisteredColumn(registryID, t)
t.columns = append(t.columns, c)
if err = c.Deserialize(dec); err != nil {
return
}
}
return
}
func (t *Table) Restore() {
t.ControlBase.Restore()
if t.captionId != "" {
t.caption = t.Page().GetControl(t.captionId)
}
if t.rowStylerId != "" {
t.rowStyler = t.Page().GetControl(t.rowStylerId).(TableRowAttributer)
}
if t.headerRowStylerId != "" {
t.headerRowStyler = t.Page().GetControl(t.headerRowStylerId).(TableHeaderRowAttributer)
}
if t.footerRowStylerId != "" {
t.footerRowStyler = t.Page().GetControl(t.footerRowStylerId).(TableFooterRowAttributer)
}
for _,col := range t.columns {
col.Restore(t.this())
}
return
}
// TableCreator is the initialization structure for declarative creation of tables
type TableCreator struct {
// ID is the control id
ID string
// HasColTags will make the table render <col> tags
HasColTags bool
// Caption is the content of the caption tag, and can either be a string, or a data pager
Caption interface{}
// HideIfEmpty will hide the table completely if it has no data. Otherwise, the table and headers will be shown, but no data rows
HideIfEmpty bool
// HeaderRowCount is the number of header rows. You must set this to at least 1 to show header rows.
HeaderRowCount int
// FooterRowCount is the number of footer rows.
FooterRowCount int
// RowStyler returns the attributes to be used in a cell.
RowStyler TableRowAttributer
// RowStylerID is a control id for the control that will be the RowStyler of the table.
RowStylerID string
// HeaderRowStyler returns the attributes to be used in a header cell.
HeaderRowStyler TableHeaderRowAttributer
// HeaderRowStylerID is a control id for the control that will be the HeaderRowStyler of the table.
HeaderRowStylerID string
// FooterRowStyler returns the attributes to be used in a footer cell. It can be either a control id or a TableFooterRowAttributer.
FooterRowStyler TableFooterRowAttributer
// FooterRowStylerID is a control id for the control that will be the FooterRowStyler of the table.
FooterRowStylerID string
// Columns are the column creators that will add columns to the table
Columns []ColumnCreator
// DataProvider is the control that will dynamically provide the data for the list and that implements the DataBinder interface.
DataProvider DataBinder
// DataProviderID is the id of a control that will dynamically provide the data for the list and that implements the DataBinder interface.
DataProviderID string
// Data is the actual data for the table, and should be a slice of objects
Data interface{}
// Sortable will make the table sortable
Sortable bool
// SortHistoryLimit will set how many columns deep we will remember the sorting for multi-level sorts
SortHistoryLimit int
OnCellClick action.ActionI
ControlOptions page.ControlOptions
}
// Create is called by the framework to create a new control from the Creator. You
// do not normally need to call this.
func (c TableCreator) Create(ctx context.Context, parent page.ControlI) page.ControlI {
ctrl := NewTable(parent, c.ID)
c.Init(ctx, ctrl)
return ctrl
}
// Init is called by implementations of Tables to initialize a base control.
// You do not normally need to call this.
func (c TableCreator) Init(ctx context.Context, ctrl TableI) {
ctrl.SetHideIfEmpty(c.HideIfEmpty)
if c.Caption != nil {
if ctrl2, ok := c.Caption.(page.Creator); ok {
ctrl.SetCaption(ctrl2.Create(ctx, ctrl))
} else {
ctrl.SetCaption(c.Caption)
}
}
if c.HeaderRowCount > 0 {
ctrl.SetHeaderRowCount(c.HeaderRowCount)
}
if c.FooterRowCount > 0 {
ctrl.SetFooterRowCount(c.FooterRowCount)
}
if c.RowStyler != nil {
ctrl.SetRowStyler(c.RowStyler)
} else if c.RowStylerID != "" {
ctrl.SetRowStyler(ctrl.Page().GetControl(c.RowStylerID).(TableRowAttributer))
}
if c.HeaderRowStyler != nil {
ctrl.SetHeaderRowStyler(c.HeaderRowStyler)
} else if c.HeaderRowStylerID != "" {
ctrl.SetHeaderRowStyler(ctrl.Page().GetControl(c.HeaderRowStylerID).(TableHeaderRowAttributer))
}
if c.FooterRowStyler != nil {
ctrl.SetFooterRowStyler(c.FooterRowStyler)
} else if c.FooterRowStylerID != "" {
ctrl.SetFooterRowStyler(ctrl.Page().GetControl(c.FooterRowStylerID).(TableFooterRowAttributer))
}
if c.DataProvider != nil {
ctrl.SetDataProvider(c.DataProvider)
} else if c.DataProviderID != "" {
provider := ctrl.Page().GetControl(c.DataProviderID).(DataBinder)
ctrl.SetDataProvider(provider)
}
if c.Data != nil {
ctrl.SetData(c.Data)
}
if c.Columns != nil {
for _,colCreator := range c.Columns {
ctrl.AddColumn(colCreator.Create(ctx, ctrl))
}
}
if c.Sortable {
ctrl.MakeSortable()
}
if c.SortHistoryLimit > 0 {
ctrl.SetSortHistoryLimit(c.SortHistoryLimit)
}
if c.OnCellClick != nil {
ctrl.On(event.CellClick(), c.OnCellClick)
}
ctrl.ApplyOptions(ctx, c.ControlOptions)
}
// GetTable is a convenience method to return the table with the given id from the page.
func GetTable(c page.ControlI, id string) *Table {
return c.Page().GetControl(id).(*Table)
}
func init() {
page.RegisterControl(&Table{})
}
// Similar to the control registry, since columns rely on the "this" variable to deserialize, we
// must have our own registry. All columns, including user-created columns, must therefore be
// registered.
var columnRegistry []reflect.Type
var columnRegistryOffsets = make(map[reflect.Type]int)
// RegisterColumn registers the column for the serialize/deserialize process. You should call this
// for each column type in an init() function.
func RegisterColumn(i interface{}) {
typ := reflect.TypeOf(i)
if _, ok := columnRegistryOffsets[typ]; ok {
panic("Registering duplicate column")
}
columnRegistry = append(columnRegistry, typ)
columnRegistryOffsets[typ] = len(columnRegistry) - 1
}
func columnRegistryID(i ColumnI) int {
val := reflect.Indirect(reflect.ValueOf(i))
typ := val.Type()
offset, ok := columnRegistryOffsets[typ]
if !ok {
panic("Column type is not registered: " + typ.String())
}
return offset
}
func createRegisteredColumn(registryID int, t TableI) ColumnI {
typ := columnRegistry[registryID]
v := reflect.New(typ)
c := v.Interface().(ColumnI)
c.init(c)
c.setParentTable(t)
return c
}