|
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: attribute (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>attribute <span class="subtitle">3.0.0</span></h3> |
|
|
20 |
<a href="./index.html" title="Yahoo! UI Library">Yahoo! UI Library</a> |
|
|
21 |
> <a href="./module_attribute.html" title="attribute">attribute</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: attribute |
|
|
48 |
|
|
|
49 |
|
|
|
50 |
|
|
|
51 |
</h3> |
|
|
52 |
<div class="description summary"> |
|
|
53 |
The attribute module provides an augmentable Attribute implementation, which |
|
|
54 |
adds configurable attributes and attribute change events to the class being |
|
|
55 |
augmented. It also provides a State class, which is used internally by Attribute, |
|
|
56 |
but can also be used independently to provide a name/property/value data structure to |
|
|
57 |
store state. |
|
|
58 |
</div> |
|
|
59 |
|
|
|
60 |
|
|
|
61 |
|
|
|
62 |
<div class="yui-gc"> |
|
|
63 |
<div class="yui-u first"> |
|
|
64 |
|
|
|
65 |
<p>This module contains the following classes:</p> |
|
|
66 |
<script> |
|
|
67 |
//var YUI_CLASS_LIST = [{"extends": {"superclass": {"EventTarget": "EventTarget"}, "events": {}, "configs": {}, "properties": {}, "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"}]}}, "description": "<p>\nAttribute provides configurable attribute support along with attribute change events. It is designed to be \naugmented on to a host class, and provides the host with the ability to configure attributes to store and retrieve state, \nalong with attribute change events.\n</p>\n<p>For example, attributes added to the host can be configured:</p>\n<ul>\n<li>As read only.</li>\n<li>As write once.</li>\n<li>With a setter function, which can be used to manipulate\nvalues passed to Attribute's <a href=\"#method_set\">set</a> method, before they are stored.</li>\n<li>With a getter function, which can be used to manipulate stored values,\nbefore they are returned by Attribute's <a href=\"#method_get\">get</a> method.</li>\n<li>With a validator function, to validate values before they are stored.</li>\n</ul>\n<p>See the <a href=\"#method_addAttr\">addAttr</a> method, for the complete set of configuration\noptions available for attributes</p>.\n<p><strong>NOTE:</strong> Most implementations will be better off extending the <a href=\"Base.html\">Base</a> class, \ninstead of augmenting Attribute directly. Base augments Attribute and will handle the initial configuration \nof attributes for derived classes, accounting for values passed into the constructor.</p>", "guessedname": "Attribute", "name": "Attribute"}, {"extends": {"superclass": {}, "events": {}, "configs": {}, "properties": {}, "methods": {}}, "description": "The State class maintains state for a collection of named items, with \na varying number of properties defined.\nIt avoids the need to create a separate class for the item, and separate instances \nof these classes for each item, by storing the state in a 2 level hash table, \nimproving performance when the number of items is likely to be large.", "guessedname": "State", "name": "State"}]; |
|
|
68 |
</script> |
|
|
69 |
<div id="splash_classList"> |
|
|
70 |
<ul> |
|
|
71 |
<li><a href="Attribute.html" title="Attribute" id="class_0">Attribute</a></li> |
|
|
72 |
<li><a href="State.html" title="State" id="class_1">State</a></li> |
|
|
73 |
</ul> |
|
|
74 |
</div> |
|
|
75 |
</div> |
|
|
76 |
<div class="yui-u"> |
|
|
77 |
<div class="submodules"> |
|
|
78 |
<h4>Submodules:</h4> |
|
|
79 |
<dl> |
|
|
80 |
<dt><code>attribute-complex</code></dt> |
|
|
81 |
<dd>Adds support for attribute providers to handle complex attributes in the constructor</dd> |
|
|
82 |
<dt><code>attribute-base</code></dt> |
|
|
83 |
<dd>The attribute-base submodule provides core attribute handling support, with everything |
|
|
84 |
aside from complex attribute handling in the provider's constructor.</dd> |
|
|
85 |
</dl> |
|
|
86 |
</div> |
|
|
87 |
|
|
|
88 |
</div> |
|
|
89 |
</div> |
|
|
90 |
|
|
|
91 |
</div> |
|
|
92 |
</div> |
|
|
93 |
<div class="yui-b"> |
|
|
94 |
<div class="nav"> |
|
|
95 |
|
|
|
96 |
<div id="moduleList" class="module"> |
|
|
97 |
<h4>Modules</h4> |
|
|
98 |
<ul class="content"> |
|
|
99 |
<li class=""><a href="module_anim.html" title="anim">anim</a></li> |
|
|
100 |
<li class=""><a href="module_async-queue.html" title="async-queue">async-queue</a></li> |
|
|
101 |
<li class="selected"><a href="module_attribute.html" title="attribute">attribute</a></li> |
|
|
102 |
<li class=""><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-promote.html" title="queue-promote">queue-promote</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="Attribute.html" title="Attribute">Attribute</a></li> |
|
|
147 |
<li class=""><a href="State.html" title="State">State</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="Attribute.js.html" title="Attribute.js">Attribute.js</a></li> |
|
|
155 |
<li class=""><a href="ComplexAttribute.js.html" title="ComplexAttribute.js">ComplexAttribute.js</a></li> |
|
|
156 |
<li class=""><a href="State.js.html" title="State.js">State.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": "", "host": "State", "name": "add", "url": "State.html#method_add", "type": "method"}, {"access": "", "host": "State", "name": "addAll", "url": "State.html#method_addAll", "type": "method"}, {"access": "", "host": "Attribute", "name": "addAttr", "url": "Attribute.html#method_addAttr", "type": "method"}, {"access": "private", "host": "Attribute", "name": "_addAttrs", "url": "Attribute.html#method__addAttrs", "type": "method"}, {"access": "", "host": "Attribute", "name": "addAttrs", "url": "Attribute.html#method_addAttrs", "type": "method"}, {"access": "private", "host": "Attribute", "name": "_addLazyAttr", "url": "Attribute.html#method__addLazyAttr", "type": "method"}, {"access": "", "host": "Attribute", "name": "attrAdded", "url": "Attribute.html#method_attrAdded", "type": "method"}, {"access": "protected", "host": "Attribute", "name": "Attribute._ATTR_CFG", "url": "Attribute.html#property_Attribute._ATTR_CFG", "type": "property"}, {"access": "", "host": "Attribute", "name": "Attribute.INVALID_VALUE", "url": "Attribute.html#property_Attribute.INVALID_VALUE", "type": "property"}, {"access": "", "host": "State", "name": "data", "url": "State.html#property_data", "type": "property"}, {"access": "private", "host": "Attribute", "name": "_defAttrChangeFn", "url": "Attribute.html#method__defAttrChangeFn", "type": "method"}, {"access": "private", "host": "Attribute", "name": "_fireAttrChange", "url": "Attribute.html#method__fireAttrChange", "type": "method"}, {"access": "", "host": "Attribute", "name": "get", "url": "Attribute.html#method_get", "type": "method"}, {"access": "", "host": "State", "name": "get", "url": "State.html#method_get", "type": "method"}, {"access": "", "host": "State", "name": "getAll", "url": "State.html#method_getAll", "type": "method"}, {"access": "protected", "host": "Attribute", "name": "_getAttr", "url": "Attribute.html#method__getAttr", "type": "method"}, {"access": "private", "host": "Attribute", "name": "_getAttrInitVal", "url": "Attribute.html#method__getAttrInitVal", "type": "method"}, {"access": "protected", "host": "Attribute", "name": "_getAttrs", "url": "Attribute.html#method__getAttrs", "type": "method"}, {"access": "", "host": "Attribute", "name": "getAttrs", "url": "Attribute.html#method_getAttrs", "type": "method"}, {"access": "private", "host": "Attribute", "name": "_getStateVal", "url": "Attribute.html#method__getStateVal", "type": "method"}, {"access": "private", "host": "Attribute", "name": "_isLazyAttr", "url": "Attribute.html#method__isLazyAttr", "type": "method"}, {"access": "", "host": "Attribute", "name": "modifyAttr", "url": "Attribute.html#method_modifyAttr", "type": "method"}, {"access": "private", "host": "Attribute", "name": "_normAttrVals", "url": "Attribute.html#method__normAttrVals", "type": "method"}, {"access": "protected", "host": "Attribute", "name": "_protectAttrs", "url": "Attribute.html#method__protectAttrs", "type": "method"}, {"access": "", "host": "State", "name": "remove", "url": "State.html#method_remove", "type": "method"}, {"access": "", "host": "State", "name": "removeAll", "url": "State.html#method_removeAll", "type": "method"}, {"access": "", "host": "Attribute", "name": "removeAttr", "url": "Attribute.html#method_removeAttr", "type": "method"}, {"access": "", "host": "Attribute", "name": "reset", "url": "Attribute.html#method_reset", "type": "method"}, {"access": "protected", "host": "Attribute", "name": "_set", "url": "Attribute.html#method__set", "type": "method"}, {"access": "", "host": "Attribute", "name": "set", "url": "Attribute.html#method_set", "type": "method"}, {"access": "protected", "host": "Attribute", "name": "_setAttr", "url": "Attribute.html#method__setAttr", "type": "method"}, {"access": "protected", "host": "Attribute", "name": "_setAttrs", "url": "Attribute.html#method__setAttrs", "type": "method"}, {"access": "", "host": "Attribute", "name": "setAttrs", "url": "Attribute.html#method_setAttrs", "type": "method"}, {"access": "private", "host": "Attribute", "name": "_setAttrVal", "url": "Attribute.html#method__setAttrVal", "type": "method"}, {"access": "private", "host": "Attribute", "name": "_setStateVal", "url": "Attribute.html#method__setStateVal", "type": "method"}]; |
|
|
174 |
</script> |
|
|
175 |
</body> |
|
|
176 |
</html> |