Changeset 1514 for trunk/Docs/Element/Element.md

Timestamp:

03/25/08 06:57:04 (2 months ago)

Author:

kamicane

Message:

• minor cleanup
  
• added documentation for Element:store and Element:retrieve
  
• fixed #933
  

Files:

• trunk/Docs/Element/Element.md (modified) (1 diff)

trunk/Docs/Element/Element.md

@@ -1348 +1348 @@
 
         <a></a>
+        
+
+Element Method: store {#Element:store}
+--------------------------------------------------------
+
+Stores an item in the Elements Storage, linked to this Element.
+
+
+### Syntax:
+
+        myElement.store(key, value);
+
+### Arguments:
+
+1. key - (*string*) The key you want to assign to the stored value.
+2. value - (*mixed*) Any value you want to store.
+
+### Returns:
+
+* (*element*) This Element.
+
+### Example:
+
+        $('element').store('someProperty', someValue);
+
+
+Element Method: retrieve {#Element:retrieve}
+--------------------------------------------------------
+
+Retrieves a value from the Elements storage
+
+
+### Syntax:
+
+        myElement.retrieve(key);
+
+### Arguments:
+
+1. key - (*string*) The key you want to retrieve from the storage.
+
+### Returns:
+
+* (*mixed*) The value linked to the key.
+
+### Example:
+
+        $('element').retrieve('someProperty'); // returns someValue (see example above)
+
+