|
0
|
1 |
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"> |
|
|
2 |
<html xmlns:yui="http://yuilibrary.com/rdf/1.0/yui.rdf#"> |
|
|
3 |
<head> |
|
|
4 |
<meta http-equiv="content-type" content="text/html; charset=UTF-8" /> |
|
|
5 |
<title>API: base (YUI Library)</title> |
|
|
6 |
|
|
|
7 |
<link rel="stylesheet" type="text/css" href="assets/reset-fonts-grids-min.css" /> |
|
|
8 |
<link rel="stylesheet" type="text/css" href="assets/api.css" /> |
|
|
9 |
|
|
|
10 |
<script type="text/javascript" src="assets/api-js"></script> |
|
|
11 |
<script type="text/javascript" src="assets/ac-js"></script> |
|
|
12 |
</head> |
|
|
13 |
|
|
|
14 |
<body id="yahoo-com"> |
|
|
15 |
|
|
|
16 |
<div id="doc3" class="yui-t2"> |
|
|
17 |
<div id="hd"> |
|
|
18 |
<h1><a href="http://developer.yahoo.com/yui/" title="Yahoo! UI Library">Yahoo! UI Library</a></h1> |
|
|
19 |
<h3>base <span class="subtitle">3.0.0b1</span></h3> |
|
|
20 |
<a href="./index.html" title="Yahoo! UI Library">Yahoo! UI Library</a> |
|
|
21 |
> <a href="./module_base.html" title="base">base</a> |
|
|
22 |
|
|
|
23 |
|
|
|
24 |
<form onsubmit="return false"> |
|
|
25 |
<div id="propertysearch"> |
|
|
26 |
Search: <input autocomplete="off" id="searchinput" /> |
|
|
27 |
<div id="searchresults"> |
|
|
28 |
|
|
|
29 |
</div> |
|
|
30 |
</div> |
|
|
31 |
</form> |
|
|
32 |
</div> |
|
|
33 |
|
|
|
34 |
<div id="bd"> |
|
|
35 |
<div id="yui-main"> |
|
|
36 |
<div class="yui-b"> |
|
|
37 |
<form action="#" name="yui-classopts-form" method="get" id="yui-classopts-form"> |
|
|
38 |
<fieldset> |
|
|
39 |
<legend>Filters</legend> |
|
|
40 |
<span class="classopts"><input type="checkbox" name="show_private" id="show_private" /> <label for="show_private">Show Private</label></span> |
|
|
41 |
<span class="classopts"><input type="checkbox" name="show_protected" id="show_protected" /> <label for="show_protected">Show Protected</label></span> |
|
|
42 |
<span class="classopts"><input type="checkbox" name="show_deprecated" id="show_deprecated" /> <label for="show_deprecated">Show Deprecated</label></span> |
|
|
43 |
</fieldset> |
|
|
44 |
</form> |
|
|
45 |
|
|
|
46 |
|
|
|
47 |
<h3>Module: base |
|
|
48 |
|
|
|
49 |
|
|
|
50 |
|
|
|
51 |
</h3> |
|
|
52 |
<div class="description summary"> |
|
|
53 |
The base module provides the Base class, which objects requiring attribute and custom event support can extend. |
|
|
54 |
The module also provides two ways to reuse code - An augmentable Plugin.Host interface which provides plugin support |
|
|
55 |
(which is augmented to the Base class) and Base.build which provides a way to |
|
|
56 |
build custom classes using extensions. |
|
|
57 |
</div> |
|
|
58 |
|
|
|
59 |
|
|
|
60 |
|
|
|
61 |
<div class="yui-gc"> |
|
|
62 |
<div class="yui-u first"> |
|
|
63 |
|
|
|
64 |
<p>This module contains the following classes:</p> |
|
|
65 |
<script> |
|
|
66 |
//var YUI_CLASS_LIST = [{"extends": {"superclass": {"EventTarget": "EventTarget", "Attribute": "Attribute", "Plugin.Host": "Plugin.Host"}, "events": {}, "configs": {}, "properties": {"Attribute": []}, "methods": {"EventTarget": [{"access": "private", "deprecated": false, "name": "_getType"}, {"access": "private", "deprecated": false, "name": "_parseType"}, {"access": "", "deprecated": false, "name": "addTarget"}, {"access": "", "deprecated": false, "name": "after"}, {"access": "", "deprecated": true, "name": "before"}, {"access": "", "deprecated": false, "name": "bubble"}, {"access": "", "deprecated": false, "name": "detach"}, {"access": "", "deprecated": false, "name": "detachAll"}, {"access": "", "deprecated": false, "name": "fire"}, {"access": "", "deprecated": false, "name": "getEvent"}, {"access": "", "deprecated": false, "name": "on"}, {"access": "", "deprecated": false, "name": "publish"}, {"access": "", "deprecated": false, "name": "removeTarget"}, {"access": "", "deprecated": true, "name": "subscribe"}, {"access": "", "deprecated": true, "name": "unsubscribe"}, {"access": "", "deprecated": true, "name": "unsubscribeAll"}], "Attribute": [{"access": "private", "deprecated": false, "name": "_addAttrs"}, {"access": "private", "deprecated": false, "name": "_addLazyAttr"}, {"access": "private", "deprecated": false, "name": "_defAttrChangeFn"}, {"access": "private", "deprecated": false, "name": "_fireAttrChange"}, {"access": "private", "deprecated": false, "name": "_getAttrInitVal"}, {"access": "private", "deprecated": false, "name": "_isLazyAttr"}, {"access": "protected", "deprecated": false, "name": "_set"}, {"access": "protected", "deprecated": false, "name": "_setAttr"}, {"access": "private", "deprecated": false, "name": "_setAttrVal"}, {"access": "private", "deprecated": false, "name": "_splitAttrVals"}, {"access": "", "deprecated": false, "name": "addAttr"}, {"access": "", "deprecated": false, "name": "addAttrs"}, {"access": "", "deprecated": false, "name": "attrAdded"}, {"access": "", "deprecated": false, "name": "get"}, {"access": "", "deprecated": false, "name": "getAttrs"}, {"access": "", "deprecated": false, "name": "modifyAttr"}, {"access": "", "deprecated": false, "name": "removeAttr"}, {"access": "", "deprecated": false, "name": "reset"}, {"access": "", "deprecated": false, "name": "set"}, {"access": "", "deprecated": false, "name": "setAttrs"}], "Plugin.Host": [{"access": "private", "deprecated": false, "name": "_destroyPlugins"}, {"access": "private", "deprecated": false, "name": "_initPlugins"}, {"access": "private", "deprecated": false, "name": "_plug"}, {"access": "private", "deprecated": false, "name": "_unplug"}, {"access": "", "deprecated": false, "name": "hasPlugin"}, {"access": "", "deprecated": false, "name": "plug"}, {"access": "", "deprecated": false, "name": "unplug"}]}}, "description": "<p>\nA base class which objects requiring attributes and custom event support can \nextend. Base also handles the chaining of initializer and destructor methods across \nthe hierarchy as part of object construction and destruction. Additionally, attributes configured \nthrough the static <a href=\"#property_Base.ATTRS\">ATTRS<\/a> property for each class \nin the hierarchy will be initialized by Base.\n<\/p>\n<p>\nThe static <a href=\"#property_Base.NAME\">NAME<\/a> property of each class extending \nfrom Base will be used as the identifier for the class, and is used by Base to prefix \nall events fired by instances of that class.\n<\/p>", "guessedname": "Base", "name": "Base"}, {"extends": {"superclass": {}, "events": {}, "configs": {}, "properties": {}, "methods": {}}, "description": "<p>\nAn augmentable class, which provides the augmented class with the ability to host plugins.\nIt adds <a href=\"#method_plug\">plug<\/a> and <a href=\"#method_unplug\">unplug<\/a> methods to the augmented class, which can \nbe used to add or remove plugins from instances of the class.\n<\/p>\n<p>Plugins can also be added through the constructor configuration object passed to the host class' constructor using\nthe \"plugins\" property. Supported values for the \"plugins\" property are those defined by the <a href=\"#method_plug\">plug<\/a> method. \nFor example the following code would add the AnimPlugin and IOPlugin to Overlay (the plugin host):\n<xmp>\nvar o = new Overlay({plugins: [ AnimPlugin, {fn:IOPlugin, cfg:{section:\"header\"}}]});\n<\/xmp>\n<\/p>\n<p>\nPlug.Host's protected <a href=\"#method_initPlugins\">_initPlugins<\/a> and <a href=\"#method_destroyPlugins\">_destroyPlugins<\/a> \nmethods should be invoked by the host class at the appropriate point in the host's lifecyle. This is done by default for \nthe Base class, so developers extending Base or Widget don't need to do anything to enable plugin support.\n<\/p>", "guessedname": "Plugin.Host", "name": "Plugin.Host"}]; |
|
|
67 |
</script> |
|
|
68 |
<div id="splash_classList"> |
|
|
69 |
<ul> |
|
|
70 |
<li><a href="Base.html" title="Base" id="class_0">Base</a></li> |
|
|
71 |
<li><a href="Plugin.Host.html" title="Plugin.Host" id="class_1">Plugin.Host</a></li> |
|
|
72 |
</ul> |
|
|
73 |
</div> |
|
|
74 |
</div> |
|
|
75 |
<div class="yui-u"> |
|
|
76 |
<div class="submodules"> |
|
|
77 |
<h4>Submodules:</h4> |
|
|
78 |
<dl> |
|
|
79 |
<dt><code>base-base</code></dt> |
|
|
80 |
<dd>The base-base submodule provides the Base class and augmentable Plugin.Host implementation, |
|
|
81 |
without the extension support provided by Base.build.</dd> |
|
|
82 |
<dt><code>base-build</code></dt> |
|
|
83 |
<dd>The base-build submodule provides Base.build functionality, which |
|
|
84 |
can be used to create custom classes, by aggregating extensions onto |
|
|
85 |
a main class.</dd> |
|
|
86 |
</dl> |
|
|
87 |
</div> |
|
|
88 |
|
|
|
89 |
</div> |
|
|
90 |
</div> |
|
|
91 |
|
|
|
92 |
</div> |
|
|
93 |
</div> |
|
|
94 |
<div class="yui-b"> |
|
|
95 |
<div class="nav"> |
|
|
96 |
|
|
|
97 |
<div id="moduleList" class="module"> |
|
|
98 |
<h4>Modules</h4> |
|
|
99 |
<ul class="content"> |
|
|
100 |
<li class=""><a href="module_anim.html" title="anim">anim</a></li> |
|
|
101 |
<li class=""><a href="module_attribute.html" title="attribute">attribute</a></li> |
|
|
102 |
<li class="selected"><a href="module_base.html" title="base">base</a></li> |
|
|
103 |
<li class=""><a href="module_cache.html" title="cache">cache</a></li> |
|
|
104 |
<li class=""><a href="module_classnamemanager.html" title="classnamemanager">classnamemanager</a></li> |
|
|
105 |
<li class=""><a href="module_collection.html" title="collection">collection</a></li> |
|
|
106 |
<li class=""><a href="module_console.html" title="console">console</a></li> |
|
|
107 |
<li class=""><a href="module_console-filters.html" title="console-filters">console-filters</a></li> |
|
|
108 |
<li class=""><a href="module_cookie.html" title="cookie">cookie</a></li> |
|
|
109 |
<li class=""><a href="module_dataschema.html" title="dataschema">dataschema</a></li> |
|
|
110 |
<li class=""><a href="module_datasource.html" title="datasource">datasource</a></li> |
|
|
111 |
<li class=""><a href="module_datatype.html" title="datatype">datatype</a></li> |
|
|
112 |
<li class=""><a href="module_dd.html" title="dd">dd</a></li> |
|
|
113 |
<li class=""><a href="module_dom.html" title="dom">dom</a></li> |
|
|
114 |
<li class=""><a href="module_dump.html" title="dump">dump</a></li> |
|
|
115 |
<li class=""><a href="module_event.html" title="event">event</a></li> |
|
|
116 |
<li class=""><a href="module_event-custom.html" title="event-custom">event-custom</a></li> |
|
|
117 |
<li class=""><a href="module_event-simulate.html" title="event-simulate">event-simulate</a></li> |
|
|
118 |
<li class=""><a href="module_history.html" title="history">history</a></li> |
|
|
119 |
<li class=""><a href="module_imageloader.html" title="imageloader">imageloader</a></li> |
|
|
120 |
<li class=""><a href="module_io.html" title="io">io</a></li> |
|
|
121 |
<li class=""><a href="module_json.html" title="json">json</a></li> |
|
|
122 |
<li class=""><a href="module_node.html" title="node">node</a></li> |
|
|
123 |
<li class=""><a href="module_node-focusmanager.html" title="node-focusmanager">node-focusmanager</a></li> |
|
|
124 |
<li class=""><a href="module_node-menunav.html" title="node-menunav">node-menunav</a></li> |
|
|
125 |
<li class=""><a href="module_oop.html" title="oop">oop</a></li> |
|
|
126 |
<li class=""><a href="module_overlay.html" title="overlay">overlay</a></li> |
|
|
127 |
<li class=""><a href="module_plugin.html" title="plugin">plugin</a></li> |
|
|
128 |
<li class=""><a href="module_profiler.html" title="profiler">profiler</a></li> |
|
|
129 |
<li class=""><a href="module_queue.html" title="queue">queue</a></li> |
|
|
130 |
<li class=""><a href="module_slider.html" title="slider">slider</a></li> |
|
|
131 |
<li class=""><a href="module_stylesheet.html" title="stylesheet">stylesheet</a></li> |
|
|
132 |
<li class=""><a href="module_substitute.html" title="substitute">substitute</a></li> |
|
|
133 |
<li class=""><a href="module_test.html" title="test">test</a></li> |
|
|
134 |
<li class=""><a href="module_widget.html" title="widget">widget</a></li> |
|
|
135 |
<li class=""><a href="module_widget-position.html" title="widget-position">widget-position</a></li> |
|
|
136 |
<li class=""><a href="module_widget-position-ext.html" title="widget-position-ext">widget-position-ext</a></li> |
|
|
137 |
<li class=""><a href="module_widget-stack.html" title="widget-stack">widget-stack</a></li> |
|
|
138 |
<li class=""><a href="module_widget-stdmod.html" title="widget-stdmod">widget-stdmod</a></li> |
|
|
139 |
<li class=""><a href="module_yui.html" title="yui">yui</a></li> |
|
|
140 |
</ul> |
|
|
141 |
</div> |
|
|
142 |
|
|
|
143 |
<div id="classList" class="module"> |
|
|
144 |
<h4>Classes</h4> |
|
|
145 |
<ul class="content"> |
|
|
146 |
<li class=""><a href="Base.html" title="Base">Base</a></li> |
|
|
147 |
<li class=""><a href="Plugin.Host.html" title="Plugin.Host">Plugin.Host</a></li> |
|
|
148 |
</ul> |
|
|
149 |
</div> |
|
|
150 |
|
|
|
151 |
<div id="fileList" class="module"> |
|
|
152 |
<h4>Files</h4> |
|
|
153 |
<ul class="content"> |
|
|
154 |
<li class=""><a href="Base.js.html" title="Base.js">Base.js</a></li> |
|
|
155 |
<li class=""><a href="BaseBuild.js.html" title="BaseBuild.js">BaseBuild.js</a></li> |
|
|
156 |
<li class=""><a href="PluginHost.js.html" title="PluginHost.js">PluginHost.js</a></li> |
|
|
157 |
</ul> |
|
|
158 |
</div> |
|
|
159 |
|
|
|
160 |
|
|
|
161 |
|
|
|
162 |
|
|
|
163 |
|
|
|
164 |
</div> |
|
|
165 |
</div> |
|
|
166 |
</div> |
|
|
167 |
<div id="ft"> |
|
|
168 |
<hr /> |
|
|
169 |
Copyright © 2009 Yahoo! Inc. All rights reserved. |
|
|
170 |
</div> |
|
|
171 |
</div> |
|
|
172 |
<script type="text/javascript"> |
|
|
173 |
ALL_YUI_PROPS = [{"access": "private", "host": "Base", "name": "_aggregateAttrs", "url": "Base.html#method__aggregateAttrs", "type": "method"}, {"access": "private", "host": "Base", "name": "Base._ATTR_CFG", "url": "Base.html#property_Base._ATTR_CFG", "type": "property"}, {"access": "", "host": "Base", "name": "Base.ATTRS", "url": "Base.html#property_Base.ATTRS", "type": "property"}, {"access": "", "host": "Base", "name": "Base.build", "url": "Base.html#method_Base.build", "type": "method"}, {"access": "private", "host": "Base", "name": "Base._buildCfg", "url": "Base.html#property_Base._buildCfg", "type": "property"}, {"access": "", "host": "Base", "name": "Base.NAME", "url": "Base.html#property_Base.NAME", "type": "property"}, {"access": "", "host": "Base", "name": "Base.plug", "url": "Base.html#method_Base.plug", "type": "method"}, {"access": "", "host": "Base", "name": "Base.unplug", "url": "Base.html#method_Base.unplug", "type": "method"}, {"access": "protected", "host": "Base", "name": "_defDestroyFn", "url": "Base.html#method__defDestroyFn", "type": "method"}, {"access": "protected", "host": "Base", "name": "_defInitFn", "url": "Base.html#method__defInitFn", "type": "method"}, {"access": "", "host": "Base", "name": "destroy", "url": "Base.html#method_destroy", "type": "method"}, {"access": "", "host": "Base", "name": "destroy", "url": "Base.html#event_destroy", "type": "event"}, {"access": "", "host": "Base", "name": "destroyed", "url": "Base.html#config_destroyed", "type": "config"}, {"access": "", "host": "Base", "name": "destroyedChange", "url": "Base.html#event_destroyedChange", "type": "event"}, {"access": "private", "host": "Base", "name": "_destroyHierarchy", "url": "Base.html#method__destroyHierarchy", "type": "method"}, {"access": "private", "host": "Plugin.Host", "name": "_destroyPlugins", "url": "Plugin.Host.html#method__destroyPlugins", "type": "method"}, {"access": "private", "host": "Base", "name": "_filterAttrCfs", "url": "Base.html#method__filterAttrCfs", "type": "method"}, {"access": "protected", "host": "Base", "name": "_getAttrCfgs", "url": "Base.html#method__getAttrCfgs", "type": "method"}, {"access": "protected", "host": "Base", "name": "_getClasses", "url": "Base.html#method__getClasses", "type": "method"}, {"access": "", "host": "Plugin.Host", "name": "hasPlugin", "url": "Plugin.Host.html#method_hasPlugin", "type": "method"}, {"access": "", "host": "Base", "name": "init", "url": "Base.html#method_init", "type": "method"}, {"access": "", "host": "Base", "name": "init", "url": "Base.html#event_init", "type": "event"}, {"access": "private", "host": "Base", "name": "_initHierarchy", "url": "Base.html#method__initHierarchy", "type": "method"}, {"access": "private", "host": "Base", "name": "_initHierarchyData", "url": "Base.html#method__initHierarchyData", "type": "method"}, {"access": "", "host": "Base", "name": "initialized", "url": "Base.html#config_initialized", "type": "config"}, {"access": "", "host": "Base", "name": "initializedChange", "url": "Base.html#event_initializedChange", "type": "event"}, {"access": "private", "host": "Plugin.Host", "name": "_initPlugins", "url": "Plugin.Host.html#method__initPlugins", "type": "method"}, {"access": "", "host": "Base", "name": "name", "url": "Base.html#property_name", "type": "property"}, {"access": "private", "host": "Plugin.Host", "name": "_plug", "url": "Plugin.Host.html#method__plug", "type": "method"}, {"access": "", "host": "Plugin.Host", "name": "plug", "url": "Plugin.Host.html#method_plug", "type": "method"}, {"access": "", "host": "Plugin.Host", "name": "Plugin.Host.plug", "url": "Plugin.Host.html#method_Plugin.Host.plug", "type": "method"}, {"access": "", "host": "Plugin.Host", "name": "Plugin.Host.unplug", "url": "Plugin.Host.html#method_Plugin.Host.unplug", "type": "method"}, {"access": "", "host": "Base", "name": "toString", "url": "Base.html#method_toString", "type": "method"}, {"access": "private", "host": "Plugin.Host", "name": "_unplug", "url": "Plugin.Host.html#method__unplug", "type": "method"}, {"access": "", "host": "Plugin.Host", "name": "unplug", "url": "Plugin.Host.html#method_unplug", "type": "method"}]; |
|
|
174 |
</script> |
|
|
175 |
</body> |
|
|
176 |
</html> |