-
Notifications
You must be signed in to change notification settings - Fork 10
Expand file tree
/
Copy pathonepage.html
More file actions
6929 lines (6092 loc) · 259 KB
/
Copy pathonepage.html
File metadata and controls
6929 lines (6092 loc) · 259 KB
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
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Centrallix Application Server: Widget Documentation</title>
<link rel="StyleSheet" href="style.css" type="text/css">
</head>
<body>
<!-- PAGE BREAK: 'toc.html' -->
<h1>Centrallix Application<br>Widget<br>Reference</h1>
<br><p>This guide contains a basic overview and specification of each of the widgets that Centrallix supports, including a handful of planned (but not yet implemented or not fully implemented) widgets.</p>
<p>Each widget can have properties, child properties, events, and actions. Properties define how the widget behaves, appears, and is constructed. Child properties usually define how a widget contained within the given widget relates to its parent. Such properties are normally managed by the containing (parent) widget rather than by the child, and many times the child widget cannot exist without its parent. Events enable a widget to have an "influence" on the other widgets on the page, and are utilized by placing a "connector" widget within the given widget. The connector routes an event's firing to the activation of an "action" on some other widget on the page. Actions are "methods" on widgets which cause the widget to do something or change its appearance in some way.</p>
<p>The "overview" section for each widget describes the widget's purpose and how it operates. A "usage" section is provided to show the appropriate contexts for the use of the widget in a real application.</p>
<p>Some widget properties are 'dynamic'; that is, an expression can be provided which is then evaluated dynamically on the client so that the widget's property changes as the expression's value changes.</p>
<p>"Client properties" are available for some widgets. These properties may not be specified in the application file itself, but are available on the client during application operation. They often relate to the status of a given widget.</p>
<p>Where possible, sample code is provided for each widget to show how the widget can be used. In most cases the widget's code is displayed in isolation, although in practice widgets can never be used outside of a "widget/page" container widget at some level. In a few cases, a more complete mini-application is shown.</p>
<p>Sample code is generally given in "structure file" format, which is the normal format for the building of applications. However, other suitable object-structured data formats can be used, including XML.</p>
<p>Copyright (c) 1998-2024 LightSys Technology Services, Inc.</p>
<br><p><b>Documentation on the following widgets is available:</b></p>
<table>
<tr>
<td><a href="#autolayout">autolayout</a></td>
<td>Container which automatically positions its children</td>
</tr>
<tr>
<td><a href="#button">button</a></td>
<td>A multipurpose button</td>
</tr>
<tr>
<td><a href="#calendar">calendar</a></td>
<td>Calendar-type view of event/schedule type data in an objectsource</td>
</tr>
<tr>
<td><a href="#chart">chart</a></td>
<td>Chart widget for graphing data from an ObjectSource, using the ChartJS library.</td>
</tr>
<tr>
<td><a href="#checkbox">checkbox</a></td>
<td>Form element capable of selecting an on/off, yes/no, true/false, etc., type of value, via a visual 'check mark'.</td>
</tr>
<tr>
<td><a href="#childwindow">childwindow</a></td>
<td>A dialog or application window which is a lightweight movable container.</td>
</tr>
<tr>
<td><a href="#clock">clock</a></td>
<td>A simple clock widget which displays the current time on the client.</td>
</tr>
<tr>
<td><a href="#component">component</a></td>
<td>A widget which instantiates a custom component</td>
</tr>
<tr>
<td><a href="#component-decl">component-decl</a></td>
<td>A widget which defines a custom component</td>
</tr>
<tr>
<td><a href="#connector">connector</a></td>
<td>A nonvisual widget used to trigger an Action on a widget when an Event on another widget fires.</td>
</tr>
<tr>
<td><a href="#datetime">datetime</a></td>
<td>A visual widget for displaying and editing a date/time type value.</td>
</tr>
<tr>
<td><a href="#dropdown">dropdown</a></td>
<td>A visual widget which allows the user to select one from a number of options in a list which appears when the user clicks on the widget.</td>
</tr>
<tr>
<td><a href="#editbox">editbox</a></td>
<td>A visual widget which allows the entry of one line of textual data.</td>
</tr>
<tr>
<td><a href="#execmethod">execmethod</a></td>
<td>A nonvisual widget which can call ObjectSystem methods on server objects.</td>
</tr>
<tr>
<td><a href="#form">form</a></td>
<td>A nonvisual container used to group a set of form element widgets into a single record or object</td>
</tr>
<tr>
<td><a href="#formstatus">formstatus</a></td>
<td>A specialized visual widget used to display the current mode of a form widget.</td>
</tr>
<tr>
<td><a href="#frameset">frameset</a></td>
<td>A visual container used to create a DHTML frameset within which page widgets can be placed</td>
</tr>
<tr>
<td><a href="#hbox">hbox</a></td>
<td>Container which automatically positions its children</td>
</tr>
<tr>
<td><a href="#hints">hints</a></td>
<td>Contains default values and modifier settings for various components</td>
</tr>
<tr>
<td><a href="#html">html</a></td>
<td>A miniature HTML browser control, capable of viewing and navigating simple web documents.</td>
</tr>
<tr>
<td><a href="#image">image</a></td>
<td>A picture (image).</td>
</tr>
<tr>
<td><a href="#imagebutton">imagebutton</a></td>
<td>A button widget which uses a set of images to control its appearance.</td>
</tr>
<tr>
<td><a href="#label">label</a></td>
<td>Form element capable of displaying text in a child window</td>
</tr>
<tr>
<td><a href="#menu">menu</a></td>
<td>A visual pop-up or drop-down menu widget.</td>
</tr>
<tr>
<td><a href="#osrc">osrc</a></td>
<td>A nonvisual widget which handles data communication between forms/tables and the Centrallix server.</td>
</tr>
<tr>
<td><a href="#page">page</a></td>
<td>The top-level container that represents a Centrallix application.</td>
</tr>
<tr>
<td><a href="#pane">pane</a></td>
<td>A visible rectangular container widget with a border</td>
</tr>
<tr>
<td><a href="#parameter">parameter</a></td>
<td>A declaration of a parameter that can be passed to an application or component</td>
</tr>
<tr>
<td><a href="#radiobuttonpanel">radiobuttonpanel</a></td>
<td>A visual widget displaying a set of 'radio buttons'</td>
</tr>
<tr>
<td><a href="#remotectl">remotectl</a></td>
<td>Nonvisual widget permitting events to be passed in from a remote Centrallix application</td>
</tr>
<tr>
<td><a href="#remotemgr">remotemgr</a></td>
<td>Nonvisual widget permitting the application to send events to a remote Centrallix application</td>
</tr>
<tr>
<td><a href="#repeat">repeat</a></td>
<td>Repeat a subtree of widgets</td>
</tr>
<tr>
<td><a href="#rule">rule</a></td>
<td>Declares a rule - a behavior expected from a widget.</td>
</tr>
<tr>
<td><a href="#scrollbar">scrollbar</a></td>
<td>A scrollbar with a thumb</td>
</tr>
<tr>
<td><a href="#scrollpane">scrollpane</a></td>
<td>A visual container with a scrollbar allowing for content height that exceeds the display area</td>
</tr>
<tr>
<td><a href="#tab">tab</a></td>
<td>A tab (or notebook) widget allowing multiple pages to be layered and individually selected for viewing</td>
</tr>
<tr>
<td><a href="#table">table</a></td>
<td>A visual widget providing a columnar presentation of multiple objects of the same type (such as query result records).</td>
</tr>
<tr>
<td><a href="#template">template</a></td>
<td>templates are a way to provide default values (and default children) of different widget_class's</td>
</tr>
<tr>
<td><a href="#textarea">textarea</a></td>
<td>Visual multi-line text data entry widget.</td>
</tr>
<tr>
<td><a href="#textbutton">textbutton</a></td>
<td>A simple visual button widget built not from images but from a simple text string.</td>
</tr>
<tr>
<td><a href="#timer">timer</a></td>
<td>A nonvisual widget which is used to fire an event when a period of time has elapsed.</td>
</tr>
<tr>
<td><a href="#treeview">treeview</a></td>
<td>A visual widget used to display tree-structured data (such as a directory tree or similar).</td>
</tr>
<tr>
<td><a href="#variable">variable</a></td>
<td>A scalar variable object</td>
</tr>
<tr>
<td><a href="#vbox">vbox</a></td>
<td>Container which automatically positions its children</td>
</tr>
</table>
<br><br>
<!-- PAGE BREAK: 'autolayout.html' -->
<h2 class="widgetname"><a name="autolayout">autolayout</a></h2>
<p class="widgettype">type: <span class="widgettypevalue">widget/autolayout</span></p>
<p class="widgettype">visual: <span class="widgettypevalue">yes</span></p>
<p class="widgettype">container: <span class="widgettypevalue">yes</span></p>
<p class="widgettype">form element: <span class="widgettypevalue">no</span></p>
<h3 class="overview">Overview:</h3>
<span class="overview">
<p>The autolayout widget is used to automatically position widgets without having to explicitly provide x, y, width, and height values for those widgets. Most of the layout in Centrallix is done on a coordinate basis (although the automatic resize logic adjusts those coordinates to fit the target application or component render size). The autolayout widget provides the capability to do nested gui layout in Centrallix, where the coordinate positions of the widgets are computed automatically.</p>
<p>Normally, the autolayout widget is used not as "widget/autolayout", but as "widget/hbox" or "widget/vbox", two synonyms for this widget which also set the layout direction (horizontal or vertical).</p>
<p>A "hbox" widget stacks its children horizontally one after the other, while a "vbox" widget stacks its children vertically from the top down. The spacing between children can be set, and the size of each child can be either independently set per-child, or it can be set by virtue of the geometry of the autolayout widget.</p>
<p>The autolayout widget supports having multiple rows or columns of widgets. That is, if a "vbox" widget fills up vertically, it can resume adding children to a second vertical column should there be space to the right of the original column of widgets. For this to work, the width of the columns (for a vbox) or the height of the rows (for an hbox) must be specified.</p>
</span><h3 class="usage">Usage:</h3>
<span class="usage">
<p>The autolayout widget can occur any place that a visual widget can be placed. As it is a container, it can also contain both visual and nonvisual widgets and containers.</p>
</span><h3 class="properties">Properties:</h3>
<table class="properties">
<tr>
<th class="name">Property</th>
<th class="type">Type</th>
<th class="description">Description</th>
</tr>
<tr>
<td class="name">align</td>
<td class="type">string</td>
<td class="description">Sets the alignment of text can have left (default) right or center.</td>
</tr>
<tr>
<td class="name">cellsize</td>
<td class="type">integer</td>
<td class="description">For an hbox, this is the width to use for the child widgets (unless otherwise specified by the child widget). For a vbox, this refers to the height to use for child widgets unless otherwise specified.</td>
</tr>
<tr>
<td class="name">column_width</td>
<td class="type">integer</td>
<td class="description">This specifies the width of columns for a vbox -- should the first column of widgets fill up, a second column will be started at this offset from the start of the first column.</td>
</tr>
<tr>
<td class="name">height</td>
<td class="type">integer</td>
<td class="description">Height, in pixels, of the autolayout area. If omitted, it defaults to the maximum available height for the given width, without overlapping other visible widgets. If both width and height are unspecified, Centrallix will chose a width and height that maximize the available autolayout area.</td>
</tr>
<tr>
<td class="name">justify</td>
<td class="type">string</td>
<td class="description">Makes the text fill page (justifies text - google it if you need).</td>
</tr>
<tr>
<td class="name">row_height</td>
<td class="type">integer</td>
<td class="description">This specifies the height of rows for an hbox -- should the first row of widgets fill up horizontally, a second row will be started beneath the first one, at this vertical offset from the start of the first row.</td>
</tr>
<tr>
<td class="name">spacing</td>
<td class="type">integer</td>
<td class="description">The spacing, in pixels, between widgets. For an hbox, this refers to the horizontal spacing between children. For a vbox, this refers to the vertical spacing.</td>
</tr>
<tr>
<td class="name">style</td>
<td class="type">string</td>
<td class="description">Either "hbox" or "vbox". Not needed if the widget is created via "widget/hbox" or "widget/vbox".</td>
</tr>
<tr>
<td class="name">x</td>
<td class="type">integer</td>
<td class="description">X-coordinate of the upper left corner of the autolayout area.</td>
</tr>
<tr>
<td class="name">y</td>
<td class="type">integer</td>
<td class="description">Y-coordinate of the upper left corner of the autolayout area.</td>
</tr>
<tr>
<td class="name">width</td>
<td class="type">integer</td>
<td class="description">Width, in pixels, of the autolayout area. If omitted, it defaults to the maximum available width for the given height, without overlapping other visible widgets.</td>
</tr>
</table>
<h3 class="childproperties">Child Properties:</h3>
<p class="childname">(of any child widgets)</p>
<table class="childproperties">
<tr>
<th class="name">Property</th>
<th class="type">Type</th>
<th class="description">Description</th>
</tr>
<tr>
<td class="name">autolayout_order</td>
<td class="type">integer</td>
<td class="description">An optional property, this allows the layout sequence of child widgets to be controlled, and the children are placed in ascending order. If unspecified, this defaults to a value of 100 for the first child encountered, or to N+1 where N is the autolayout sequence of the most recent child widget encountered.</td>
</tr>
<tr>
<td class="name">height</td>
<td class="type">integer</td>
<td class="description">Height, in pixels, of the child.</td>
</tr>
<tr>
<td class="name">width</td>
<td class="type">integer</td>
<td class="description">Width, in pixels, of the child.</td>
</tr>
</table>
<h3 class="sample">Sample Code:</h3>
<pre>
// Here is a vbox which can have up to three
// vertical columns of widgets; the columns will
// fill up one at a time.
vbox1 "widget/vbox"
{
x=0; y=0; width=600; height=200;
spacing=5; column_width=200;
}
</pre>
<!-- PAGE BREAK: 'button.html' -->
<h2 class="widgetname"><a name="button">button</a></h2>
<p class="widgettype">type: <span class="widgettypevalue">widget/button</span></p>
<p class="widgettype">visual: <span class="widgettypevalue">yes</span></p>
<p class="widgettype">container: <span class="widgettypevalue">no</span></p>
<p class="widgettype">form element: <span class="widgettypevalue">no</span></p>
<h3 class="overview">Overview:</h3>
<span class="overview">
<p>Combines the functionality of the textbutton and imagebutton, as well as adding the ability to have both text and image displayed in a button.</p>
</span><h3 class="usage">Usage:</h3>
<span class="usage">
<p>A Button can be placed inside any visible container, but only nonvisual widgets can be placed within it. Properties that don't apply to the button's type are ignored.</p>
</span><h3 class="properties">Properties:</h3>
<table class="properties">
<tr>
<th class="name">Property</th>
<th class="type">Type</th>
<th class="description">Description</th>
</tr>
<tr>
<td class="name">bgcolor</td>
<td class="type">string</td>
<td class="description">A color, RGB or named, to be used as the button's background.If neither bgcolor nor background are specified, the button is transparent.</td>
</tr>
<tr>
<td class="name">clickimage</td>
<td class="type">string</td>
<td class="description">The ObjectSystem pathname of the image to be shown when the user clicks the imagebutton. Defaults to 'image' if not specified.</td>
</tr>
<tr>
<td class="name">disable_color</td>
<td class="type">string</td>
<td class="description">A color, RGB or named, to be used for the button's text when it is disabled.</td>
</tr>
<tr>
<td class="name">disabledimage</td>
<td class="type">string</td>
<td class="description">The ObjectSystem pathname of the image to be shown when the imagebutton is disabled. Defaults to 'image' if not specified.</td>
</tr>
<tr>
<td class="name">enabled</td>
<td class="type">yes/no or expr</td>
<td class="description">Whether the button is enabled (can be clicked). Default is 'yes'. Also supports dynamic runclient() expressions allowing the enabled status of the button to follow the value of an expression.</td>
</tr>
<tr>
<td class="name">fgcolor1</td>
<td class="type">string</td>
<td class="description">A color, RGB or named, for the text on the button. Default "white".</td>
</tr>
<tr>
<td class="name">fgcolor2</td>
<td class="type">string</td>
<td class="description">A color, RGB or named, for the text's 1-pixel drop-shadow. Default "black".</td>
</tr>
<tr>
<td class="name">height</td>
<td class="type">integer</td>
<td class="description">Height, in pixels, of the text button.</td>
</tr>
<tr>
<td class="name">image</td>
<td class="type">string</td>
<td class="description">The pathname of the image to be shown when the button is "idle".</td>
</tr>
<tr>
<td class="name">pointimage</td>
<td class="type">string</td>
<td class="description">The pathname of the image to be shown when the button is pointed-to. Defaults to the 'image' if not specified.</td>
</tr>
<tr>
<td class="name">spacing</td>
<td class="type">integer</td>
<td class="description">The distance between the image and text if applicable.</td>
</tr>
<tr>
<td class="name">text</td>
<td class="type">string</td>
<td class="description">The text to appear on the button.</td>
</tr>
<tr>
<td class="name">tristate</td>
<td class="type">yes/no</td>
<td class="description">Whether or not the button is tri-state (does not display a raised border until the user points at it). Default is yes.</td>
</tr>
<tr>
<td class="name">type</td>
<td class="type">string</td>
<td class="description">There are currently 7 different types. 1) text 2) image 3) topimage (image above text) 4) rightimage 5) leftimage 6) bottomimage 7) textoverimage (text over image background).</td>
</tr>
<tr>
<td class="name">width</td>
<td class="type">integer</td>
<td class="description">The width, in pixels, of the text button.</td>
</tr>
<tr>
<td class="name">x</td>
<td class="type">integer</td>
<td class="description">X-coordinate of the upper left corner of the button, relative to its container.</td>
</tr>
<tr>
<td class="name">y</td>
<td class="type">integer</td>
<td class="description">Y-coordinate of the upper left corner of the button, relative to its container.</td>
</tr>
</table>
<h3 class="events">Events:</h3>
<table class="events">
<tr>
<th class="name">Event</th>
<th class="description">Description</th>
</tr>
<tr>
<td class="name">Click</td>
<td class="description">This event occurs when the user clicks the widget. No parameters are available from this event.</td>
</tr>
<tr>
<td class="name">MouseDown</td>
<td class="description">This event occurs when the user presses the mouse button on the widget. This differs from the 'Click' event in that the user must actually press and release the mouse button on the widget for a Click event to fire, whereas simply pressing the mouse button down will cause the MouseDown event to fire.</td>
</tr>
<tr>
<td class="name">MouseMove</td>
<td class="description">This event occurs when the user moves the mouse pointer while it is over the widget. The event will repeatedly fire each time the pointer moves.</td>
</tr>
<tr>
<td class="name">MouseOver</td>
<td class="description">This event occurs when the user first moves the mouse pointer over the widget. It will not occur again until the user moves the mouse off of the widget and then back over it again.</td>
</tr>
<tr>
<td class="name">MouseOut</td>
<td class="description">This event occurs when the user moves the mouse pointer off of the widget.</td>
</tr>
<tr>
<td class="name">MouseUp</td>
<td class="description">This event occurs when the user releases the mouse button on the widget.</td>
</tr>
</table>
<h3 class="sample">Sample Code:</h3>
<p class="none">none currently available</p>
<!-- PAGE BREAK: 'calendar.html' -->
<h2 class="widgetname"><a name="calendar">calendar</a></h2>
<p class="widgettype">type: <span class="widgettypevalue">widget/calendar</span></p>
<p class="widgettype">visual: <span class="widgettypevalue">yes</span></p>
<p class="widgettype">container: <span class="widgettypevalue">no</span></p>
<p class="widgettype">form element: <span class="widgettypevalue">no</span></p>
<h3 class="overview">Overview:</h3>
<span class="overview">
<p>The calendar widget is used to present event/schedule types of data in a year, month, week, or day format. The data for the events on the calendar is obtained from an objectsource's query results, and as such, can be controlled via queries and other forms/tables associated with the same objectsource. The four formats are listed below and can be selected during app run-time.</p>
<ul>
<li>
<b>Year</b> - Presents twelve months at a time in a low-detail type of setting; when events occur on a day, the day is highlighted, but no more data than that is displayed. If the user points the mouse at a given day, it will display in a popup "tooltip" type of manner the events associated with that day. If more than one year's worth of data is in the objectsource's replica, then multiple years are displayed one after the other. Each year is displayed as four rows of three months each, in traditional calendar format.</li>
<li>
<b>Month</b> - Presents one month's worth of data in a medium-detail display. For each month with data in the objectsource, the calendar will display the month as multiple rows, each row containing one week's worth of days. The calendar will attempt to display the various entries for each day, in order of priority, but will limit the amount of data displayed to keep the boxes for the days approximately visually square. Pointing at a day will show the events for the day in a popup, and pointing at an event in the day will show the details for that event.</li>
<li>
<b>Week</b> - Presents one week's worth of data in a high-detail display. For each week with data in the objectsource, the calendar will display the week as seven days with a large vertical extent capable of displaying all events for the day. The left edge of the display will contain times during the day for the day's events to line up with.</li>
<li>
<b>Day</b> - Presents an entire day's worth of data in a high-detail display. For each day with data in the objectsource, the calendar will display the day in full-width, with the day's events listed chronologically from top to bottom.</li>
</ul>
<p>It should be noted that all of the data for the calendar must fit into the objectsource, or else the calendar will not display all of the available data. In this manner the calendar's display must be controlled via the objectsource's data.</p>
</span><h3 class="usage">Usage:</h3>
<span class="usage">
<p>The calendar widget can be placed inside of any visual container, but because its height can change, it is often placed inside of a scrollpane widget. This widget may not contain other visual widgets.</p>
</span><h3 class="properties">Properties:</h3>
<table class="properties">
<tr>
<th class="name">Property</th>
<th class="type">Type</th>
<th class="description">Description</th>
</tr>
<tr>
<td class="name">background</td>
<td class="type">string</td>
<td class="description">An image for the background of the calendar widget. Should be an ObjectSystem path.</td>
</tr>
<tr>
<td class="name">bgcolor</td>
<td class="type">string</td>
<td class="description">A color, either named or numeric (RGB), for the background of the calendar. If neither bgcolor nor background are specified, the calendar's background is transparent.</td>
</tr>
<tr>
<td class="name">displaymode</td>
<td class="type">string</td>
<td class="description">The visual display mode of the calendar - can be 'year', 'month', 'week', or 'day' (see the overview, above, for details on these modes). Defaults to 'year'.</td>
</tr>
<tr>
<td class="name">eventdatefield</td>
<td class="type">string</td>
<td class="description">The name of the date/time field in the datasource containing the event date/time. A mandatory field.</td>
</tr>
<tr>
<td class="name">eventdescfield</td>
<td class="type">string</td>
<td class="description">The name of the string field in the datasource containing the event's full description. If not supplied, descriptions will be omitted.</td>
</tr>
<tr>
<td class="name">eventnamefield</td>
<td class="type">string</td>
<td class="description">The name of the string field in the datasource containing the event's short name. A mandatory field.</td>
</tr>
<tr>
<td class="name">eventpriofield</td>
<td class="type">string</td>
<td class="description">The name of the integer field in the datasource containing the event's priority. If not supplied, priority checking is disabled.</td>
</tr>
<tr>
<td class="name">height</td>
<td class="type">integer</td>
<td class="description">The height of the calendar, in pixels. If not specified, the calendar may grow vertically an indefinite amount in order to display its given data. If specified, however, the calendar will be limited to that size.</td>
</tr>
<tr>
<td class="name">minpriority</td>
<td class="type">integer</td>
<td class="description">The minimum priority level for events that will be displayed on the calendar; the values for this integer depend on the nature of the 'priority' field in the data source; only events with priority values numerically higher than or equal to this minimum priority will be displayed. Defaults to 0.</td>
</tr>
<tr>
<td class="name">textcolor</td>
<td class="type">string</td>
<td class="description">The color of the words in the calendar.</td>
</tr>
<tr>
<td class="name">width</td>
<td class="type">integer</td>
<td class="description">The width of the calendar, in pixels.</td>
</tr>
<tr>
<td class="name">x</td>
<td class="type">integer</td>
<td class="description">X-coordinate of the upper left corner of the calendar, default is 0.</td>
</tr>
<tr>
<td class="name">y</td>
<td class="type">integer</td>
<td class="description">Y-coordinate of the upper left corner of the calendar, default is 0.</td>
</tr>
</table>
<h3 class="events">Events:</h3>
<table class="events">
<tr>
<th class="name">Event</th>
<th class="description">Description</th>
</tr>
<tr>
<td class="name">MouseDown</td>
<td class="description">This event occurs when the user presses the mouse button on the widget. This differs from the 'Click' event in that the user must actually press and release the mouse button on the widget for a Click event to fire, whereas simply pressing the mouse button down will cause the MouseDown event to fire.</td>
</tr>
<tr>
<td class="name">MouseMove</td>
<td class="description">This event occurs when the user moves the mouse pointer while it is over the widget. The event will repeatedly fire each time the pointer moves.</td>
</tr>
<tr>
<td class="name">MouseOut</td>
<td class="description">This event occurs when the user moves the mouse pointer off of the widget.</td>
</tr>
<tr>
<td class="name">MouseOver</td>
<td class="description">This event occurs when the user first moves the mouse pointer over the widget. It will not occur again until the user moves the mouse off of the widget and then back over it again.</td>
</tr>
<tr>
<td class="name">MouseUp</td>
<td class="description">This event occurs when the user releases the mouse button on the widget.</td>
</tr>
</table>
<h3 class="sample">Sample Code:</h3>
<p class="none">none currently available</p>
<!-- PAGE BREAK: 'chart.html' -->
<h2 class="widgetname"><a name="chart">chart</a></h2>
<p class="widgettype">type: <span class="widgettypevalue">widget/chart</span></p>
<p class="widgettype">visual: <span class="widgettypevalue">yes</span></p>
<p class="widgettype">container: <span class="widgettypevalue">no</span></p>
<p class="widgettype">form element: <span class="widgettypevalue">no</span></p>
<h3 class="overview">Overview:</h3>
<span class="overview">
<p>A chart widget is used to display charts and graphs of data. It uses the Chart.js library.</p>
</span><h3 class="usage">Usage:</h3>
<span class="usage">
<p>The chart widget can be placed inside of any visual container, and will attach itself to any objectsource widget that contains it (whether directly or indirectly). Charts may not contain visual widgets.</p>
</span><h3 class="properties">Properties:</h3>
<table class="properties">
<tr>
<th class="name">Property</th>
<th class="type">Type</th>
<th class="description">Description</th>
</tr>
<tr>
<td class="name">chart_type</td>
<td class="type">string</td>
<td class="description">Currently supported types are "bar", "line", "scatter", and "pie". Defaults to "bar". Chart.js supports much more than this, so new types could be added with relative ease.</td>
</tr>
<tr>
<td class="name">legend_position</td>
<td class="type">string</td>
<td class="description">The position of the legend on the chart. May be "top", "botton", "left", or "right".</td>
</tr>
<tr>
<td class="name">objectsource</td>
<td class="type">string</td>
<td class="description">The name of the ObjectSource widget which will supply data for the chart. We recommend that you do not specify this directly but instead embed the chart widget within a parent ObjectSource, directly or indirectly. If not specified, the chart will look for an ObjectSource in its parents.</td>
</tr>
<tr>
<td class="name">start_at_zero</td>
<td class="type">boolean</td>
<td class="description">Set to false if you want the y axis to start at the lowest data value. Default is true.</td>
</tr>
<tr>
<td class="name">title</td>
<td class="type">string</td>
<td class="description">The title of the chart. Default is none.</td>
</tr>
<tr>
<td class="name">titlecolor</td>
<td class="type">string</td>
<td class="description">A color, RGB or named, of the chart title.</td>
</tr>
<tr>
<td class="name">title_size</td>
<td class="type">integer</td>
<td class="description">The size, in points, of the title font.</td>
</tr>
</table>
<h3 class="childproperties">Child Properties:</h3>
<p class="childname">(of widget/chart-series child widgets)</p>
<table class="childproperties">
<tr>
<th class="name">Property</th>
<th class="type">Type</th>
<th class="description">Description</th>
</tr>
<tr>
<td class="name">chart_type</td>
<td class="type">string</td>
<td class="description">Chart.js has limited support for having multiple chart types on the same axes. The outer chart type must still be specified if this is set.</td>
</tr>
<tr>
<td class="name">color</td>
<td class="type">string</td>
<td class="description">A color, RGB or named, for the chart element (ex: line) which represents this series.</td>
</tr>
<tr>
<td class="name">fill</td>
<td class="type">boolean</td>
<td class="description">Set to false to remove the color fill beneath a line chart. Default is true.</td>
</tr>
<tr>
<td class="name">label</td>
<td class="type">string</td>
<td class="description">A label for the data series.</td>
</tr>
<tr>
<td class="name">x_column</td>
<td class="type">string</td>
<td class="description">Which column in the data should be used for the x axis? By default, the chart will pick one for you.</td>
</tr>
<tr>
<td class="name">y_column</td>
<td class="type">string</td>
<td class="description">Which column in the data should be used for the y axis? By default, the chart will pick one for you.</td>
</tr>
</table>
<p class="childname">(of widget/chart-axis child widgets)</p>
<table class="childproperties">
<tr>
<th class="name">Property</th>
<th class="type">Type</th>
<th class="description">Description</th>
</tr>
<tr>
<td class="name">axis</td>
<td class="type">string</td>
<td class="description">Which axis is this? Possible values are "x" and "y". Default is "x".</td>
</tr>
<tr>
<td class="name">label</td>
<td class="type">string</td>
<td class="description">A label for the axis. Default is none.</td>
</tr>
</table>
<h3 class="sample">Sample Code:</h3>
<pre>
$Version=2$
// Here is a simple chart.
chart "widget/chart"
{
x=0; y=0;
width=483;
height=650;
chart_type="bar";
title="Sample Chart";
titlecolor="black";
legend_position="right";
series1 "widget/chart-series" { color="blue"; }
series2 "widget/chart-series"
{
fill=no;
chart_type="line";
x_column="name";
y_column="permissions";
}
x_axis "widget/chart-axis" { axis="x"; label="X"; }
}
</pre>
<!-- PAGE BREAK: 'checkbox.html' -->
<h2 class="widgetname"><a name="checkbox">checkbox</a></h2>
<p class="widgettype">type: <span class="widgettypevalue">widget/checkbox</span></p>
<p class="widgettype">visual: <span class="widgettypevalue">yes</span></p>
<p class="widgettype">container: <span class="widgettypevalue">no</span></p>
<p class="widgettype">form element: <span class="widgettypevalue">yes</span></p>
<h3 class="overview">Overview:</h3>
<span class="overview">
<p>The checkbox widget is used to display a value that can be either true or false (or on/off, yes/no, etc.).It displays as a simple clickable check box.</p>
</span><h3 class="usage">Usage:</h3>
<span class="usage">
<p>The checkbox widget can be placed inside of any visual container, and will attach itself to any form widget that contains it (whether directly or indirectly). Checkboxes may not contain visual widgets.</p>
</span><h3 class="properties">Properties:</h3>
<table class="properties">
<tr>
<th class="name">Property</th>
<th class="type">Type</th>
<th class="description">Description</th>
</tr>
<tr>
<td class="name">checked</td>
<td class="type">yes/no</td>
<td class="description">Whether this checkbox should be initially checked or not. Default 'no'.</td>
</tr>
<tr>
<td class="name">enabled</td>
<td class="type">boolean</td>
<td class="description">This allows the checkbox to be changed.</td>
</tr>
<tr>
<td class="name">fieldname</td>
<td class="type">string</td>
<td class="description">Name of objectsource field that should be associated with this checkbox.</td>
</tr>
<tr>
<td class="name">form</td>
<td class="type">string</td>
<td class="description">The name of the form that this checkbox is associated with.</td>
</tr>
<tr>
<td class="name">x</td>
<td class="type">integer</td>
<td class="description">X-coordinate of the upper left corner of the checkbox, default is 0.</td>
</tr>
<tr>
<td class="name">y</td>
<td class="type">integer</td>
<td class="description">Y-coordinate of the upper left corner of the checkbox, default is 0.</td>
</tr>
</table>
<h3 class="actions">Actions:</h3>
<table class="actions">
<tr>
<th class="name">Action</th>
<th class="description">Description</th>
</tr>
<tr>
<td class="name">SetValue</td>
<td class="description">This takes a given value and sets the check box value to it.</td>
</tr>
</table>
<h3 class="events">Events:</h3>
<table class="events">
<tr>
<th class="name">Event</th>
<th class="description">Description</th>
</tr>
<tr>
<td class="name">Click</td>
<td class="description">This event occurs when the user clicks the checkbox. No parameters are available from this event.</td>
</tr>
<tr>
<td class="name">DataChange</td>
<td class="description">This event occurs when the user has modified the data value of the checkbox (clicked or unclicked it).</td>
</tr>
<tr>
<td class="name">MouseDown</td>
<td class="description">This event occurs when the user presses the mouse button on the checkbox. This differs from the 'Click' event in that the user must actually press and release the mouse button on the checkbox for a Click event to fire, whereas simply pressing the mouse button down will cause the MouseDown event to fire.</td>
</tr>
<tr>
<td class="name">MouseMove</td>
<td class="description">This event occurs when the user moves the mouse pointer while it is over the checkbox. The event will repeatedly fire each time the pointer moves.</td>
</tr>
<tr>
<td class="name">MouseOut</td>
<td class="description">This event occurs when the user moves the mouse pointer off of the checkbox.</td>
</tr>
<tr>
<td class="name">MouseOver</td>
<td class="description">This event occurs when the user first moves the mouse pointer over the checkbox. It will not occur again until the user moves the mouse off of the checkbox and then back over it again.</td>
</tr>
<tr>
<td class="name">MouseUp</td>
<td class="description">This event occurs when the user releases the mouse button on the checkbox.</td>
</tr>
</table>
<h3 class="sample">Sample Code:</h3>
<pre>
$Version=2$
// Here are two checkboxes.
checkbox_test "widget/page"
{
background="/sys/images/slate2.gif";
testcheck2 "widget/checkbox"
{
x = 20; y = 40;
}
testcheck "widget/checkbox"
{
x = 20; y = 20;
}
}
</pre>
<!-- PAGE BREAK: 'childwindow.html' -->
<h2 class="widgetname"><a name="childwindow">childwindow</a></h2>
<p class="widgettype">type: <span class="widgettypevalue">widget/childwindow</span></p>
<p class="widgettype">visual: <span class="widgettypevalue">yes</span></p>
<p class="widgettype">container: <span class="widgettypevalue">yes</span></p>
<p class="widgettype">form element: <span class="widgettypevalue">no</span></p>
<h3 class="overview">Overview:</h3>
<span class="overview">
<p>The childwindow provides the capability of creating a popup dialog or application window within a web page. The window is not actually a separate browser window, but rather a movable container that can appear "floating" above the rest of the Centrallix application.They can take on one of two styles;"dialog" and "window", which currently relate only to how the window border and titlebar are drawn. The windows support windowshading (double-clicking on the titlebar to "rollup" or "rolldown" the window contents).</p>
<p>These "windows" currently do not support multiple instantiation.</p>
</span><h3 class="usage">Usage:</h3>
<span class="usage">
<p>Childwindows are normally coded at the top-level of an application, since if they are placed within containers, the container limits where the window can be moved (the window is clipped by its container). However, if the "toplevel" property is enabled, then the window floats at the top level of other widgets regardless of the size and location of its container in the application or component (thus the window is not clipped by its container).</p>
<p>These windows can contain other visual and nonvisual widgets.</p>
</span><h3 class="properties">Properties:</h3>
<table class="properties">
<tr>
<th class="name">Property</th>
<th class="type">Type</th>
<th class="description">Description</th>
</tr>
<tr>
<td class="name">background</td>
<td class="type">string</td>
<td class="description">A background image for the body of the window.</td>
</tr>
<tr>
<td class="name">bgcolor</td>
<td class="type">string</td>
<td class="description">A color, RGB or named, to be used as the window body's background.If neither transparent.</td>
</tr>
<tr>
<td class="name">border_color</td>
<td class="type">string</td>
<td class="description">A color that outlines window.</td>
</tr>
<tr>
<td class="name">border_radius</td>
<td class="type">integer</td>
<td class="description">A radius that describes the sharpness of the corners of the window (smaller means sharper).</td>
</tr>
<tr>
<td class="name">border_style</td>
<td class="type">string</td>
<td class="description">Determines the look of the outline.</td>
</tr>
<tr>
<td class="name">closetype</td>
<td class="type">string</td>
<td class="description">Decides wither the screen closes widthwise (1) or heightwise (2).</td>
</tr>
<tr>
<td class="name">gshade</td>
<td class="type">string</td>
<td class="description">Acts as a boolean to declare if the window is shaded or not (all but title bar minimized).</td>
</tr>
<tr>
<td class="name">hdr_background</td>
<td class="type">string</td>
<td class="description">A background image for the titlebar of the window.</td>
</tr>
<tr>
<td class="name">hdr_bgcolor</td>
<td class="type">string</td>
<td class="description">A color, RGB or named, for the titlebar of the window.</td>
</tr>
<tr>
<td class="name">height</td>
<td class="type">integer</td>
<td class="description">Height, in pixels, of the window.</td>
</tr>
<tr>
<td class="name">icon</td>
<td class="type">string</td>
<td class="description">A pathname to an icon to be used in the upper left corner of the window. If unspecified, the default "CX" ichthus icon is used instead.</td>
</tr>
<tr>
<td class="name">modal</td>
<td class="type">yes/no</td>
<td class="description">If "yes", the window is modal (and IsModal need not be passed to "Open"). A modal window will force the user to close the window before anything else in the application can be accessed.</td>
</tr>
<tr>
<td class="name">shadow_angle</td>
<td class="type">integer</td>
<td class="description">The placement of the shadow described as a rotational transformation with respect to the window.</td>
</tr>
<tr>
<td class="name">shadow_color</td>
<td class="type">string</td>
<td class="description">The color of the shadow.</td>
</tr>
<tr>
<td class="name">shadow_radius</td>
<td class="type">integer</td>
<td class="description">A radius that describes the sharpness of the corners of the shadow (smaller means sharper).</td>
</tr>
<tr>
<td class="name">shadow_offset</td>
<td class="type">integer</td>
<td class="description">The placement of the shadow with respect to the window.</td>
</tr>
<tr>
<td class="name">style</td>
<td class="type">string</td>
<td class="description">Either "dialog" or "window", and determines the style of the window's border.</td>