forked from yui/yui3
-
Notifications
You must be signed in to change notification settings - Fork 1
/
Base.html
1790 lines (1396 loc) · 115 KB
/
Base.html
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
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html xmlns:yui="http://yuilibrary.com/rdf/1.0/yui.rdf#">
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8" />
<title>API: base Base (YUI Library)</title>
<link rel="stylesheet" type="text/css" href="assets/reset-fonts-grids-min.css" />
<link rel="stylesheet" type="text/css" href="assets/api.css" />
<script type="text/javascript" src="assets/api-js"></script>
<script type="text/javascript" src="assets/ac-js"></script>
</head>
<body id="yahoo-com">
<div id="doc3" class="yui-t2">
<div id="hd">
<h1><a href="http://developer.yahoo.com/yui/" title="Yahoo! UI Library">Yahoo! UI Library</a></h1>
<h3>base <span class="subtitle">3.1.0</span></h3>
<a href="./index.html" title="Yahoo! UI Library">Yahoo! UI Library</a>
> <a href="./module_base.html" title="base">base</a>
> Base
<form onsubmit="return false">
<div id="propertysearch">
Search: <input autocomplete="off" id="searchinput" />
<div id="searchresults">
</div>
</div>
</form>
</div>
<div id="bd">
<div id="yui-main">
<div class="yui-b">
<form action="#" name="yui-classopts-form" method="get" id="yui-classopts-form">
<fieldset>
<legend>Filters</legend>
<span class="classopts"><input type="checkbox" name="show_private" id="show_private" /> <label for="show_private">Show Private</label></span>
<span class="classopts"><input type="checkbox" name="show_protected" id="show_protected" /> <label for="show_protected">Show Protected</label></span>
<span class="classopts"><input type="checkbox" name="show_deprecated" id="show_deprecated" /> <label for="show_deprecated">Show Deprecated</label></span>
</fieldset>
</form>
<h2>
Class <b property="yui:name">Base</b>
<span class="extends">
</span>
<span class="extends" rel="yui:extends">
- uses
<span rel="extend" resource="Attribute.html">
<a href="Attribute.html" property="yui:name" title="Attribute">Attribute</a>
</span>
,
<span rel="extend" resource="Plugin.Host.html">
<a href="Plugin.Host.html" property="yui:name" title="Plugin.Host">Plugin.Host</a>
</span>
</span>
</h2>
<!-- class tree goes here -->
<dl class="subclasses" rel="yui:subclasses">
<dt>Known Subclasses:</dt>
<dd>
<span rel="yui:subclass" resource="DataSource.Local.html">
<a href="DataSource.Local.html" property="yui:name" title="DataSource.Local">DataSource.Local</a>
</span>
<span rel="yui:subclass" resource="Widget.html">
<a href="Widget.html" property="yui:name" title="Widget">Widget</a>
</span>
<span rel="yui:subclass" resource="Plugin.Base.html">
<a href="Plugin.Base.html" property="yui:name" title="Plugin.Base">Plugin.Base</a>
</span>
<span rel="yui:subclass" resource="DD.Delegate.html">
<a href="DD.Delegate.html" property="yui:name" title="DD.Delegate">DD.Delegate</a>
</span>
<span rel="yui:subclass" resource="DD.Drop.html">
<a href="DD.Drop.html" property="yui:name" title="DD.Drop">DD.Drop</a>
</span>
<span rel="yui:subclass" resource="ImgLoadGroup.html">
<a href="ImgLoadGroup.html" property="yui:name" title="ImgLoadGroup">ImgLoadGroup</a>
</span>
<span rel="yui:subclass" resource="Plugin.SortScroll.html">
<a href="Plugin.SortScroll.html" property="yui:name" title="Plugin.SortScroll">Plugin.SortScroll</a>
</span>
<span rel="yui:subclass" resource="Plugin.NodeFX.html">
<a href="Plugin.NodeFX.html" property="yui:name" title="Plugin.NodeFX">Plugin.NodeFX</a>
</span>
<span rel="yui:subclass" resource="DD.Scroll.html">
<a href="DD.Scroll.html" property="yui:name" title="DD.Scroll">DD.Scroll</a>
</span>
<span rel="yui:subclass" resource="ImgLoadImgObj.html">
<a href="ImgLoadImgObj.html" property="yui:name" title="ImgLoadImgObj">ImgLoadImgObj</a>
</span>
<span rel="yui:subclass" resource="Plugin.DDConstrained.html">
<a href="Plugin.DDConstrained.html" property="yui:name" title="Plugin.DDConstrained">Plugin.DDConstrained</a>
</span>
<span rel="yui:subclass" resource="DD.Drag.html">
<a href="DD.Drag.html" property="yui:name" title="DD.Drag">DD.Drag</a>
</span>
<span rel="yui:subclass" resource="Plugin.Sortable.html">
<a href="Plugin.Sortable.html" property="yui:name" title="Plugin.Sortable">Plugin.Sortable</a>
</span>
<span rel="yui:subclass" resource="Anim.html">
<a href="Anim.html" property="yui:name" title="Anim">Anim</a>
</span>
<span rel="yui:subclass" resource="Plugin.DDProxy.html">
<a href="Plugin.DDProxy.html" property="yui:name" title="Plugin.DDProxy">Plugin.DDProxy</a>
</span>
<span rel="yui:subclass" resource="DD.DDM.html">
<a href="DD.DDM.html" property="yui:name" title="DD.DDM">DD.DDM</a>
</span>
</dd>
</dl>
<div class="summary description" property="yui:description">
<p>
A base class which objects requiring attributes and custom event support can
extend. Base also handles the chaining of initializer and destructor methods across
the hierarchy as part of object construction and destruction. Additionally, attributes configured
through the static <a href="#property_Base.ATTRS">ATTRS</a> property for each class
in the hierarchy will be initialized by Base.
</p>
<p>
The static <a href="#property_Base.NAME">NAME</a> property of each class extending
from Base will be used as the identifier for the class, and is used by Base to prefix
all events fired by instances of that class.
</p>
</div>
<div class="section constructor details" rel="yui:constructor" resource="#constructor">
<h3 id="constructor">Constructor</h3>
<div class="content">
<div class="detail">
<strong property="yui:name">Base</strong>
<code>
(
config
)
</code>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">config</span>
<<span property="yui:type">Object</span>>
</code>
<span property="yui:description"> Object with configuration property name/value pairs. The object can be
used to provide default values for the objects published attributes.
<p>
The config object can also contain the following non-attribute properties, providing a convenient
way to configure events listeners and plugins for the instance, as part of the constructor call:
</p>
<dl>
<dt>on</dt>
<dd>An event name to listener function map, to register event listeners for the "on" moment of the event. A constructor convenience property for the <a href="Base.html#method_on">on</a> method.</dd>
<dt>after</dt>
<dd>An event name to listener function map, to register event listeners for the "after" moment of the event. A constructor convenience property for the <a href="Base.html#method_after">after</a> method.</dd>
<dt>bubbleTargets</dt>
<dd>An object, or array of objects, to register as bubble targets for bubbled events fired by this instance. A constructor convenience property for the <a href="EventTarget.html#method_addTarget">addTarget</a> method.</dd>
<dt>plugins</dt>
<dd>A plugin, or array of plugins to be plugged into the instance (see PluginHost's plug method for signature details). A constructor convenience property for the <a href="Plugin.Host.html#method_plug">plug</a> method.</dd>
</dl></span>
</dd>
</dl>
</div>
</div>
</div>
</div>
<div rel="yui:properties" resource="#properties">
<div class="section field details">
<h3 id="properties">Properties</h3>
<div class="content">
<div class="private" rel="yui:property" resource="#property_Base._ATTR_CFG">
<h4><a name="property_Base._ATTR_CFG" property="yui:name">Base._ATTR_CFG</a>
- <code>private static <span property="yui:type">Array</span></code>
</h4>
<div class="detail">
<div class="description" property="yui:description">
The list of properties which can be configured for
each attribute (e.g. setter, getter, writeOnce, readOnly etc.)
</div>
</div>
<hr />
</div>
<div class="private" rel="yui:property" resource="#property_Base._buildCfg">
<h4><a name="property_Base._buildCfg" property="yui:name">Base._buildCfg</a>
- <code>private static final <span property="yui:type">Object</span></code>
</h4>
<div class="detail">
<div class="description" property="yui:description">
The build configuration for the Base class.
Defines the static fields which need to be aggregated
when the Base class is used as the main class passed to
the <a href="#method_Base.build">Base.build</a> method.
</div>
</div>
<hr />
</div>
<div class="" rel="yui:property" resource="#property_Base.ATTRS">
<h4><a name="property_Base.ATTRS" property="yui:name">Base.ATTRS</a>
- <code>static <span property="yui:type">Object</span></code>
</h4>
<div class="detail">
<div class="description" property="yui:description">
The default set of attributes which will be available for instances of this class, and
their configuration. In addition to the configuration properties listed by
Attribute's <a href="Attribute.html#method_addAttr">addAttr</a> method, the attribute
can also be configured with a "cloneDefaultValue" property, which defines how the statically
defined value field should be protected ("shallow", "deep" and false are supported values).
By default if the value is an object literal or an array it will be "shallow" cloned, to
protect the default value.
</div>
</div>
<hr />
</div>
<div class="" rel="yui:property" resource="#property_Base.NAME">
<h4><a name="property_Base.NAME" property="yui:name">Base.NAME</a>
- <code>static <span property="yui:type">String</span></code>
</h4>
<div class="detail">
<div class="description" property="yui:description">
<p>
The string to be used to identify instances of
this class, for example in prefixing events.
</p>
<p>
Classes extending Base, should define their own
static NAME property, which should be camelCase by
convention (e.g. MyClass.NAME = "myClass";).
</p>
</div>
</div>
<hr />
</div>
<div class=" deprecated" rel="yui:property" resource="#property_name">
<h4><a name="property_name" property="yui:name">name</a>
- <code><span property="yui:type">String</span></code>
</h4>
<div class="detail">
<div class="description" property="yui:description">
The string used to identify the class of this object.
</div>
</div>
<div class="deprecated" property="yui:deprecated">
<strong>Deprecated:</strong> Use this.constructor.NAME
</div>
<hr />
</div>
</div>
</div>
<div rel="yui:inheritance">
<div class="section field inheritance" rel="yui:superclass" resource="Attribute.html">
<h4>Properties inherited from <a href="Attribute.html" property="yui:name" title="Attribute">Attribute</a>:</h4>
<div class="content" rel="yui:properties">
<code>
</code>
</div>
</div>
</div>
</div>
<div rel="yui:methods" resource="#methods">
<div class="section method details">
<h3 id="methods">Methods</h3>
<div class="content">
<div class="private" rel="yui:method" resource="#method__aggregateAttrs">
<h4>
<a name="method__aggregateAttrs">_aggregateAttrs</a></h4>
<div class="detail" >
<code>
private
Object
<strong property="yui:name">_aggregateAttrs</strong>
(
allAttrs
)
</code>
<div class="description" property="yui:description">
A helper method, used by _initHierarchyData to aggregate
attribute configuration across the instances class hierarchy.
The method will potect the attribute configuration value to protect the statically defined
default value in ATTRS if required (if the value is an object literal, array or the
attribute configuration has cloneDefaultValue set to shallow or deep).
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">allAttrs</span>
<<span property="yui:type">Array</span>>
</code>
<span property="yui:description"> An array of ATTRS definitions across classes in the hierarchy
(subclass first, Base last)</span>
</dd>
</dl>
<dl>
<dt>Returns:
<code property="yui:return">
Object
</code></dt>
<dd property="yui:returnInfo">The aggregate set of ATTRS definitions for the instance</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="protected" rel="yui:method" resource="#method__defDestroyFn">
<h4>
<a name="method__defDestroyFn">_defDestroyFn</a></h4>
<div class="detail" >
<code>
protected
void
<strong property="yui:name">_defDestroyFn</strong>
(
e
)
</code>
<div class="description" property="yui:description">
Default destroy event handler
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">e</span>
<<span property="yui:type">EventFacade</span>>
</code>
<span property="yui:description"> Event object</span>
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="protected" rel="yui:method" resource="#method__defInitFn">
<h4>
<a name="method__defInitFn">_defInitFn</a></h4>
<div class="detail" >
<code>
protected
void
<strong property="yui:name">_defInitFn</strong>
(
e
)
</code>
<div class="description" property="yui:description">
Default init event handler
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">e</span>
<<span property="yui:type">EventFacade</span>>
</code>
<span property="yui:description"> Event object, with a cfg property which
refers to the configuration object passed to the constructor.</span>
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private" rel="yui:method" resource="#method__destroyHierarchy">
<h4>
<a name="method__destroyHierarchy">_destroyHierarchy</a></h4>
<div class="detail" >
<code>
private
void
<strong property="yui:name">_destroyHierarchy</strong>
(
)
</code>
<div class="description" property="yui:description">
Destroys the class hierarchy for this instance by invoking
the descructor method on the prototype of each class in the hierarchy.
</div>
<div class="description">
</div>
</div>
<hr />
</div>
<div class="private" rel="yui:method" resource="#method__filterAttrCfs">
<h4>
<a name="method__filterAttrCfs">_filterAttrCfs</a></h4>
<div class="detail" >
<code>
private
Object
<strong property="yui:name">_filterAttrCfs</strong>
(
clazz
,
allCfgs
)
</code>
<div class="description" property="yui:description">
A helper method used when processing ATTRS across the class hierarchy during
initialization. Returns a disposable object with the attributes defined for
the provided class, extracted from the set of all attributes passed in .
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">clazz</span>
<<span property="yui:type">Function</span>>
</code>
<span property="yui:description"> The class for which the desired attributes are required.</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">allCfgs</span>
<<span property="yui:type">Object</span>>
</code>
<span property="yui:description"> The set of all attribute configurations for this instance.
Attributes will be removed from this set, if they belong to the filtered class, so
that by the time all classes are processed, allCfgs will be empty.</span>
</dd>
</dl>
<dl>
<dt>Returns:
<code property="yui:return">
Object
</code></dt>
<dd property="yui:returnInfo">The set of attributes belonging to the class passed in, in the form
of an object with attribute name/configuration pairs.</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="protected" rel="yui:method" resource="#method__getAttrCfgs">
<h4>
<a name="method__getAttrCfgs">_getAttrCfgs</a></h4>
<div class="detail" >
<code>
protected
Object
<strong property="yui:name">_getAttrCfgs</strong>
(
)
</code>
<div class="description" property="yui:description">
Returns an aggregated set of attribute configurations, by traversing the class hierarchy.
</div>
<div class="description">
<dl>
<dt>Returns:
<code property="yui:return">
Object
</code></dt>
<dd property="yui:returnInfo">The hash of attribute configurations, aggregated across classes in the hierarchy
This value is cached the first time the method, or _getClasses, is invoked. Subsequent invocations return
the cached value.</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="protected" rel="yui:method" resource="#method__getClasses">
<h4>
<a name="method__getClasses">_getClasses</a></h4>
<div class="detail" >
<code>
protected
Function[]
<strong property="yui:name">_getClasses</strong>
(
)
</code>
<div class="description" property="yui:description">
Returns the class hierarchy for this object, with Base being the last class in the array.
</div>
<div class="description">
<dl>
<dt>Returns:
<code property="yui:return">
Function[]
</code></dt>
<dd property="yui:returnInfo">An array of classes (constructor functions), making up the class hierarchy for this object.
This value is cached the first time the method, or _getAttrCfgs, is invoked. Subsequent invocations return the
cached value.</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private" rel="yui:method" resource="#method__initHierarchy">
<h4>
<a name="method__initHierarchy">_initHierarchy</a></h4>
<div class="detail" >
<code>
private
void
<strong property="yui:name">_initHierarchy</strong>
(
userVals
)
</code>
<div class="description" property="yui:description">
Initializes the class hierarchy for the instance, which includes
initializing attributes for each class defined in the class's
static <a href="#property_Base.ATTRS">ATTRS</a> property and
invoking the initializer method on the prototype of each class in the hierarchy.
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">userVals</span>
<<span property="yui:type">Object</span>>
</code>
<span property="yui:description"> Object with configuration property name/value pairs</span>
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private" rel="yui:method" resource="#method__initHierarchyData">
<h4>
<a name="method__initHierarchyData">_initHierarchyData</a></h4>
<div class="detail" >
<code>
private
void
<strong property="yui:name">_initHierarchyData</strong>
(
)
</code>
<div class="description" property="yui:description">
A helper method used by _getClasses and _getAttrCfgs, which determines both
the array of classes and aggregate set of attribute configurations
across the class hierarchy for the instance.
</div>
<div class="description">
</div>
</div>
<hr />
</div>
<div class="" rel="yui:method" resource="#method__preInitEventCfg">
<h4>
<a name="method__preInitEventCfg">_preInitEventCfg</a></h4>
<div class="detail" >
<code>
void
<strong property="yui:name">_preInitEventCfg</strong>
(
config
)
</code>
<div class="description" property="yui:description">
Handles the special on, after and target properties which allow the user to
easily configure on and after listeners as well as bubble targets during
construction, prior to init.
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">config</span>
<<span property="yui:type">Object</span>>
</code>
<span property="yui:description"> The user configuration object</span>
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:method" resource="#method_Base.build">
<h4>
<a name="method_Base.build">Base.build</a></h4>
<div class="detail" >
<code>
static
Function
<strong property="yui:name">Base.build</strong>
(
name
,
main
,
extensions
,
cfg
)
</code>
<div class="description" property="yui:description">
<p>
Builds a custom constructor function (class) from the
main function, and array of extension functions (classes)
provided. The NAME field for the constructor function is
defined by the first argument passed in.
</p>
<p>
The cfg object supports the following properties
</p>
<dl>
<dt>dynamic <boolean></dt>
<dd>
<p>If true (default), a completely new class
is created which extends the main class, and acts as the
host on which the extension classes are augmented.</p>
<p>If false, the extensions classes are augmented directly to
the main class, modifying the main class' prototype.</p>
</dd>
<dt>aggregates <String[]></dt>
<dd>An array of static property names, which will get aggregated
on to the built class, in addition to the default properties build
will always aggregate as defined by the main class' static _buildCfg
property.
</dd>
</dl>
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">name</span>
<<span property="yui:type">Function</span>>
</code>
<span property="yui:description"> The name of the new class. Used to defined the NAME property for the new class.</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">main</span>
<<span property="yui:type">Function</span>>
</code>
<span property="yui:description"> The main class on which to base the built class</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">extensions</span>
<<span property="yui:type">Function[]</span>>
</code>
<span property="yui:description"> The set of extension classes which will be
augmented/aggregated to the built class.</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">cfg</span>
<<span property="yui:type">Object</span>>
</code>
<span property="yui:description"> Optional. Build configuration for the class (see description).</span>
</dd>
</dl>
<dl>
<dt>Returns:
<code property="yui:return">
Function
</code></dt>
<dd property="yui:returnInfo">A custom class, created from the provided main and extension classes</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:method" resource="#method_Base.create">
<h4>
<a name="method_Base.create">Base.create</a></h4>
<div class="detail" >
<code>
static
Function
<strong property="yui:name">Base.create</strong>
(
name
,
main
,
extensions
)
</code>
<div class="description" property="yui:description">
<p>Creates a new class (constructor function) which extends the base class passed in as the second argument,
and mixes in the array of extensions provided.</p>
<p>Prototype properties or methods can be added to the new class, using the px argument (similar to Y.extend).</p>
<p>Static properties or methods can be added to the new class, using the sx argument (similar to Y.extend).</p>
<p>
</p>
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">name</span>
<<span property="yui:type">Function</span>>
</code>
<span property="yui:description"> The name of the newly created class. Used to defined the NAME property for the new class.</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">main</span>
<<span property="yui:type">Function</span>>
</code>
<span property="yui:description"> The base class which the new class should extend. This class needs to be Base or a class derived from base (e.g. Widget).</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">extensions</span>
<<span property="yui:type">Function[]</span>>
</code>
<span property="yui:description"> The list of extensions which will be mixed into the built class.</span>
</dd>
</dl>
<dl>
<dt>Returns:
<code property="yui:return">
Function
</code></dt>
<dd property="yui:returnInfo">The newly created class.</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:method" resource="#method_Base.mix">
<h4>
<a name="method_Base.mix">Base.mix</a></h4>
<div class="detail" >
<code>
static
Function
<strong property="yui:name">Base.mix</strong>
(
main
,
extensions
)
</code>
<div class="description" property="yui:description">
<p>Mixes in a list of extensions to an existing class.</p>
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">main</span>
<<span property="yui:type">Function</span>>
</code>
<span property="yui:description"> The existing class into which the extensions should be mixed. The class needs to be Base or class derived from base (e.g. Widget)</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">extensions</span>
<<span property="yui:type">Function[]</span>>
</code>
<span property="yui:description"> The set of extension classes which will mixed into the existing main class.</span>
</dd>
</dl>
<dl>
<dt>Returns:
<code property="yui:return">
Function
</code></dt>
<dd property="yui:returnInfo">The modified main class, with extensions mixed in.</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:method" resource="#method_Base.plug">
<h4>
<a name="method_Base.plug">Base.plug</a></h4>
<div class="detail" >
<code>
static