-
Notifications
You must be signed in to change notification settings - Fork 60
/
CfgBeans.js
2047 lines (2019 loc) · 93.4 KB
/
CfgBeans.js
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
/*
* Copyright 2012 Amadeus s.a.s.
* 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.
*/
Aria.beanDefinitions({
$package : "aria.widgets.CfgBeans",
$description : "Definition of the JSON beans used by the aria widgets library",
$namespaces : {
"json" : "aria.core.JsonTypes",
"templates" : "aria.templates.CfgBeans",
"environmentBase" : "aria.core.environment.EnvironmentBaseCfgBeans",
"FormListCfg" : "aria.widgets.form.list.CfgBeans",
"dragDrop" : "aria.utils.dragdrop.DragDropBean",
"common" : "aria.widgetLibs.CommonBeans"
},
$beans : {
"WidgetCfg" : {
$type : "json:Object",
$description : "Base config object used for any widget",
$properties : {
"id" : {
$type : "json:String",
$description : "unique id (within the template) to associate to the widget - if not provided, a unique id will automatically be generated by the framework",
$mandatory : false
},
"bind" : {
$type : "json:Object",
$description : "List of properties that we want to bind for this widget - the property name being used as Map item key",
$properties : {
"tooltip" : {
$type : "common:BindingRef"
}
},
$sample : {
"tooltip" : {
to : "name",
inside : "REF HERE - e.g.: data"
}
}
},
"tooltip" : {
$type : "json:String",
$description : "Floating text to display when mouse is over the widget - if empty or null the tooltip will be considered as unset",
$default : null
},
"tooltipId" : {
$type : "json:String",
$description : "Id of the tooltip widget to be displayed when mouse is over the widget. - if empty or null no tooltip widget will be displayed",
$default : null
},
"width" : {
$type : "json:Integer",
$description : "Widget width in pixel - note: some widgets may ignore this property. If negative, the width will be considered as unset and the widget will use the most appropriate width when possible",
$default : -1
},
"verticalAlign" : {
$type : "json:String",
$description : "Define the vertical alignment of the widget. It can be any valid vertical-align CSS values. Nothing is set by default if the widgetSettings.middleAlignment environment property value is set to false, otherwise, the default value is middle."
},
"margins" : {
$type : "json:String",
$description : "Width margin in the format: top right bottom left. Each margin is either an json:Integer or an x (meaning no change)",
$default : null
},
"block" : {
$type : "json:Boolean",
$description : "This determines whether a display:block or display:inline-block should be used for the top-level span",
$default : false
},
"printOptions" : {
$type : "templates:PrintOptions"
},
"sclass" : {
$type : "json:String",
$description : "which class defined in the skin is being used",
$default : "std"
},
"tabIndex" : {
$type : "json:Integer",
$description : "The tab index of the widget. If null it's not taken into account, if 0 or above the widget will be focusable thorugh tab, if negative it won't be focusable.",
$default : null
}
}
},
"ContainerCfg" : {
$type : "ResizableWidgetCfg",
$description : "Container widget which is used to give control over size and scrolling of widgets",
$properties : {}
},
"ResizableWidgetCfg" : {
$type : "WidgetCfg",
$description : "Base config for any widget that can be resized in width and height (by default widgets only support width)",
$properties : {
"height" : {
$type : "json:Integer",
$description : "Widget height in pixels - note: some widgets may ignore this property. If negative, the height will be considered as unset and the widget will use the most appropriate height when possible",
$default : -1
},
"minWidth" : {
$type : "json:Integer",
$description : "Minimum widget width in pixels - note: some widgets may ignore this property. This requires width unset/equals to -1. Note that this might be constrained further for some widgets to fit into viewport if the viewport is not big enough."
},
"maxWidth" : {
$type : "json:Integer",
$description : "Maximum widget width in pixels - note: some widgets may ignore this property. This requires width unset/equals to -1."
},
"minHeight" : {
$type : "json:Integer",
$description : "Minimum widget height in pixels - note: some widgets may ignore this property. This requires height unset/equals to -1. Note that this might be constrained further for some widgets to fit into viewport if the viewport is not big enough."
},
"maxHeight" : {
$type : "json:Integer",
$description : "Maximum widget height in pixels - note: some widgets may ignore this property. This requires height unset/equals to -1."
},
"scrollBarX" : {
$type : "json:Boolean",
$description : "Display horizontal scrollbar. This must be set to true if the list should overflow on the X axis.",
$default : false
},
"scrollBarY" : {
$type : "json:Boolean",
$description : "Display vertical scrollbar. This must be set to false if the list shouldn't overflow on the Y axis.",
$default : true
}
}
},
"InputCfg" : {
$type : "WidgetCfg",
$description : "Base config for any input object - adds label support to any widget",
$properties : {
"bind" : {
$type : "WidgetCfg.bind",
$properties : {
"label" : {
$type : "common:BindingRef"
},
"value" : {
$type : "common:BindingRef"
},
"mandatory" : {
$type : "common:BindingRef"
},
"readOnly" : {
$type : "common:BindingRef"
},
"disabled" : {
$type : "common:BindingRef"
},
"error" : {
$type : "common:BindingRef"
},
"errorMessages" : {
$type : "common:BindingRef"
},
"formatError" : {
$type : "common:BindingRef"
},
"formatErrorMessages" : {
$type : "common:BindingRef"
},
"invalidText" : {
$type : "common:BindingRef"
},
"requireFocus" : {
$type : "common:BindingRef"
},
"name" : {
$type : "common:BindingRef"
},
"errorTipPosition" : {
$type : "common:BindingRef"
}
}
},
"inputMetaData" : {
$type : "json:String",
$description : "Reference to the object that holds the input data (this object may contain $value, mandatory, readOnly, error, errorMessages, formatError, formatErrorMessages and validators properties that will be automatically bound to the widget)"
},
// Properties associated to the input management
"value" : {
$type : "json:MultiTypes",
$description : "Internal value associated to the widget - may be different from the text displayed or entered by the user (e.g. in case of codes or enums)"
},
"mandatory" : {
$type : "json:Boolean",
$description : "Indicates if the widget value must be provided (a specific style may apply to the widget to highlight this state to the user)",
$default : false
},
"readOnly" : {
$type : "json:Boolean",
$description : "Indicates if the widget must be read-only or if it can be edited",
$default : false
},
"error" : {
$type : "json:Boolean",
$description : "Highlights the input widget to notify an error to the user, defined in a template script.",
$default : false
},
"errorMessages" : {
$type : "json:Array",
$description : "List of error messages associated to the input widget, defined in a template script - these messages will be automatically displayed in a contextual error tooltip. If this array is not empty the error property is automatically set to true",
$contentType : {
$type : "json:String",
$description : "Error message associated to the widget (can be generated by one of the validators)"
},
$default : []
},
"formatError" : {
$type : "json:Boolean",
$description : "Highlights the input widget to notify an error to the user, defined in the framework."
},
"formatErrorMessages" : {
$type : "json:Array",
$description : "List of error messages associated to the input widget, defined in the framework. - these messages will be automatically displayed in a contextual error tooltip.",
$contentType : {
$type : "json:String",
$description : "Error messages associated to the widget, defined in the framework."
},
$default : []
},
"invalidText" : {
$type : "json:String",
$description : "Text displayed in the input when the field is invalid"
},
"requireFocus" : {
$type : "json:Boolean",
$description : "Set this bindable property to true to put the focus on the field. As soon as the focus has been put on the field, the property will be set back to false.",
$default : false
},
"directOnBlurValidation" : {
$type : "json:Boolean",
$description : "Whether validation on input widgets is automatically called by default on blur."
},
"validationGroups" : {
$type : "json:Array",
$description : "Contains groups that validation should occur for onblur.",
$contentType : {
$type : "json:String",
$description : "Contains the groups to validate."
}
},
"validationEvent" : {
$type : "json:Enum",
$enumValues : ["onFocus", "onBlur", "onError", "none"],
$default : "onFocus",
$description : "contains the event used to display the error tip"
},
// Input properties not automatically bound through the input
// property
"name" : {
$type : "json:String",
$description : "name of the input in current language - useful to describe the error location to the user",
$mandatory : false
},
"disabled" : {
$type : "json:Boolean",
$description : "Indicates if the widget must be disabled",
$default : false
},
// Properties associated to the label management
"label" : {
$type : "json:String", // TODO: sub-type to prevent from
// HTML tags in label
$description : "Label text to associate to the control - must contain a separator if needed (e.g. :)",
$default : null
},
"labelAlign" : {
$type : "json:Enum",
$description : "Alignment of the label",
$enumValues : ["left", "right", "center"],
$default : "left"
},
"labelPos" : {
$type : "json:Enum",
$description : "Position of the label from the widget",
$enumValues : ["left", "top", "right", "bottom"],
$default : "left"
},
"labelWidth" : {
$type : "json:Integer",
$description : "Width of the label container in px - if negative, the value is considered as unset",
$default : -1
},
"labelHeight" : {
$type : "json:Integer",
$description : "Height of the label container in px - if negative, the value is considered as unset",
$default : -1
},
"hideLabel" : {
$type : "json:Boolean",
$description : "Indicates if the label must be displayed or not (if true the label is hidden)",
$default : false
},
"errorTipPosition" : {
$type : "json:String",
$description : "Possible values are: 'bottom left', 'bottom right', 'top left', 'top right'.",
$default : "top right"
}
}
},
"CheckBoxCfg" : {
$type : "InputCfg",
$description : "Base config for any check box widget",
$properties : {
"labelPos" : {
$type : "InputCfg.labelPos",
$description : "Position of the Checkbox (or radio box) label",
$default : "right"
},
"value" : {
$type : "InputCfg.value",
$description : "Value associated to the widget representing the selected state",
$default : false
},
"onchange" : {
$type : "common:Callback",
$description : "Function to be called when the state of the widget changes due to user action(click)"
},
"icon" : {
$type : "json:String",
$description : "The name of the sprite and the icon that is to be used in the form sprite:icon",
$default : null
},
"tabIndex" : {
$type : "WidgetCfg.tabIndex",
$default : 0
}
}
},
"RadioButtonCfg" : {
$type : "CheckBoxCfg",
$description : "Configuration for a radio button",
$properties : {
"bind" : {
$type : "CheckBoxCfg.bind",
$properties : {
"keyValue" : {
$type : "common:BindingRef"
}
}
},
"value" : {
$type : "CheckBoxCfg.value",
$description : "Value associated to the widget representing the selected value",
$default : ""
},
"keyValue" : {
$type : "json:String",
$description : "Indicates the selected value",
$default : ""
}
}
},
"TextInputCfg" : {
$type : "InputCfg",
$description : "Base config for any text input widgets",
$properties : {
"maxlength" : {
$type : "json:Integer",
$description : "Maximum number of characters to allow in the textinput - if negative, no maximum applies",
$default : -1
},
"helptext" : {
$type : "json:String",
$description : "Text to be initially put in the text input in italics to help the user"
},
"validationDelay" : {
$type : "json:Integer",
$description : "The time period (in miliseconds) after which validation will be triggered on keydown event",
$default : null
},
"onchange" : {
$type : "common:Callback",
$description : "Function to be called when the user changes the value from this widget"
},
"onclick" : {
$type : "common:Callback",
$description : "Function to be called when the user clicks on the autocomplete."
},
"onfocus" : {
$type : "common:Callback",
$description : "Function to be called when the autocomplete receives focus."
},
"onblur" : {
$type : "common:Callback",
$description : "Function to be called when the autocomplete loses focus."
},
"spellCheck" : {
$type : "json:Boolean",
$description : "Specifies whether native spell check from the browser is enabled or not on this field. If null, uses the default behaviour from the browser. If true or false, tries to enable or disable native spell check from the browser."
},
"autoselect" : {
$type : "json:Boolean",
$description : "Specifies whether display text should be highlighted when the field gains focus."
},
"bind" : {
$type : "InputCfg.bind",
$properties : {
"prefill" : {
$type : "common:BindingRef"
},
"prefillError" : {
$type : "common:BindingRef"
}
}
}
}
},
"TextFieldCfg" : {
$type : "TextInputCfg",
$description : "The configuration for a text field",
$properties : {}
},
"TextareaCfg" : {
$type : "TextInputCfg",
$description : "The configuration for a text field",
$properties : {
"height" : {
$type : "json:Integer",
$description : "Widget height in pixel. If negative, the height will be considered as unset and the widget will use the most appropriate height when possible",
$default : -1
}
}
},
"SortIndicatorCfg" : {
$type : "ActionWidgetCfg",
$description : "The configuration for a sort list widget",
$properties : {
"view" : {
$type : "json:ObjectRef",
$description : "Passes the view name that is to be applied when using Sort List",
$classpath : "aria.templates.View"
},
"sortKeyGetter" : {
$type : "json:FunctionRef",
$description : "An anonymous function to pass the field by which we want to sort"
},
"refreshArgs" : {
$type : "json:Array",
$description : "Which section should the sort list refresh",
$contentType : {
$type : "templates:RefreshCfg"
}
},
"sortName" : {
$type : "json:String",
$description : "Name of the current sort",
$mandatory : true
},
"labelWidth" : {
$type : "json:Integer",
$description : "Widget width in pixel - If negative, the width will be considered as unset and the widget will use the most appropriate width when possible",
$default : -1
},
"activateEllipsis" : {
$type : "json:Boolean",
$description : "DEPRECATED. Ellipsis is now automatically activated if you specify a non-empty ellipsis parameter.",
$default : false
},
"ellipsis" : {
$type : "json:String",
$description : "What characters to use for ellipsis, by default this will be '...'"
},
"ellipsisLocation" : {
$type : "json:Enum",
$enumValues : ["left", "right"],
$description : "Which side will the ellipsis be, left or right",
$default : "right"
},
"ellipsisEndStyle" : {
$type : "json:Enum",
$enumValues : ["clipped", "fullCharacter"],
$description : "How the truncated text should end. Default to 'clipped'",
$default : "clipped"
}
}
},
"PasswordFieldCfg" : {
$type : "TextInputCfg",
$description : "The configuration for a text field",
$properties : {}
},
"DateFieldCfg" : {
$type : "TextInputCfg",
$description : "The configuration for a text field",
$properties : {
"pattern" : {
$type : "environmentBase:FormatTypes",
$description : "Date pattern used to propose a best value for the date entry"
},
"minValue" : {
$type : "json:Date",
$description : "Minimum date for the value property."
},
"maxValue" : {
$type : "json:Date",
$description : "Maximum date for the value property."
},
"referenceDate" : {
$type : "json:Date",
$description : "Reference date from which value can be calculated."
},
"bind" : {
$type : "TextInputCfg.bind",
$properties : {
"referenceDate" : {
$type : "common:BindingRef"
}
}
}
}
},
"TimeFieldCfg" : {
$type : "TextInputCfg",
$description : "The configuration for a text field",
$properties : {
"pattern" : {
$type : "environmentBase:FormatTypes",
$description : "Time pattern used to generate a value for the time entry"
}
}
},
"NumberFieldCfg" : {
$type : "TextInputCfg",
$description : "The configuration for a text field",
$properties : {
"pattern" : {
$type : "environmentBase:FormatTypes",
$description : "Formatting pattern used to format number fields",
$default : ""
},
"value" : {
$type : "TextInputCfg.value",
$description : "Number currently displayed.",
$contentTypes : [{
$type : "json:Float",
$description : ""
}]
}
}
},
"DropDownTextInputCfg" : {
$type : "TextInputCfg",
$description : "The base configuration for any widget extending DropDownInput",
$properties : {
"popupWidth" : {
$type : "json:Integer",
$description : "Width of the dropdown popup in px - if negative, the width is computed dynamically.",
$default : -1
},
"popupOpen" : {
$type : "json:Boolean",
$description : "When this value is true, popup is automatically opened"
},
"bind" : {
$type : "TextInputCfg.bind",
$properties : {
"popupOpen" : {
$type : "common:BindingRef"
}
}
}
}
},
"DropDownInputCfg" : {
$type : "InputCfg",
$description : "Configuration for widgets extending DropDownInput",
$properties : {
"popupWidth" : {
$type : "json:Integer",
$description : "Width of the dropdown popup in px - if negative, the width is computed dynamically.",
$default : -1
},
"popupOpen" : {
$type : "json:Boolean",
$description : "When this value is true, popup is automatically opened"
},
"bind" : {
$type : "InputCfg.bind",
$properties : {
"popupOpen" : {
$type : "common:BindingRef"
}
}
}
}
},
"ListItemCfg" : {
$type : "json:Object",
$description : "Option structure",
// open configuration
$restricted : false,
$properties : {
"value" : {
$type : "json:MultiTypes",
$description : "Internal value associated to the option - usually a language-independent code",
$mandatory : true,
$contentTypes : [{
$type : "json:Integer",
$description : ""
}, {
$type : "json:String",
$description : ""
}]
},
"label" : {
$type : "json:String",
$description : "Text to display to the user - must be in translated in user language",
$mandatory : true
}
}
},
"MultiSelectCfg" : {
$type : "DropDownTextInputCfg",
$description : "The base configuration for any widget extending DropDownInput",
$properties : {
"activateSort" : {
$type : "json:Boolean",
$description : "Allows the developer to specify if the list of options should be sorted by labels",
$default : false
},
"fieldSeparator" : {
$type : "json:String",
$description : "Template to use to display the list.",
$default : ','
},
"maxOptions" : {
$type : "json:Integer",
$description : "Maximum number of options that can be selected at the same time.",
$minValue : 1
},
"fieldDisplay" : {
$type : "json:Enum",
$description : "Whether to display code or value in the text input value.",
$enumValues : ["code", "label"],
$default : 'label'
},
"valueOrderedByClick" : {
$type : "json:Boolean",
$description : "Whether to display the values in the order they were clicked.",
$default : true
},
"instantBind" : {
$type : "json:Boolean",
$description : "If true, the 'value' property is refreshed (and 'onchange' is triggered) each time user clicks on one of the options of a dropdown. Otherwise, it's refreshed after the dropdown is closed.",
$default : false
},
"listTemplate" : {
$type : "json:PackageName",
$description : "Template to use to display the list.",
$default : "aria.widgets.form.templates.TemplateMultiSelect"
},
"listSclass" : {
$type : "json:String",
$description : "sclass of the list used in the dropdown. The default value for this property is taken from the skin."
},
"items" : {
$type : "ListCfg.items",
$description : "List of options on a MultiSelect"
},
"numberOfColumns" : {
$type : "FormListCfg:numberOfColumns",
$description : "Number of Columns used in the template"
},
"numberOfRows" : {
$type : "FormListCfg:numberOfRows",
$description : "Number of Rows used in the template"
},
"displayOptions" : {
$type : "FormListCfg:displayOptions",
$description : "Display options that are not interpreted by the list controller."
}
}
},
"DatePickerCfg" : {
$type : "DropDownTextInputCfg",
$description : "Configuration of a DatePicker",
$properties : {
"pattern" : {
$type : "environmentBase:FormatTypes",
$description : "Date pattern used to propose a best value for the date entry in the date picker field."
},
"inputPattern" : {
$type : "environmentBase:inputFormatTypes",
$description : "Date pattern used to match user input and convert it in a Javascript valid date."
},
"minValue" : {
$type : "json:Date",
$description : "Minimum date for the value property."
},
"maxValue" : {
$type : "json:Date",
$description : "Maximum date for the value property."
},
"referenceDate" : {
$type : "json:Date",
$description : "Reference date from which value can be calculated."
},
"calendarTemplate" : {
$type : "json:PackageName",
$description : "Template to use to display the calendar."
},
"calendarLabel" : {
$type : "json:String",
$description : "Label to be displayed inside the calendar when the DatePicker is open."
},
"calendarDisplayUnit" : {
$type : "json:Enum",
$description : "Minimum time unit which must be displayed entirely in the calendar. May be either month (M) or week (W). The default template currently only supports month (M).",
$enumValues : ["M", "W"]
},
"calendarNumberOfUnits" : {
$type : "json:Integer",
$description : "Number of display units to show at the same time in the calendar."
},
"calendarFirstDayOfWeek" : {
$type : "json:Integer",
$description : "First day of the week for the display of the calendar. 0 = Sunday, ... 6 = Saturday. The null value means that it is set according to the regional settings.",
$minValue : 0,
$maxValue : 6
},
"calendarMonthLabelFormat" : {
$type : "json:String",
$description : "Date pattern to be used when displaying each month in the calendar."
},
"calendarDayOfWeekLabelFormat" : {
$type : "json:String",
$description : "Date pattern to be used when displaying each day of the week in the calendar."
},
"calendarDateLabelFormat" : {
$type : "json:String",
$description : "Date pattern to be used when displaying each date in the calendar."
},
"calendarCompleteDateLabelFormat" : {
$type : "json:String",
$description : "Date pattern to be used when displaying complete dates in the calendar."
},
"calendarShowWeekNumbers" : {
$type : "json:Boolean",
$description : "Specifies whether week numbers should be displayed."
},
"calendarShowShortcuts" : {
$type : "json:Boolean",
$description : "Specifies if today and selected day shortcuts should be displayed"
},
"calendarRestrainedNavigation" : {
$type : "json:Boolean",
$description : "Specifies if today and selected day shortcuts should be displayed"
},
"calendarSclass" : {
$type : "json:String",
$description : "sclass of the calendar used in the dropdown. The default value for this property is taken from the skin."
},
"iconTooltip" : {
$type : "json:String",
$description : "Tooltip label for the datepicker icon",
$default : "Open the Calendar"
},
"bind" : {
$type : "DropDownTextInputCfg.bind",
$properties : {
"referenceDate" : {
$type : "common:BindingRef"
}
}
},
"value" : {
$type : "InputCfg.value",
$description : "Date currently selected in the date picker.",
$contentTypes : [{
$type : "json:Date",
$description : ""
}]
}
}
},
"SelectBoxCfg" : {
$type : "DropDownTextInputCfg",
$description : "Configuration of a SelectBox",
$properties : {
"listTemplate" : {
$type : "json:PackageName",
$description : "Template to use to display the list."
},
"listSclass" : {
$type : "json:String",
$description : "sclass of the list used in the dropdown. The default value for this property is taken from the skin."
},
"options" : {
$type : "json:Array",
$description : "List of the possible values that have to be proposed to the user",
$contentType : {
$type : "ListItemCfg"
},
$default : []
},
"bind" : {
$type : "DropDownTextInputCfg.bind",
$properties : {
"options" : {
$type : "common:BindingRef"
}
}
}
}
},
"SelectCfg" : {
$type : "DropDownInputCfg",
$description : "Configuration of a Select",
$properties : {
"tabIndex" : {
$type : "WidgetCfg.tabIndex",
$default : 0
},
"listTemplate" : {
$type : "json:PackageName",
$description : "Template used for displaying the list."
},
"listSclass" : {
$type : "json:String",
$description : "sclass of the list used in the dropdown. The default value for this property is taken from the skin."
},
"options" : {
$type : "json:Array",
$description : "List of the possible values displayed to the user",
$contentType : {
$type : "ListItemCfg"
},
$default : []
},
"onchange" : {
$type : "common:Callback",
$description : "Function to be called when the state of the widget changes."
},
"bind" : {
$type : "DropDownInputCfg.bind",
$properties : {
"options" : {
$type : "common:BindingRef"
}
}
}
}
},
"AutoCompleteCfg" : {
$type : "DropDownTextInputCfg",
$description : "Configuration of an AutoComplete",
$properties : {
"autoFill" : {
$type : "json:Boolean",
$description : "Autofill the autocomplete textfield on navigation in the suggestions",
$default : true
},
"freeText" : {
$type : "json:Boolean",
$description : "Specifies if the user can enter its own text",
$default : true
},
"suggestionsTemplate" : {
$type : "json:PackageName",
$description : "Template to use to display the list."
},
"resourcesHandler" : {
$type : "json:MultiTypes",
$description : "",
$contentTypes : [{
$type : "json:PackageName",
$description : "Classpath of the resources handler"
}, {
$type : "json:ObjectRef",
$description : "Instance of a resources handler"
}],
$mandatory : true
},
"preselect" : {
$type : "json:String",
$description : "strict: for strict highlighting (exact match only), always: for selecting the first item everytime, none: for no highlighting",
$default : "strict"
},
"expandButton" : {
$type : "json:Boolean",
$description : "Specifies if the button to get all the suggestions is displayed. Note that the getAllSuggestions method must be implemented on the resources handler for this feature to work (which is not the case for the default Air and Cities resources handlers).",
$default : false
},
"popupMaxHeight" : {
$type : "json:Integer",
$description : "Maximum height of the dropdown."
},
"listSclass" : {
$type : "json:String",
$description : "sclass of the list used in the dropdown. The default value for this property is taken from the skin."
},
"selectionKeys" : {
$type : "json:Array",
$description : "Keys defined for submitting a selected item from autocomplete dropdown, key codes and strings can be taken from aria.DomEven",
$contentType : {
$type : "json:Object",
$properties : {
"key" : {
$type : "json:MultiTypes",
$description : "description of the key",
$mandatory : true,
$contentTypes : [{
$type : "json:Integer",
$description : "key code"
}, {
$type : "json:String",
$description : "String representing the key",
$sample : "F4"
}]
},
"ctrl" : {
$type : "json:Boolean",
$description : "Whether or not the ctrl key has to pressed",
$default : false
},
"shift" : {
$type : "json:Boolean",
$description : "Whether or not the shift key has to pressed",
$default : false
},
"alt" : {
$type : "json:Boolean",
$description : "Whether or not the alt key has to pressed",
$default : false
}
}
},
$default : [{
key : "ENTER"
}]
}
}
},
"MultiAutoCompleteCfg" : {
$type : "AutoCompleteCfg",
$description : "The base configuration for the MultiAutoComplete widget",
$properties : {
"maxOptions" : {
$type : "json:Integer",
$description : "Maximum no of options that can be selected with MultiAutoComplete."
},
"freeText" : {
$type : "AutoCompleteCfg.freeText",
$description : "Specifies if the user can enter its own text and user can edit the text as well on double click",
$default : true
}
}
},
"ActionWidgetCfg" : {
$type : "WidgetCfg",
$description : "The base configuration for the button widget",
$properties : {
"bind" : {
$type : "WidgetCfg.bind",
$properties : {
"error" : {
$type : "common:BindingRef"
},
"errorMessages" : {
$type : "common:BindingRef"
},
"errorTipPosition" : {
$type : "common:BindingRef"
}
}
},
"label" : {
$type : "json:String",
$description : "Text to put inside the label in the button",