-
Notifications
You must be signed in to change notification settings - Fork 7
/
BBjGridExWidgetColumns.bbj
1424 lines (1378 loc) · 53.5 KB
/
BBjGridExWidgetColumns.bbj
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
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
rem package BBjGridExWidget.Columns
rem /**
rem * This file is part of the BBjGridExWidget plugin.
rem * (c) Basis Europe <eu@basis.com>
rem *
rem * For the full copyright and license information, please view the LICENSE
rem * file that was distributed with this source code.
rem */
use java.util.Arrays
use java.util.ArrayList
use java.util.HashMap
use java.util.LinkedHashMap
use java.util.HashSet
use java.sql.Types
use com.google.gson.Gson
use com.google.gson.JsonObject
use com.google.gson.JsonArray
use com.google.gson.JsonParser
use com.basiscomponents.db.DataField
use ::BBjGridExWidget/BBjGridExWidget.bbj::BBjGridExWidget
use ::BBjGridExWidget/BBjGridExWidgetFilters.bbj::BBjGridExWidgetFilterInterface
use ::BBjGridExWidget/BBjGridExWidgetFilters.bbj::BBjGridExWidgetFilterAGText
use ::BBjGridExWidget/BBjGridExWidgetFilters.bbj::BBjGridExWidgetFilterAGNumber
use ::BBjGridExWidget/BBjGridExWidgetFilters.bbj::BBjGridExWidgetFilterBasicBoolean
use ::BBjGridExWidget/BBjGridExWidgetFilters.bbj::BBjGridExWidgetFilterBasicDate
use ::BBjGridExWidget/BBjGridExWidgetFilters.bbj::BBjGridExWidgetFilterBasicTimestamp
use ::BBjGridExWidget/BBjGridExWidgetExpressions.bbj::BBjGridExWidgetExpressionInterface
use ::BBjGridExWidget/BBjGridExWidgetExpressions.bbj::BBjGridExWidgetExpression
use ::BBjGridExWidget/BBjGridExWidgetExpressions.bbj::BBjGridExWidgetExpressionNumbersFormatter
use ::BBjGridExWidget/BBjGridExWidgetExpressions.bbj::BBjGridExWidgetExpressionDatesFormatter
use ::BBjGridExWidget/BBjGridExWidgetRenderers.bbj::BBjGridExWidgetRendererInterface
use ::BBjGridExWidget/BBjGridExWidgetRenderers.bbj::BBjGridExWidgetRendererBoolean
use ::BBjGridExWidget/BBjGridExWidgetRenderers.bbj::BBjGridExWidgetRendererGroupCellRenderer
use ::BBjGridExWidget/BBjGridExWidgetCellEditors.bbj::BBjGridExWidgetCellEditorInterface
use ::BBjGridExWidget/BBjGridExWidgetCellEditors.bbj::BBjGridExWidgetCellEditorAGText
use ::BBjGridExWidget/BBjGridExWidgetCellEditors.bbj::BBjGridExWidgetCellEditorAGLargeText
use ::BBjGridExWidget/BBjGridExWidgetCellEditors.bbj::BBjGridExWidgetCellEditorBasicBoolean
use ::BBjGridExWidget/BBjGridExWidgetCellEditors.bbj::BBjGridExWidgetCellEditorBasicNumber
use ::BBjGridExWidget/BBjGridExWidgetCellEditors.bbj::BBjGridExWidgetCellEditorBasicDate
use ::BBjGridExWidget/BBjGridExWidgetCellEditors.bbj::BBjGridExWidgetCellEditorBasicTimestamp
REM /**
REM * The class holds the common props between column and column groups
REM *
REM * @author Hyyan Abo Fakher
REM */
class public BBjGridExWidgetColumnDefinition
rem /**
rem * The name to render in the column header.
rem */
field public BBjString Label! = null()
rem /**
rem * Whether to show the column when the group is open / closed.
rem *
rem * @see COLUMN_GROUP_CLOSED()
rem * @see COLUMN_GROUP_OPENED()
rem */
field public BBjString ColumnGroupShow! = null()
rem /**
rem * A CSS class(s) to use for the header cell.
rem */
field public ArrayList HeaderClass! = new ArrayList()
rem /**
rem * A css class(s) to use for the tool panel cell.
rem */
field public ArrayList ToolPanelClass! = new ArrayList()
rem /**
rem * Set to true if you do not want this column or group to appear in the tool panel.
rem */
field public BBjNumber SuppressToolPanel! = null()
rem /**
rem * A constant which defines the group state as opened
rem *
rem * @return BBjString <b>opened</b>
rem */
method public static BBjString COLUMN_GROUP_OPENED()
methodret "open"
methodend
rem /**
rem * A constant which defines the group state as opened
rem *
rem * @return BBjString <b>opened</b>
rem */
method public static BBjString COLUMN_GROUP_CLOSED()
methodret "closed"
methodend
rem /**
rem * Convert the defintion to Json Object
rem */
method public JsonObject getAsJsonObject()
declare JsonObject json!
json! = new JsonObject()
json!.addProperty("headerName" , #getLabel(),err=*next)
json!.addProperty("columnGroupShow" , #getColumnGroupShow() ,err=*next)
json!.addProperty("headerClass" , iff(#getHeaderClass().size() <> 0 ,new Gson().toJson(#getHeaderClass()), null()) ,err=*next)
json!.addProperty("toolPanelClass" , iff(#getToolPanelClass().size() <> 0 ,new Gson().toJson(#getToolPanelClass()) , null()) ,err=*next)
json!.addProperty("suppressToolPanel" , #getSuppressToolPanel().booleanValue() ,err=*next)
methodret json!
methodend
classend
rem /**
rem * The class reprensets the default column defintion which the grid will use.
rem *
REM * @author Hyyan Abo Fakher
rem */
class public BBjGridExWidgetDefaultColumnDefinition extends BBjGridExWidgetColumnDefinition
rem /**
rem * The Field Type.
rem *
rem * <b>Note :</b> Not all sql types are supported , for example it does not make sense to declare a colum type as STRUCT.
rem *
rem * @see https://docs.oracle.com/javase/8/docs/api/java/sql/Types.html
rem */
field public BBjNumber Type! = 12
rem /**
rem * Initial width in pixels
rem *
rem * <b>Note:</b> setting the width to zero will not hide the column , use <b>setHidden()</b> instead. And if the width is null()
rem * this means the grid will auto set the width for this column
rem *
rem * @see setHidden()
rem */
field public BBjNumber Width! = null()
rem /**
rem * Initial min width in pixels
rem */
field public BBjNumber MinWidth! = null()
rem /**
rem * Initial max width in pixels
rem */
field public BBjNumber MaxWidth! = null()
rem /**
rem * The filter component to use for this column
rem */
field public BBjGridExWidgetFilterInterface Filter! = new BBjGridExWidgetFilterAGText()
rem /**
rem * When true the filter is enabled , disabled otherwise
rem */
field public BBjNumber EnableFilter! = 1
rem /**
rem * Set to true to make a column hidden by default.
rem */
field public BBjNumber Hidden! = 0
rem /**
rem * Set to 'left' or 'right' to pin.
rem *
rem * @see PINNED_LEFT()
rem * @see PINNED_RIGHT()
rem */
field public BBjString Pinned! = null()
rem /**
rem * Set to true to always have column displayed first.
rem */
field public BBjNumber LockPosition! = 0
rem /**
rem * Set to true block making column visible / hidden via the UI (API will still work).
rem */
field public BBjNumber LockVisible! = 0
rem /**
rem * Set to true block pinning column via the UI (API will still work).
rem */
field public BBjNumber LockPinned! = 0
rem /**
rem * Set to true to allow sorting on this column.
rem */
field public BBjNumber Sortable! = 1
rem /**
rem * Set to 'asc' or 'desc' to sort by this column by default.
rem *
rem * @see SORT_DESC()
rem * @see SORT_ASC()
rem */
field public BBjString Sort! = null()
rem /**
rem * Set to true to allow column to be resized.
rem */
field public BBjNumber Resizable! = 1
rem /**
rem * Tooltip for the column header
rem */
field public BBjString HeaderTooltip! = null()
rem /**
rem * Set to true to render a selection checkbox in the column.
rem */
field public BBjNumber CheckboxSelection! = null()
rem /**
rem * Set to true to render a selection checkbox in the column's header.
rem */
field public BBjNumber HeaderCheckboxSelection! = null()
rem /**
rem * CSS class(s) to use for the cell.
rem */
field public ArrayList CellClass! = new ArrayList()
rem /**
rem * A map of css values.
rem */
field public JsonObject CellStyle! = new JsonObject()
rem /**
rem * Set to true if the column is editable, otherwise false.
rem */
field public BBjNumber Editable! = 0
rem /**
rem * A cellRenderer to use for this column
rem */
field public BBjGridExWidgetRendererInterface CellRenderer! = null()
rem /**
rem * CellEditor to use for this column
rem */
field public BBjGridExWidgetCellEditorInterface CellEditor! = new BBjGridExWidgetCellEditorAGText()
rem /**
rem * Name of function to use for aggregation. One of [sum,min,max,first,last].
rem */
field public BBjString AggFunc! = null()
rem /**
rem * Aggregation functions allowed on this column eg ['sum','avg'].
rem */
field public HashSet AllowedAggFuncs! = new HashSet()
rem /**
rem * Set this in columns you want to group by. If only grouping by one column, set this to any number (eg 0). If grouping by multiple columns, set this to where you want this column to be in the group (eg 0 for first, 1 for second, and so on).
rem */
field public BBjNumber RowGroupIndex! = null()
rem /**
rem * Set this in columns you want to pivot by. If only pivoting by one column, set this to any number (eg 0). If pivoting by multiple columns, set this to where you want this column to be in the order of pivots (eg 0 for first, 1 for second, and so on).
rem */
field public BBjNumber PivotIndex! = null()
rem /**
rem * Set to true if you want the unsorted icon to be shown when no sort is applied to this column.
rem */
field public BBjNumber UnSortIcon! = 0
rem /**
rem * <b>(ag-Grid-Enterprise only)</b> Set to true if you want to be able to row group by this column via the UI.
rem */
field public BBjNumber EnableRowGroup! = 1
rem /**
rem * <b>(ag-Grid-Enterprise only)</b> Set to true if you want to be able to pivot by this column via the UI.
rem */
field public BBjNumber EnablePivot! = 0
rem /**
rem * <b>(ag-Grid-Enterprise only)</b> Set to true if you want to be able to aggregate by this column via the UI.
rem */
field public BBjNumber EnableValue! = 1
rem /**
rem * Set to true if no menu should be shown for this column header.
rem */
field public BBjNumber SuppressMenu! = 0
rem /**
rem * Set to true if you want this columns width to be fixed during 'size to fit' operation.
rem */
field public BBjNumber SuppressSizeToFit! = 0
rem /**
rem * Set to true if you do not want this column to be movable via dragging.
rem */
field public BBjNumber SuppressMovable! = 0
rem /**
rem * Set to true if this col is not navigable (ie cannot be tabbed into), otherwise false.
rem */
field public BBjNumber SuppressNavigable! = 0
rem /**
rem * Set to true to have the grid calculate height of row based on contents of this column.
rem */
field public BBjNumber AutoHeight! = 0
rem /**
rem * Rules which can be applied to include certain CSS classes. These rules are provided as a map
rem * where the keys are the class names and the values are expressions that if evaluated to true, the class gets used.
rem * An expression is evaluated by the grid by executing the string as if it were a Javascript expression.
rem * The expression has the following attributes available to it. <br><br>
rem *
rem * <table border="1" cellpadding="10">
rem * <tbody>
rem * <tr>
rem * <td><strong> x</strong></td>
rem * <td> Mapped from cell value</td>
rem * </tr>
rem * <tr>
rem * <td><strong> rowIndex</strong></td>
rem * <td> Maps the current row index</td>
rem * </tr>
rem * <tr>
rem * <td> <strong>data</strong></td>
rem * <td> Mapped from the DataRow</td>
rem * </tr>
rem * <tr>
rem * <td> <strong>ctx</strong></td>
rem * <td> The grid client context</td>
rem * </tr>
rem * </tbody>
rem * </table>
rem */
field public JsonObject CellClassRules! = new JsonObject()
rem /**
rem * An Ag Grid expresion which can be executed before getting the value from your data for display
rem *
rem * @see BBjGridExWidget.Expression.BBjGridExWidgetExpression
rem */
field public BBjGridExWidgetExpressionInterface ValueGetterExpression! = null()
rem /**
rem * An Ag Grid expresion which can be executed to format the value for display.
rem *
rem * @see BBjGridExWidget.Expression.BBjGridExWidgetExpression
rem */
field public BBjGridExWidgetExpressionInterface ValueFormatterExpression! = null()
rem /**
rem * An Ag Grid expresion which can be executed to get the value for filtering purposes.
rem *
rem * @see BBjGridExWidget.Expression.BBjGridExWidgetExpression
rem */
field public BBjGridExWidgetExpressionInterface FilterValueGetterExpression! = null()
rem /**
rem * An Ag Grid expresion which can be executed before setting the value into your data for saving.
rem *
rem * @see BBjGridExWidget.Expression.BBjGridExWidgetExpression
rem */
field public BBjGridExWidgetExpressionInterface ValueSetterExpression! = null()
rem /**
rem * An Ag Grid expresion which can be executed to parse the value for saving.
rem *
rem * @see BBjGridExWidget.Expression.BBjGridExWidgetExpression
rem */
field public BBjGridExWidgetExpressionInterface ValueParserExpression! = null()
rem /**
rem * The default numbers mask to use. by default null()
rem */
field public BBjString DefaultNumbersMask! = null()
rem /**
rem * The default dates mask to use. by default <b>%Dz.%Mz.%Yd</b>
rem */
field public BBjString DefaultDatesMask! = "%Dz.%Mz.%Yd"
rem /**
rem * The default timestamps mask to use. by defualt <b>%Dz.%Mz.%Yl %Hz:%mz:%sz</b>
rem */
field public BBjString DefaultTimestampsMask! = "%Dz.%Mz.%Yl %Hz:%mz:%sz"
rem /**
rem * Icons to use inside the column instead of the grid's default icons.
rem *
rem * The icons can either be set on the grid options (all icons) or on the column definition (all except group).
rem * If defined in both the grid options and column definitions, the column definition will get used.
rem * This allows you to specify defaults in the grid options to fall back on, and then provide individual icons for
rem * specific columns. This is handy if, for example, you want to include 'A..Z' as string sort icons
rem * and just the simple arrow for other columns.
rem *
rem * The icons are set as follows:
rem * <pre>
rem * <code>
rem * // column header items
rem * menu
rem * filter
rem * columns
rem * sortAscending
rem * sortDescending
rem * sortUnSort
rem *
rem * // row checkbox selection and tool panel column selection
rem * checkboxChecked
rem * checkboxUnchecked
rem * checkboxIndeterminate
rem *
rem * // tool panel column selection, when read only (ie disabled checkboxes)
rem * checkboxCheckedReadOnly
rem * checkboxUncheckedReadOnly
rem * checkboxIndeterminateReadOnly
rem *
rem * // when moving columns
rem * columnMovePin // when column is to the left, before it gets pinned
rem * columnMoveAdd // when adding a column
rem * columnMoveHide // when removing a column
rem * columnMoveMove // when moving a column
rem * columnMoveLeft // when moving and scrolling left
rem * columnMoveRight // when moving and scrolling right
rem * columnMoveGroup // when about to drop into group panel
rem * columnMoveValue // when about to drop into value panel
rem * columnMovePivot // when about to drop into pivot panel
rem * dropNotAllowed // when trying to drop column into group/value/pivot panel and column doesn't support it
rem *
rem * // menu
rem * menuPin // beside the column pin menu item
rem * menuValue // beside the column value menu item
rem * menuAddRowGroup // beside the column row group menu item
rem * menuRemoveRowGroup // beside the column row group menu item
rem * clipboardCopy // beside the copy to clipboard menu item
rem * clipboardPaste // beside the paste from clipboard menu item
rem *
rem * // column drop panels
rem * pivotPanel // beside where to drop columns for pivot
rem * valuePanel // beside where to drop columns for value
rem * </code>
rem * </pre>
rem */
field public JsonObject Icons! = new JsonObject()
rem /**
rem * Get pinned left constant
rem *
rem * @return BBjString <b>left</b>
rem */
method public static BBjString PINNED_LEFT()
methodret "left"
methodend
rem /**
rem * Get pinned right constant
rem *
rem * @return BBjString <b>right</b>
rem */
method public static BBjString PINNED_RIGHT()
methodret "right"
methodend
rem /**
rem * Get sort direction constant
rem *
rem * @return BBjString <b>desc</b>
rem */
method public static BBjString SORT_DESC()
methodret "desc"
methodend
rem /**
rem * Get sort direction constant
rem *
rem * @return BBjString <b>asc</b>
rem */
method public static BBjString SORT_ASC()
methodret "asc"
methodend
rem /**
rem * A constant which defines the group state as opened
rem *
rem * @return BBjString <b>opened</b>
rem */
method public static BBjString COLUMN_GROUP_OPENED()
methodret "open"
methodend
rem /**
rem * A constant which defines the group state as opened
rem *
rem * @return BBjString <b>opened</b>
rem */
method public static BBjString COLUMN_GROUP_CLOSED()
methodret "closed"
methodend
rem /**
rem * Create a BBjGridExWidgetExpression from string and set it as value getter
rem *
rem * @param BBjString expression! Javascript expression
rem */
method public void setValueGetterExpression(BBjString expression!)
#ValueGetterExpression! = new BBjGridExWidgetExpression(expression!)
methodend
rem /**
rem * Create a BBjGridExWidgetExpression from string and set it as value setter
rem *
rem * @param BBjString expression! Javascript expression
rem */
method public void setValueSetterExpression(BBjString expression!)
#ValueSetterExpression! = new BBjGridExWidgetExpression(expression!)
methodend
rem /**
rem * Create a BBjGridExWidgetExpression from string and set it as value formatter
rem *
rem * @param BBjString expression! Javascript expression
rem */
method public void setValueFormatterExpression(BBjString expression!)
#ValueFormatterExpression! = new BBjGridExWidgetExpression(expression!)
methodend
rem /**
rem * Create a BBjGridExWidgetExpression from string and set it as value parser
rem *
rem * @param BBjString expression! Javascript expression
rem */
method public void setValueParserExpression(BBjString expression!)
#ValueParserExpression! = new BBjGridExWidgetExpression(expression!)
methodend
rem /**
rem * Set the allowd aggregation functions allowed on this column
rem *
rem * @param BBjString funcs! comma seperated functinos
rem */
method public void setAllowedAggFuncs(BBjString funcs!)
#AllowedAggFuncs!.addAll(Arrays.asList(funcs!.replaceAll(" ","").split(",")))
methodend
rem /**
rem * Sets the foreground color for a column
rem *
rem * @param BBjColor color! the color for the column
rem */
method public void setForeColor(BBjColor color!)
#getCellStyle().addProperty("color" , BBjGridExWidget.makeHexColor(color!))
methodend
rem /**
rem * Sets the foreground color for a column
rem *
rem * @param BBjString color$ Valid CSS color
rem *
rem * @see https://developer.mozilla.org/en-US/docs/Web/CSS/color_value
rem */
method public void setForeColor(BBjString color!)
#getCellStyle().addProperty("color" , color!)
methodend
rem /**
rem * Sets the background color of a column
rem *
rem * @param BBjColor color! The color for the column
rem */
method public void setBackColor(BBjColor color!)
#getCellStyle().addProperty("background-color" , BBjGridExWidget.makeHexColor(color!))
methodend
rem /**
rem * Sets the background color of a column
rem *
rem * @param BBjColor color$ Valid CSS color
rem *
rem * @see https://developer.mozilla.org/en-US/docs/Web/CSS/color_value
rem */
method public void setBackColor(BBjString color!)
#getCellStyle().addProperty("background-color" , color!)
methodend
rem /**
rem * Sets the default alignment for a column
rem *
rem * @param BBjNumber align! The column alignment
rem *
rem * valid alignments:
rem *
rem * @see BBjGridExWidget.GRID_ALIGN_LEFT()
rem * @see BBjGridExWidget.GRID_ALIGN_CENTER()
rem * @see BBjGridExWidget.GRID_ALIGN_RIGHT()
rem *
rem * @RequiresRefresh
rem */
method public void setAlignment(BBjNumber align!)
styleMap! = #getCellStyle()
switch align!
case BBjGridExWidget.GRID_ALIGN_LEFT()
styleMap!.addProperty("text-align" , "left")
break
case BBjGridExWidget.GRID_ALIGN_CENTER()
styleMap!.addProperty("text-align" , "center")
break
case BBjGridExWidget.GRID_ALIGN_RIGHT()
styleMap!.addProperty("text-align" , "right")
break
swend
methodend
rem /**
rem * Set the mask of a column using value formatter expression.
rem *
rem * <b>Note:</b> This method will override the ValueFormatterExpression of the column.The method depends on
rem * the column type to determine the correct value formatter (number , date , ...)
rem *
rem * @param BBjString mask!: The (date or numeric) mask, BBj style
rem */
method public void setColumnMask(BBjString mask!)
SWITCH #getType()
CASE Types.BIGINT
CASE Types.BIT
CASE Types.DECIMAL
CASE Types.DOUBLE
CASE Types.FLOAT
CASE Types.INTEGER
CASE Types.NUMERIC
CASE Types.NUMERIC
CASE Types.TINYINT
#setValueFormatterExpression(new BBjGridExWidgetExpressionNumbersFormatter(mask!))
BREAK
CASE Types.DATE
CASE Types.TIMESTAMP
CASE Types.TIMESTAMP_WITH_TIMEZONE
#setValueFormatterExpression(new BBjGridExWidgetExpressionDatesFormatter(mask!))
BREAK
CASE default
BREAK
SWEND
methodend
rem /**
rem * Set the grid icons
rem *
rem * @param BBjString json! The icons as a json object
rem */
method public void setIcons(BBjString json!)
declare JsonParser parser!
parser! = new JsonParser()
#setIcons(parser!.parse(json!).getAsJsonObject())
methodend
rem /**
rem * Set the column type
rem *
rem * @param BBjString type! SQL type
rem *
rem * <b>Note :</b>
rem * Not all sql types are supported , for example it does not make sense to declare a colum type as STRUCT.
rem * Setting the type will change the column common properites automatically like the filter , cell editor , ....
rem *
rem * @see https://docs.oracle.com/javase/8/docs/api/java/sql/Types.html
rem */
method public void setType(BBjNumber type!)
#Type! = type!
REM BBjGridExWidgetCellEditorAGText
REM BBjGridExWidgetCellEditorAGLargeText
REM BBjGridExWidgetCellEditorBasicBoolean
REM BBjGridExWidgetCellEditorBasicNumber
REM BBjGridExWidgetCellEditorBasicDate
REM BBjGridExWidgetCellEditorBasicTimestamp
SWITCH type!
CASE Types.BIGINT
CASE Types.BIT
CASE Types.DECIMAL
CASE Types.DOUBLE
CASE Types.FLOAT
CASE Types.INTEGER
CASE Types.NUMERIC
CASE Types.NUMERIC
CASE Types.TINYINT
#setFilter(new BBjGridExWidgetFilterAGNumber())
#setValueFormatterExpression(new BBjGridExWidgetExpressionNumbersFormatter(#getDefaultNumbersMask()))
#setCellEditor(new BBjGridExWidgetCellEditorBasicNumber())
BREAK
CASE Types.DATE
#setFilter(new BBjGridExWidgetFilterBasicDate())
#setValueFormatterExpression(new BBjGridExWidgetExpressionDatesFormatter(#getDefaultDatesMask()))
#setCellEditor(new BBjGridExWidgetCellEditorBasicDate())
BREAK
CASE Types.TIMESTAMP
CASE Types.TIMESTAMP_WITH_TIMEZONE
#setFilter(new BBjGridExWidgetFilterBasicTimestamp())
#setValueFormatterExpression(new BBjGridExWidgetExpressionDatesFormatter(#getDefaultTimestampsMask()))
#setCellEditor(new BBjGridExWidgetCellEditorBasicTimestamp())
BREAK
CASE Types.BOOLEAN
#setFilter(new BBjGridExWidgetFilterBasicBoolean())
#setCellRenderer(new BBjGridExWidgetRendererBoolean())
#setCellEditor(new BBjGridExWidgetCellEditorBasicBoolean())
BREAK
CASE default
BREAK
SWEND
methodend
rem /**
rem * @override
rem *
rem * {@inheritDoc}
rem */
method public JsonObject getAsJsonObject()
declare JsonObject column!
column! = #super!.getAsJsonObject()
column!.addProperty("width",#getWidth().longValue(),err=*next)
column!.addProperty("minWidth",#getMinWidth().longValue(),err=*next)
column!.addProperty("maxWidth",#getMaxWidth().longValue(),err=*next)
column!.addProperty("hide",#getHidden().booleanValue(),err=*next)
column!.addProperty("pinned",#getPinned(),err=*next)
column!.addProperty("lockPosition",#getLockPosition().longValue(),err=*next)
column!.addProperty("lockVisible",#getLockVisible().longValue(),err=*next)
column!.addProperty("lockPinned",#getLockPinned().longValue(),err=*next)
column!.addProperty("sortable",#getSortable().booleanValue(),err=*next)
column!.addProperty("sort",#getSort(),err=*next)
column!.addProperty("resizable",#getResizable().booleanValue(),err=*next)
column!.addProperty("headerTooltip",#getHeaderTooltip(),err=*next)
column!.addProperty("checkboxSelection",#getCheckboxSelection().booleanValue(),err=*next)
column!.addProperty("headerCheckboxSelection",#getHeaderCheckboxSelection().booleanValue(),err=*next)
column!.addProperty("cellClass" , iff(#getCellClass().size() <> 0 ,new Gson().toJson(#getCellClass()), null()) ,err=*next)
column!. add("cellStyle", iff(#getCellStyle().entrySet().size() <> 0 , #getCellStyle() , null()),err=*next)
column!.addProperty("editable",#getEditable().booleanValue(),err=*next)
column!.addProperty("aggFunc",#getAggFunc())
column!.addProperty("allowedAggFuncs" , iff(#getAllowedAggFuncs().size() <> 0 ,new Gson().toJson(#getAllowedAggFuncs()), null()) ,err=*next)
column!.addProperty("rowGroupIndex",#getRowGroupIndex().longValue(),err=*next)
column!.addProperty("pivotIndex",#getPivotIndex().longValue(),err=*next)
column!.addProperty("unSortIcon",#getUnSortIcon().booleanValue(),err=*next)
column!.addProperty("enableRowGroup",#getEnableRowGroup().booleanValue(),err=*next)
column!.addProperty("enablePivot",#getEnablePivot().booleanValue(),err=*next)
column!.addProperty("enableValue",#getEnableValue().booleanValue(),err=*next)
column!.addProperty("suppressMenu",#getSuppressMenu().booleanValue(),err=*next)
column!.addProperty("suppressSizeToFit",#getSuppressSizeToFit().booleanValue(),err=*next)
column!.addProperty("suppressMovable",#getSuppressMovable().booleanValue(),err=*next)
column!.addProperty("suppressNavigable",#getSuppressNavigable().booleanValue(),err=*next)
column!.addProperty("autoHeight",#getAutoHeight().booleanValue(),err=*next)
column!. add("cellClassRules", iff(#getCellClassRules().entrySet().size() <> 0 , #getCellClassRules() , null()),err=*next)
column!.addProperty("valueGetter",#getValueGetterExpression().toString(),err=*next)
column!.addProperty("valueFormatter",#getValueFormatterExpression().toString(),err=*next)
column!.addProperty("filterValueGetter",#getFilterValueGetterExpression().toString(),err=*next)
column!.addProperty("valueSetter",#getValueSetterExpression().toString(),err=*next)
column!.addProperty("valueParser",#getValueParserExpression().toString(),err=*next)
column!. add("icons",iff(#getIcons().entrySet().size() <> 0 , #getIcons() , null()),err=*next)
filterEnabled! = #getEnableFilter()
filter! = #getFilter()
if(( filterEnabled! <> null() and filterEnabled! = 1) and (filter! <> null())) then
filterParams! = filter!.getAsJsonObject()
column!.addProperty("filter", filter!.FILTER_NAME() ,err=*next)
column!. add("filterParams",iff(filterParams!.entrySet().size() <> 0 , filterParams!, null() ),err=*next)
else
column!.addProperty("filter", 0)
FI
renderer! = #getCellRenderer()
if(renderer! <> null()) then
rendererParams! = renderer!.getAsJsonObject()
column!.addProperty("cellRenderer", renderer!.RENDERER_NAME(),err=*next)
column!. add("cellRendererParams",iff(rendererParams!.entrySet().size() <> 0 , rendererParams! , null() ),err=*next)
FI
editor! = #getCellEditor()
if(editor! <> null()) then
editorParams! = editor!.getAsJsonObject()
column!.addProperty("cellEditor", editor!.CELL_EDITOR_NAME(),err=*next)
column!. add("cellEditorParams",iff(editorParams!.entrySet().size() <> 0 , editorParams! , null() ),err=*next)
FI
methodret column!
methodend
classend
REM /**
REM * The class holds the grid column props , it aslo introduces serveral helper methods to update the
REM * styles like , fore/back colors.
REM *
REM * @author Hyyan Abo Fakher
REM */
class public BBjGridExWidgetColumn extends BBjGridExWidgetDefaultColumnDefinition
rem /**
rem * The field of the row to get the cells data from<br><b>Note</b>: Once the field name is set , it becomes immutable
rem */
field public BBjString Field!
rem /**
rem * Disable default constructor
rem */
method private BBjGridExWidgetColumn()
methodend
rem /**
rem * Create a new column defintion
rem *
rem * @param BBjString field! The field of the row to get the cells data from
rem */
method public BBjGridExWidgetColumn(BBjString field!)
#Field! = field!
#setLabel(field!)
rem we reset the following properties so they can be inheirted from the default column defintion
#setHidden(null())
#setEnableFilter(null())
#setLockPinned(null())
#setLockPosition(null())
#setLockVisible(null())
#setSortable(null())
#setSortable(null())
#setResizable(null())
#setEditable(null())
#setUnSortIcon(null())
#setEnableRowGroup(null())
#setEnablePivot(null())
#setEnableValue(null())
#setSuppressMenu(null())
#setSuppressSizeToFit(null())
#setSuppressNavigable(null())
#setSuppressMovable(null())
#setAutoHeight(null())
methodend
rem /**
rem * Create a new column defintion
rem *
rem * @param BBjString field! The field of the row to get the cells data from
rem * @param BBjString label! The name to render in the column header
rem */
method public BBjGridExWidgetColumn(BBjString field!, BBjString label!)
#this!(field!)
#setLabel(label!)
methodend
rem /**
rem * Create a new column defintion
rem *
rem * @param BBjString field! The field of the row to get the cells data from
rem * @param BBjString label! The name to render in the column header
rem * @param BBjNumber type! The field's type
rem */
method public BBjGridExWidgetColumn(BBjString field!, BBjString label! , BBjNumber type!)
#this!(field! , label!)
#setType(type!)
methodend
rem /**
rem * Throw an error when called becuase the field becomes immutable after
rem * the column's definition creation
rem */
method public void setField(BBjString field!)
throw "Column's Field is immutable" , 151
methodend
rem /**
rem * @override
rem *
rem * {@inheritDoc}
rem */
method public JsonObject getAsJsonObject()
declare JsonObject column!
column! = #super!.getAsJsonObject()
column!.addProperty("field",#getField())
column!.addProperty("colId",#getField())
methodret column!
methodend
rem /**
rem * Update the column defintion from a meta map
rem *
rem * @param HashMap meta! The meta map
rem * @param BBjGridExWidgetDefaultColumnDefinition defaultDefinition! The default column defintion in the grid
rem */
method public void update(HashMap meta!, BBjGridExWidgetDefaultColumnDefinition defaultDefinition!)
iterator! = meta!.entrySet().iterator()
while iterator!.hasNext()
next! = iterator!.next()
key! = CVS(next!.getKey(),8)
value! = next!.getValue()
SWITCH (key!)
CASE "columntype"
#setType((value!))
if #getEnableFilter() = null() then
#setEnableFilter(defaultDefinition!.getEnableFilter(),err=*next)
FI
BREAK
CASE "gw_label"
CASE "gw_header_name"
CASE "header_name"
CASE "label" ; rem common attribute name
#setLabel(str(value!))
BREAK
CASE "gw_pinned"
CASE "pinned"
#setPinned(str(value!))
BREAK
CASE "gw_hide"
CASE "hide"
CASE "hidden"
#setHidden(num(value!))
BREAK
CASE "gw_editable"
CASE "editable" ; rem common attribute name
#setEditable(num(value!))
BREAK
CASE "gw_enable_value"
CASE "enable_value"
#setEnableValue(num(value!))
BREAK
CASE "gw_enable_row_group"
CASE "enable_row_group"
#setEnableRowGroup(num(value!))
BREAK
CASE "gw_row_group_index"
CASE "row_group_index"
#setRowGroupIndex(num(value!))
BREAK
CASE "gw_enable_pivot"
CASE "enable_pivot"
#setEnablePivot(num(value!))
BREAK
CASE "gw_cell_class"
CASE "cell_class"
#setCellClass(str(value!))
BREAK
CASE "gw_value_getter"
CASE "value_getter"
#setValueGetterExpression(str(value!))
BREAK
CASE "gw_value_setter"
CASE "value_setter"
#setValueSetterExpression(str(value!))
BREAK
CASE "gw_agg_func"
CASE "agg_func"
#setAggFunc(str(value!))
BREAK
CASE "gw_allowed_agg_funcs"
CASE "allowed_agg_funcs"
#setAllowedAggFuncs(str(value!))
BREAK
CASE "gw_sortable"
CASE "sortable"
#setSortable(num(value!))
BREAK
CASE "gw_sort"
CASE "sort"
#setSort(str(value!))
BREAK
CASE "gw_resizable"
CASE "resizable"
#setResizable(num(value!))
BREAK
CASE DEFAULT
BREAK
SWEND
wend
methodend
classend
REM /**
REM * Allows specifying the group 'auto column' if you are not happy with the default.
REM * If grouping, this column def is included as the first column definition in the grid.
REM * If not grouping, this column is not included.
REM *
REM * @author Hyyan Abo Fakher
REM */
class public BBjGridExWidgetAutoGroupColumn extends BBjGridExWidgetDefaultColumnDefinition
rem /**
rem * Construct new instance
rem */
method public BBjGridExWidgetAutoGroupColumn()
rem we reset the following properties so they can be inheirted from the default column defintion
#setHidden(null())
#setEnableFilter(null())
#setLockPinned(null())
#setLockPosition(null())
#setLockVisible(null())
#setSortable(null())
#setSortable(null())
#setResizable(null())
#setEditable(null())
#setUnSortIcon(null())
#setEnableRowGroup(null())
#setEnablePivot(null())
#setEnableValue(null())
#setSuppressMenu(null())
#setSuppressSizeToFit(null())
#setSuppressNavigable(null())
#setSuppressMovable(null())
#setAutoHeight(null())
#setCellRenderer(new BBjGridExWidgetRendererGroupCellRenderer())
methodend
rem /**
rem * Set the column type
rem *
rem * @param BBjString type! SQL type
rem *
rem * @see https://docs.oracle.com/javase/8/docs/api/java/sql/Types.html
rem */
method public void setType(BBjNumber type!)
#Type! = type!
methodend
classend
rem /**
rem * The inteface defines the common methods for columns and column groups managment
rem *
REM * @author Hyyan Abo Fakher
rem */
interface public BBjGridExWidgetColumnsManagerInterface
rem /**
rem * Add column group
rem *
rem * @param BBjGridExWidgetColumnGroup definition! The column group defintion
rem */
method public BBjGridExWidgetColumnGroup addColumnGroup(BBjGridExWidgetColumnGroup definition!)
rem /**
rem * Add column group
rem *
rem * @param BBjString id! The group id
rem */
method public BBjGridExWidgetColumnGroup addColumnGroup(BBjString id!)
rem /**
rem * Add column group
rem *
rem * @param BBjString id! The group id
rem * @param BBjString label! The group label
rem */
method public BBjGridExWidgetColumnGroup addColumnGroup(BBjString id! , BBjString label!)
rem /**
rem * Get the column group defintion instance
rem *
rem * @param BBjString id! The column group defintion id
rem *
rem * @return BBjGridExWidgetColumn return the column group definition instance if found , null() otherwise
rem */
method public BBjGridExWidgetColumnGroup getColumnGroup(BBjString id!)
rem /**
rem * Check if the column group defintion exists
rem *
rem * @param BBjString id! The column group defintion id
rem *
rem * @return BBjNumber return 1 when found , 0 otherwise
rem */
method public BBjNumber hasColumnGroup(BBjString id!)
rem /**
rem * Remove a column group defintion
rem *
rem * @param BBjString id! The column group defintion id
rem *
rem * @return BBjGridExWidgetColumnGroup The removed column group instance , null() otherwise
rem */
method public BBjGridExWidgetColumnGroup removeColumnGroup(BBjString id!)
rem /**
rem * Add new column defintion
rem *
rem * @param BBjGridExWidgetColumn definition! The column definition object
rem *
rem * @return BBjGridExWidgetColumn The defintion instance
rem */
method public BBjGridExWidgetColumn addColumn(BBjGridExWidgetColumn definition!)