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
|
<!DOCTYPE html><html xmlns:date="http://exslt.org/dates-and-times" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0; user-scalable=0;">
<meta charset="utf-8">
<title>LDAP Account Manager » \htmlTableExtendedInputCheckbox</title>
<meta name="author" content="Mike van Riel">
<meta name="description" content="">
<link href="../css/template.css" rel="stylesheet" media="all">
<script src="../js/jquery-1.7.1.min.js" type="text/javascript"></script><script src="../js/jquery-ui-1.8.2.custom.min.js" type="text/javascript"></script><script src="../js/jquery.mousewheel.min.js" type="text/javascript"></script><script src="../js/bootstrap.js" type="text/javascript"></script><script src="../js/template.js" type="text/javascript"></script><script src="../js/prettify/prettify.min.js" type="text/javascript"></script><link rel="shortcut icon" href="../img/favicon.ico">
<link rel="apple-touch-icon" href="../img/apple-touch-icon.png">
<link rel="apple-touch-icon" sizes="72x72" href="../img/apple-touch-icon-72x72.png">
<link rel="apple-touch-icon" sizes="114x114" href="../img/apple-touch-icon-114x114.png">
</head>
<body>
<div class="navbar navbar-fixed-top">
<div class="navbar-inner"><div class="container">
<a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse"><span class="icon-bar"></span><span class="icon-bar"></span><span class="icon-bar"></span></a><a class="brand" href="../index.html">LDAP Account Manager</a><div class="nav-collapse"><ul class="nav">
<li class="dropdown">
<a href="#api" class="dropdown-toggle" data-toggle="dropdown">
API Documentation <b class="caret"></b></a><ul class="dropdown-menu">
<li><a>Packages</a></li>
<li><a href="../packages/Crypt.html"><i class="icon-folder-open"></i> Crypt</a></li>
<li><a href="../packages/Help.html"><i class="icon-folder-open"></i> Help</a></li>
<li><a href="../packages/LDAP.html"><i class="icon-folder-open"></i> LDAP</a></li>
<li><a href="../packages/Math.html"><i class="icon-folder-open"></i> Math</a></li>
<li><a href="../packages/Net.html"><i class="icon-folder-open"></i> Net</a></li>
<li><a href="../packages/PDF.html"><i class="icon-folder-open"></i> PDF</a></li>
<li><a href="../packages/PHP.html"><i class="icon-folder-open"></i> PHP</a></li>
<li><a href="../packages/configuration.html"><i class="icon-folder-open"></i> configuration</a></li>
<li><a href="../packages/horde.html"><i class="icon-folder-open"></i> horde</a></li>
<li><a href="../packages/lam.html"><i class="icon-folder-open"></i> lam</a></li>
<li><a href="../packages/lib.html"><i class="icon-folder-open"></i> lib</a></li>
<li><a href="../packages/lists.html"><i class="icon-folder-open"></i> lists</a></li>
<li><a href="../packages/main.html"><i class="icon-folder-open"></i> main</a></li>
<li><a href="../packages/metaHTML.html"><i class="icon-folder-open"></i> metaHTML</a></li>
<li><a href="../packages/modules.html"><i class="icon-folder-open"></i> modules</a></li>
<li><a href="../packages/phpLDAPadmin.html"><i class="icon-folder-open"></i> phpLDAPadmin</a></li>
<li><a href="../packages/profiles.html"><i class="icon-folder-open"></i> profiles</a></li>
<li><a href="../packages/selfService.html"><i class="icon-folder-open"></i> selfService</a></li>
<li><a href="../packages/tools.html"><i class="icon-folder-open"></i> tools</a></li>
<li><a href="../packages/types.html"><i class="icon-folder-open"></i> types</a></li>
</ul>
</li>
<li class="dropdown" id="charts-menu">
<a href="#charts" class="dropdown-toggle" data-toggle="dropdown">
Charts <b class="caret"></b></a><ul class="dropdown-menu"><li><a href="../graph_class.html"><i class="icon-list-alt"></i> Class hierarchy diagram</a></li></ul>
</li>
<li class="dropdown" id="reports-menu">
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
Reports <b class="caret"></b></a><ul class="dropdown-menu">
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors
<span class="label label-info">1055</span></a></li>
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers
<ul><li>todo
<span class="label label-info">15</span>
</li></ul></a></li>
<li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements
<span class="label label-info">0</span></a></li>
</ul>
</li>
</ul></div>
</div></div>
<div class="go_to_top"><a href="#___" style="color: inherit">Back to top <i class="icon-upload icon-white"></i></a></div>
</div>
<div id="___" class="container">
<noscript><div class="alert alert-warning">
Javascript is disabled; several features are only available
if Javascript is enabled.
</div></noscript>
<div class="row">
<div class="span4">
<span class="btn-group visibility" data-toggle="buttons-checkbox"><button class="btn public active" title="Show public elements">Public</button><button class="btn protected" title="Show protected elements">Protected</button><button class="btn private" title="Show private elements">Private</button><button class="btn inherited active" title="Show inherited elements">Inherited</button></span><div class="btn-group view pull-right" data-toggle="buttons-radio">
<button class="btn details" title="Show descriptions and method names"><i class="icon-list"></i></button><button class="btn simple" title="Show only method names"><i class="icon-align-justify"></i></button>
</div>
<ul class="side-nav nav nav-list">
<li class="nav-header">
<i class="icon-custom icon-method"></i> Methods</li>
<li class="method public "><a href="#__construct" title="__construct :: Constructor."><span class="description">Constructor.</span><pre>__construct()</pre></a></li>
<li class="method public "><a href="#generateHTML" title="generateHTML :: Prints the HTML code for this element."><span class="description">Prints the HTML code for this element.</span><pre>generateHTML()</pre></a></li>
<li class="method public inherited"><a href="#getAlignmentString" title="getAlignmentString :: Returns the HTML attributes for the alignment."><span class="description">Returns the HTML attributes for the alignment.</span><pre>getAlignmentString()</pre></a></li>
<li class="method public inherited"><a href="#getColspanString" title="getColspanString :: Returns the HTML attribute for the colspan."><span class="description">Returns the HTML attribute for the colspan.</span><pre>getColspanString()</pre></a></li>
<li class="method public inherited"><a href="#getRowspanString" title="getRowspanString :: Returns the HTML attribute for the rowspan."><span class="description">Returns the HTML attribute for the rowspan.</span><pre>getRowspanString()</pre></a></li>
<li class="method public inherited"><a href="#getTableCellCSSClasses" title="getTableCellCSSClasses :: Returns the CSS classes of the surrounding table cell for this element."><span class="description">Returns the CSS classes of the surrounding table cell for this element.</span><pre>getTableCellCSSClasses()</pre></a></li>
<li class="method public inherited"><a href="#setCSSClasses" title="setCSSClasses :: Adds CSS classes to this element."><span class="description">Adds CSS classes to this element.</span><pre>setCSSClasses()</pre></a></li>
<li class="method public inherited"><a href="#setIsEnabled" title="setIsEnabled :: Specifies if this component is enabled and accepts user modification."><span class="description">Specifies if this component is enabled and accepts user modification.</span><pre>setIsEnabled()</pre></a></li>
<li class="method public inherited"><a href="#setTableCellCSSClasses" title="setTableCellCSSClasses :: Adds CSS classes to the surrounding table cell for this element."><span class="description">Adds CSS classes to the surrounding table cell for this element.</span><pre>setTableCellCSSClasses()</pre></a></li>
<li class="method public inherited"><a href="#setTableRowsToHide" title="setTableRowsToHide :: This will hide the given table rows when the checkbox is checked."><span class="description">This will hide the given table rows when the checkbox is checked.</span><pre>setTableRowsToHide()</pre></a></li>
<li class="method public inherited"><a href="#setTableRowsToShow" title="setTableRowsToShow :: This will show the given table rows when the checkbox is checked."><span class="description">This will show the given table rows when the checkbox is checked.</span><pre>setTableRowsToShow()</pre></a></li>
<li class="method public inherited"><a href="#setTransient" title="setTransient :: Specifies that the value should not be automatically saved when used in self service or server profile (default: false)."><span class="description">Specifies that the value should not be automatically saved when used in self service or server profile (default: false).</span><pre>setTransient()</pre></a></li>
<li class="nav-header">
<i class="icon-custom icon-property"></i> Properties</li>
<li class="property public inherited"><a href="#%24alignment" title="$alignment :: alignment when inside a table"><span class="description">alignment when inside a table</span><pre>$alignment</pre></a></li>
<li class="property public inherited"><a href="#%24colspan" title="$colspan :: colspan if inside a table"><span class="description">colspan if inside a table</span><pre>$colspan</pre></a></li>
<li class="property public inherited"><a href="#%24rowspan" title="$rowspan :: rowspan if inside a table"><span class="description">rowspan if inside a table</span><pre>$rowspan</pre></a></li>
<li class="nav-header protected">» Protected</li>
<li class="property protected inherited"><a href="#%24checked" title="$checked :: value"><span class="description">value</span><pre>$checked</pre></a></li>
<li class="property protected inherited"><a href="#%24cssClasses" title="$cssClasses :: CSS classes"><span class="description">CSS classes</span><pre>$cssClasses</pre></a></li>
<li class="property protected inherited"><a href="#%24isEnabled" title="$isEnabled :: enabled or disabled"><span class="description">enabled or disabled</span><pre>$isEnabled</pre></a></li>
<li class="property protected inherited"><a href="#%24name" title="$name :: unique name of input element"><span class="description">unique name of input element</span><pre>$name</pre></a></li>
<li class="property protected inherited"><a href="#%24tableCellCssClasses" title="$tableCellCssClasses :: table cell CSS classes"><span class="description">table cell CSS classes</span><pre>$tableCellCssClasses</pre></a></li>
<li class="property protected inherited"><a href="#%24tableRowsToHide" title="$tableRowsToHide :: list of enclosing table rows to hide when checked"><span class="description">list of enclosing table rows to hide when checked</span><pre>$tableRowsToHide</pre></a></li>
<li class="property protected inherited"><a href="#%24tableRowsToShow" title="$tableRowsToShow :: list of enclosing table rows to show when checked"><span class="description">list of enclosing table rows to show when checked</span><pre>$tableRowsToShow</pre></a></li>
<li class="nav-header private">» Private</li>
<li class="property private "><a href="#%24helpID" title="$helpID :: help ID"><span class="description">help ID</span><pre>$helpID</pre></a></li>
<li class="property private "><a href="#%24label" title="$label :: descriptive label"><span class="description">descriptive label</span><pre>$label</pre></a></li>
<li class="property private "><a href="#%24labelFirst" title="$labelFirst :: specifies if label is printed before the checkbox"><span class="description">specifies if label is printed before the checkbox</span><pre>$labelFirst</pre></a></li>
<li class="property private inherited"><a href="#%24transient" title="$transient :: indicates that this field should not automatically be saved in the self service or server profile"><span class="description">indicates that this field should not automatically be saved in the self service or server profile</span><pre>$transient</pre></a></li>
<li class="nav-header">
<i class="icon-custom icon-constant"></i> Constants</li>
<li class="constant inherited"><a href="#ALIGN_BOTTOM" title="ALIGN_BOTTOM :: align to bottom"><span class="description">align to bottom</span><pre>ALIGN_BOTTOM</pre></a></li>
<li class="constant inherited"><a href="#ALIGN_CENTER" title="ALIGN_CENTER :: align to center"><span class="description">align to center</span><pre>ALIGN_CENTER</pre></a></li>
<li class="constant inherited"><a href="#ALIGN_LEFT" title="ALIGN_LEFT :: align to left"><span class="description">align to left</span><pre>ALIGN_LEFT</pre></a></li>
<li class="constant inherited"><a href="#ALIGN_RIGHT" title="ALIGN_RIGHT :: align to right"><span class="description">align to right</span><pre>ALIGN_RIGHT</pre></a></li>
<li class="constant inherited"><a href="#ALIGN_TOP" title="ALIGN_TOP :: align to top"><span class="description">align to top</span><pre>ALIGN_TOP</pre></a></li>
<li class="constant inherited"><a href="#VALIDATE_NUMERIC" title="VALIDATE_NUMERIC :: validation rule to allow only numbers ([0-9]+)"><span class="description">validation rule to allow only numbers ([0-9]+)</span><pre>VALIDATE_NUMERIC</pre></a></li>
</ul>
</div>
<div class="span8">
<a name="%5ChtmlTableExtendedInputCheckbox" id="\htmlTableExtendedInputCheckbox"></a><ul class="breadcrumb">
<li>
<a href="../index.html"><i class="icon-custom icon-class"></i></a><span class="divider">\</span>
</li>
<li><a href="../namespaces/global.html">global</a></li>
<li class="active">
<span class="divider">\</span><a href="../classes/htmlTableExtendedInputCheckbox.html">htmlTableExtendedInputCheckbox</a>
</li>
</ul>
<div href="../classes/htmlTableExtendedInputCheckbox.html" class="element class">
<p class="short_description">Checkbox with descriptive label and help link.</p>
<div class="details">
<p class="long_description"><p>This is used to build HTML code by using objects.</p></p>
<table class="table table-bordered"><tr>
<th>package</th>
<td><a href="../packages/metaHTML.html">metaHTML</a></td>
</tr></table>
<h3>
<i class="icon-custom icon-method"></i> Methods</h3>
<a name="__construct" id="__construct"></a><div class="element clickable method public __construct" data-toggle="collapse" data-target=".__construct .collapse">
<h2>Constructor.</h2>
<pre>__construct(String $name, boolean $checked, String $label, String $helpID, boolean $labelFirst) </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$name</h4>
<code>String</code><p>unique name</p></div>
<div class="subelement argument">
<h4>$checked</h4>
<code>boolean</code><p>checked</p></div>
<div class="subelement argument">
<h4>$label</h4>
<code>String</code><p>descriptive label</p></div>
<div class="subelement argument">
<h4>$helpID</h4>
<code>String</code><p>help ID</p></div>
<div class="subelement argument">
<h4>$labelFirst</h4>
<code>boolean</code><p>specifies if the label is at the beginning or at the end (optional, default beginning)</p>
</div>
</div></div>
</div>
<a name="generateHTML" id="generateHTML"></a><div class="element clickable method public generateHTML" data-toggle="collapse" data-target=".generateHTML .collapse">
<h2>Prints the HTML code for this element.</h2>
<pre>generateHTML(string $module, array $input, array $values, boolean $restricted, integer $tabindex, string $scope) : array</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$module</h4>
<code>string</code><p>Name of account module</p></div>
<div class="subelement argument">
<h4>$input</h4>
<code>array</code><p>List of meta-HTML elements</p>
</div>
<div class="subelement argument">
<h4>$values</h4>
<code>array</code><p>List of values which override the defaults in $input (name => value)</p>
</div>
<div class="subelement argument">
<h4>$restricted</h4>
<code>boolean</code><p>If true then no buttons will be displayed</p></div>
<div class="subelement argument">
<h4>$tabindex</h4>
<code>integer</code><p>Start value of tabulator index for input fields</p></div>
<div class="subelement argument">
<h4>$scope</h4>
<code>string</code><p>Account type</p></div>
<h3>Returns</h3>
<div class="subelement response">
<code>array</code>List of input field names and their type (name => type)</div>
</div></div>
</div>
<a name="getAlignmentString" id="getAlignmentString"></a><div class="element clickable method public getAlignmentString" data-toggle="collapse" data-target=".getAlignmentString .collapse">
<h2>Returns the HTML attributes for the alignment.</h2>
<pre>getAlignmentString() : String</pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<table class="table table-bordered">
<tr>
<th>inherited_from</th>
<td>\htmlElement::getAlignmentString()</td>
</tr>
<tr>
<th>inherited_from</th>
<td>\htmlInputCheckbox::getAlignmentString()</td>
</tr>
</table>
<h3>Returns</h3>
<div class="subelement response">
<code>String</code>alignment HTML attributes (e.g. align="right" valign="top")</div>
</div></div>
</div>
<a name="getColspanString" id="getColspanString"></a><div class="element clickable method public getColspanString" data-toggle="collapse" data-target=".getColspanString .collapse">
<h2>Returns the HTML attribute for the colspan.</h2>
<pre>getColspanString() : String</pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<table class="table table-bordered">
<tr>
<th>inherited_from</th>
<td>\htmlElement::getColspanString()</td>
</tr>
<tr>
<th>inherited_from</th>
<td>\htmlInputCheckbox::getColspanString()</td>
</tr>
</table>
<h3>Returns</h3>
<div class="subelement response">
<code>String</code>colspan HTML attribute (e.g. colspan=3)</div>
</div></div>
</div>
<a name="getRowspanString" id="getRowspanString"></a><div class="element clickable method public getRowspanString" data-toggle="collapse" data-target=".getRowspanString .collapse">
<h2>Returns the HTML attribute for the rowspan.</h2>
<pre>getRowspanString() : String</pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<table class="table table-bordered">
<tr>
<th>inherited_from</th>
<td>\htmlElement::getRowspanString()</td>
</tr>
<tr>
<th>inherited_from</th>
<td>\htmlInputCheckbox::getRowspanString()</td>
</tr>
</table>
<h3>Returns</h3>
<div class="subelement response">
<code>String</code>rowspan HTML attribute (e.g. rowspan=3)</div>
</div></div>
</div>
<a name="getTableCellCSSClasses" id="getTableCellCSSClasses"></a><div class="element clickable method public getTableCellCSSClasses" data-toggle="collapse" data-target=".getTableCellCSSClasses .collapse">
<h2>Returns the CSS classes of the surrounding table cell for this element.</h2>
<pre>getTableCellCSSClasses() : array</pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<table class="table table-bordered">
<tr>
<th>inherited_from</th>
<td>\htmlElement::getTableCellCSSClasses()</td>
</tr>
<tr>
<th>inherited_from</th>
<td>\htmlInputCheckbox::getTableCellCSSClasses()</td>
</tr>
</table>
<h3>Returns</h3>
<div class="subelement response">
<code>array</code>CSS classes</div>
</div></div>
</div>
<a name="setCSSClasses" id="setCSSClasses"></a><div class="element clickable method public setCSSClasses" data-toggle="collapse" data-target=".setCSSClasses .collapse">
<h2>Adds CSS classes to this element.</h2>
<pre>setCSSClasses(array $classes) </pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<table class="table table-bordered">
<tr>
<th>inherited_from</th>
<td>\htmlElement::setCSSClasses()</td>
</tr>
<tr>
<th>inherited_from</th>
<td>\htmlInputCheckbox::setCSSClasses()</td>
</tr>
</table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$classes</h4>
<code>array</code><p>CSS class names</p></div>
</div></div>
</div>
<a name="setIsEnabled" id="setIsEnabled"></a><div class="element clickable method public setIsEnabled" data-toggle="collapse" data-target=".setIsEnabled .collapse">
<h2>Specifies if this component is enabled and accepts user modification.</h2>
<pre>setIsEnabled(boolean $isEnabled) </pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>\htmlInputCheckbox::setIsEnabled()</td>
</tr></table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$isEnabled</h4>
<code>boolean</code><p>enabled if true</p></div>
</div></div>
</div>
<a name="setTableCellCSSClasses" id="setTableCellCSSClasses"></a><div class="element clickable method public setTableCellCSSClasses" data-toggle="collapse" data-target=".setTableCellCSSClasses .collapse">
<h2>Adds CSS classes to the surrounding table cell for this element.</h2>
<pre>setTableCellCSSClasses(array $classes) </pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<table class="table table-bordered">
<tr>
<th>inherited_from</th>
<td>\htmlElement::setTableCellCSSClasses()</td>
</tr>
<tr>
<th>inherited_from</th>
<td>\htmlInputCheckbox::setTableCellCSSClasses()</td>
</tr>
</table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$classes</h4>
<code>array</code><p>CSS class names</p></div>
</div></div>
</div>
<a name="setTableRowsToHide" id="setTableRowsToHide"></a><div class="element clickable method public setTableRowsToHide" data-toggle="collapse" data-target=".setTableRowsToHide .collapse">
<h2>This will hide the given table rows when the checkbox is checked.</h2>
<pre>setTableRowsToHide(array $tableRowsToHide) </pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"><p>The given IDs can be of any e.g. input element. Starting from this element
the first parent "<tr>" element will be used to show/hide.
<br>
<br>
<br>Example: <tr><td><input type="checkbox" id="mycheckbox"></td></tr>
<br> Using "mycheckbox" will use this "tr" to hide/show.</p></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>\htmlInputCheckbox::setTableRowsToHide()</td>
</tr></table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$tableRowsToHide</h4>
<code>array</code><p>IDs of child elements to hide</p></div>
</div></div>
</div>
<a name="setTableRowsToShow" id="setTableRowsToShow"></a><div class="element clickable method public setTableRowsToShow" data-toggle="collapse" data-target=".setTableRowsToShow .collapse">
<h2>This will show the given table rows when the checkbox is checked.</h2>
<pre>setTableRowsToShow(array $tableRowsToShow) </pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"><p>The given IDs can be of any e.g. input element. Starting from this element
the first parent "<tr>" element will be used to show/hide.
<br>
<br>
<br>Example: <tr><td><input type="checkbox" id="mycheckbox"></td></tr>
<br> Using "mycheckbox" will use this "tr" to hide/show.</p></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>\htmlInputCheckbox::setTableRowsToShow()</td>
</tr></table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$tableRowsToShow</h4>
<code>array</code><p>IDs of child elements to show</p></div>
</div></div>
</div>
<a name="setTransient" id="setTransient"></a><div class="element clickable method public setTransient" data-toggle="collapse" data-target=".setTransient .collapse">
<h2>Specifies that the value should not be automatically saved when used in self service or server profile (default: false).</h2>
<pre>setTransient(boolean $transient) </pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>\htmlInputCheckbox::setTransient()</td>
</tr></table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$transient</h4>
<code>boolean</code><p>transient field</p></div>
</div></div>
</div>
<h3>
<i class="icon-custom icon-property"></i> Properties</h3>
<a name="%24alignment" id="$alignment"> </a><div class="element clickable property public $alignment" data-toggle="collapse" data-target=".$alignment .collapse">
<h2>alignment when inside a table</h2>
<pre>$alignment </pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<table class="table table-bordered">
<tr>
<th>inherited_from</th>
<td>\htmlElement::$$alignment</td>
</tr>
<tr>
<th>inherited_from</th>
<td>\htmlInputCheckbox::$$alignment</td>
</tr>
</table>
</div></div>
</div>
<a name="%24colspan" id="$colspan"> </a><div class="element clickable property public $colspan" data-toggle="collapse" data-target=".$colspan .collapse">
<h2>colspan if inside a table</h2>
<pre>$colspan </pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<table class="table table-bordered">
<tr>
<th>inherited_from</th>
<td>\htmlElement::$$colspan</td>
</tr>
<tr>
<th>inherited_from</th>
<td>\htmlInputCheckbox::$$colspan</td>
</tr>
</table>
</div></div>
</div>
<a name="%24rowspan" id="$rowspan"> </a><div class="element clickable property public $rowspan" data-toggle="collapse" data-target=".$rowspan .collapse">
<h2>rowspan if inside a table</h2>
<pre>$rowspan </pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<table class="table table-bordered">
<tr>
<th>inherited_from</th>
<td>\htmlElement::$$rowspan</td>
</tr>
<tr>
<th>inherited_from</th>
<td>\htmlInputCheckbox::$$rowspan</td>
</tr>
</table>
</div></div>
</div>
<a name="%24checked" id="$checked"> </a><div class="element clickable property protected $checked" data-toggle="collapse" data-target=".$checked .collapse">
<h2>value</h2>
<pre>$checked </pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>\htmlInputCheckbox::$$checked</td>
</tr></table>
</div></div>
</div>
<a name="%24cssClasses" id="$cssClasses"> </a><div class="element clickable property protected $cssClasses" data-toggle="collapse" data-target=".$cssClasses .collapse">
<h2>CSS classes</h2>
<pre>$cssClasses </pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<table class="table table-bordered">
<tr>
<th>inherited_from</th>
<td>\htmlElement::$$cssClasses</td>
</tr>
<tr>
<th>inherited_from</th>
<td>\htmlInputCheckbox::$$cssClasses</td>
</tr>
</table>
</div></div>
</div>
<a name="%24isEnabled" id="$isEnabled"> </a><div class="element clickable property protected $isEnabled" data-toggle="collapse" data-target=".$isEnabled .collapse">
<h2>enabled or disabled</h2>
<pre>$isEnabled </pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>\htmlInputCheckbox::$$isEnabled</td>
</tr></table>
</div></div>
</div>
<a name="%24name" id="$name"> </a><div class="element clickable property protected $name" data-toggle="collapse" data-target=".$name .collapse">
<h2>unique name of input element</h2>
<pre>$name </pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>\htmlInputCheckbox::$$name</td>
</tr></table>
</div></div>
</div>
<a name="%24tableCellCssClasses" id="$tableCellCssClasses"> </a><div class="element clickable property protected $tableCellCssClasses" data-toggle="collapse" data-target=".$tableCellCssClasses .collapse">
<h2>table cell CSS classes</h2>
<pre>$tableCellCssClasses </pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<table class="table table-bordered">
<tr>
<th>inherited_from</th>
<td>\htmlElement::$$tableCellCssClasses</td>
</tr>
<tr>
<th>inherited_from</th>
<td>\htmlInputCheckbox::$$tableCellCssClasses</td>
</tr>
</table>
</div></div>
</div>
<a name="%24tableRowsToHide" id="$tableRowsToHide"> </a><div class="element clickable property protected $tableRowsToHide" data-toggle="collapse" data-target=".$tableRowsToHide .collapse">
<h2>list of enclosing table rows to hide when checked</h2>
<pre>$tableRowsToHide </pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>\htmlInputCheckbox::$$tableRowsToHide</td>
</tr></table>
</div></div>
</div>
<a name="%24tableRowsToShow" id="$tableRowsToShow"> </a><div class="element clickable property protected $tableRowsToShow" data-toggle="collapse" data-target=".$tableRowsToShow .collapse">
<h2>list of enclosing table rows to show when checked</h2>
<pre>$tableRowsToShow </pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>\htmlInputCheckbox::$$tableRowsToShow</td>
</tr></table>
</div></div>
</div>
<a name="%24helpID" id="$helpID"> </a><div class="element clickable property private $helpID" data-toggle="collapse" data-target=".$helpID .collapse">
<h2>help ID</h2>
<pre>$helpID </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
</div>
<a name="%24label" id="$label"> </a><div class="element clickable property private $label" data-toggle="collapse" data-target=".$label .collapse">
<h2>descriptive label</h2>
<pre>$label </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
</div>
<a name="%24labelFirst" id="$labelFirst"> </a><div class="element clickable property private $labelFirst" data-toggle="collapse" data-target=".$labelFirst .collapse">
<h2>specifies if label is printed before the checkbox</h2>
<pre>$labelFirst </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
</div>
<a name="%24transient" id="$transient"> </a><div class="element clickable property private $transient" data-toggle="collapse" data-target=".$transient .collapse">
<h2>indicates that this field should not automatically be saved in the self service or server profile</h2>
<pre>$transient </pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>\htmlInputCheckbox::$$transient</td>
</tr></table>
</div></div>
</div>
<h3>
<i class="icon-custom icon-constant"></i> Constants</h3>
<a name="ALIGN_BOTTOM" id="ALIGN_BOTTOM"> </a><div class="element clickable constant ALIGN_BOTTOM" data-toggle="collapse" data-target=".ALIGN_BOTTOM .collapse">
<h2>align to bottom</h2>
<pre>ALIGN_BOTTOM </pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<table class="table table-bordered">
<tr>
<th>inherited_from</th>
<td>\htmlElement::ALIGN_BOTTOM</td>
</tr>
<tr>
<th>inherited_from</th>
<td>\htmlInputCheckbox::ALIGN_BOTTOM</td>
</tr>
</table>
</div></div>
</div>
<a name="ALIGN_CENTER" id="ALIGN_CENTER"> </a><div class="element clickable constant ALIGN_CENTER" data-toggle="collapse" data-target=".ALIGN_CENTER .collapse">
<h2>align to center</h2>
<pre>ALIGN_CENTER </pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<table class="table table-bordered">
<tr>
<th>inherited_from</th>
<td>\htmlElement::ALIGN_CENTER</td>
</tr>
<tr>
<th>inherited_from</th>
<td>\htmlInputCheckbox::ALIGN_CENTER</td>
</tr>
</table>
</div></div>
</div>
<a name="ALIGN_LEFT" id="ALIGN_LEFT"> </a><div class="element clickable constant ALIGN_LEFT" data-toggle="collapse" data-target=".ALIGN_LEFT .collapse">
<h2>align to left</h2>
<pre>ALIGN_LEFT </pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<table class="table table-bordered">
<tr>
<th>inherited_from</th>
<td>\htmlElement::ALIGN_LEFT</td>
</tr>
<tr>
<th>inherited_from</th>
<td>\htmlInputCheckbox::ALIGN_LEFT</td>
</tr>
</table>
</div></div>
</div>
<a name="ALIGN_RIGHT" id="ALIGN_RIGHT"> </a><div class="element clickable constant ALIGN_RIGHT" data-toggle="collapse" data-target=".ALIGN_RIGHT .collapse">
<h2>align to right</h2>
<pre>ALIGN_RIGHT </pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<table class="table table-bordered">
<tr>
<th>inherited_from</th>
<td>\htmlElement::ALIGN_RIGHT</td>
</tr>
<tr>
<th>inherited_from</th>
<td>\htmlInputCheckbox::ALIGN_RIGHT</td>
</tr>
</table>
</div></div>
</div>
<a name="ALIGN_TOP" id="ALIGN_TOP"> </a><div class="element clickable constant ALIGN_TOP" data-toggle="collapse" data-target=".ALIGN_TOP .collapse">
<h2>align to top</h2>
<pre>ALIGN_TOP </pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<table class="table table-bordered">
<tr>
<th>inherited_from</th>
<td>\htmlElement::ALIGN_TOP</td>
</tr>
<tr>
<th>inherited_from</th>
<td>\htmlInputCheckbox::ALIGN_TOP</td>
</tr>
</table>
</div></div>
</div>
<a name="VALIDATE_NUMERIC" id="VALIDATE_NUMERIC"> </a><div class="element clickable constant VALIDATE_NUMERIC" data-toggle="collapse" data-target=".VALIDATE_NUMERIC .collapse">
<h2>validation rule to allow only numbers ([0-9]+)</h2>
<pre>VALIDATE_NUMERIC </pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<table class="table table-bordered">
<tr>
<th>inherited_from</th>
<td>\htmlElement::VALIDATE_NUMERIC</td>
</tr>
<tr>
<th>inherited_from</th>
<td>\htmlInputCheckbox::VALIDATE_NUMERIC</td>
</tr>
</table>
</div></div>
</div>
</div>
</div>
</div>
</div>
<div class="row"><footer class="span12">
Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by <a href="http://glyphicons.com/">Glyphicons</a>.<br>
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a10</a> and<br>
generated on 2013-06-17T21:08:44+02:00.<br></footer></div>
</div>
</body>
</html>
|