State Class
yui3/src/attribute/js/State.js:1
The State class maintains state for a collection of named items, with a varying number of properties defined.
It avoids the need to create a separate class for the item, and separate instances of these classes for each item, by storing the state in a 2 level hash table, improving performance when the number of items is likely to be large.
Constructor
State
()
Methods
add
-
name -
key -
val
Adds a property to an item.
Parameters:
-
nameStringThe name of the item.
-
keyStringThe name of the property.
-
valAnyThe value of the property.
addAll
-
name -
obj
Adds multiple properties to an item.
Parameters:
-
nameStringThe name of the item.
-
objObjectA hash of property/value pairs.
get
-
name -
key
For a given item, returns the value of the property requested, or undefined if not found.
Parameters:
-
nameStringThe name of the item
-
keyStringOptional. The property value to retrieve.
Returns:
The value of the supplied property.
getAll
-
name -
reference
For the given item, returns an object with all of the item's property/value pairs. By default the object returned is a shallow copy of the stored data, but passing in true as the second parameter will return a reference to the stored data.
Parameters:
-
nameStringThe name of the item
-
referenceBooleantrue, if you want a reference to the stored object
Returns:
An object with property/value pairs for the item.
remove
-
name -
key
Removes a property from an item.
Parameters:
-
nameStringThe name of the item.
-
keyStringThe property to remove.
removeAll
-
name -
obj
Removes multiple properties from an item, or removes the item completely.
Parameters:
-
nameStringThe name of the item.
-
objObject | ArrayCollection of properties to delete. If not provided, the entire item is removed.
Properties
data
Unknown
Hash of attributes