Skip to content
Browse files

released version 1.6.0

  • Loading branch information...
1 parent 3580bae commit 018488f6680863f06741000315064cad243ea405 @podefr podefr committed Sep 7, 2013
Showing with 10,445 additions and 367 deletions.
  1. +342 −0 docs/1.6.0/files.html
  2. +285 −0 docs/1.6.0/index.html
  3. +885 −0 docs/1.6.0/symbols/BindPlugin.html
  4. +747 −0 docs/1.6.0/symbols/EventPlugin.html
  5. +412 −0 docs/1.6.0/symbols/LocalStore.html
  6. +649 −0 docs/1.6.0/symbols/LocationRouter.html
  7. +743 −0 docs/1.6.0/symbols/OObject.html
  8. +633 −0 docs/1.6.0/symbols/PlacePlugin.html
  9. +646 −0 docs/1.6.0/symbols/Plugins.html
  10. +759 −0 docs/1.6.0/symbols/SocketIOTransport.html
  11. +1,176 −0 docs/1.6.0/symbols/Stack.html
  12. +327 −0 docs/1.6.0/symbols/_global_.html
  13. +664 −0 docs/1.6.0/symbols/src/src_Bind.plugin.js.html
  14. +117 −0 docs/1.6.0/symbols/src/src_DomUtils.js.html
  15. +144 −0 docs/1.6.0/symbols/src/src_Event.plugin.js.html
  16. +112 −0 docs/1.6.0/symbols/src/src_LocalStore.js.html
  17. +187 −0 docs/1.6.0/symbols/src/src_LocationRouter.js.html
  18. +205 −0 docs/1.6.0/symbols/src/src_OObject.js.html
  19. +98 −0 docs/1.6.0/symbols/src/src_Place.plugin.js.html
  20. +165 −0 docs/1.6.0/symbols/src/src_Plugins.js.html
  21. +174 −0 docs/1.6.0/symbols/src/src_SocketIOTransport.js.html
  22. +328 −0 docs/1.6.0/symbols/src/src_Stack.js.html
  23. +1 −1 docs/latest/files.html
  24. +1 −1 docs/latest/index.html
  25. +1 −1 docs/latest/symbols/BindPlugin.html
  26. +1 −1 docs/latest/symbols/EventPlugin.html
  27. +1 −1 docs/latest/symbols/LocalStore.html
  28. +107 −3 docs/latest/symbols/LocationRouter.html
  29. +1 −1 docs/latest/symbols/OObject.html
  30. +1 −1 docs/latest/symbols/PlacePlugin.html
  31. +1 −1 docs/latest/symbols/Plugins.html
  32. +1 −1 docs/latest/symbols/SocketIOTransport.html
  33. +96 −1 docs/latest/symbols/Stack.html
  34. +1 −1 docs/latest/symbols/_global_.html
  35. +155 −102 docs/latest/symbols/src/src_LocationRouter.js.html
  36. +279 −251 docs/latest/symbols/src/src_Stack.js.html
  37. BIN release/Olives-1.6.0.tgz
View
342 docs/1.6.0/files.html
@@ -0,0 +1,342 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+ <head>
+ <meta http-equiv="content-type" content="text/html; charset=utf-8" />
+
+ <title>JsDoc Reference - File Index</title>
+ <meta name="generator" content="JsDoc Toolkit" />
+
+ <style type="text/css">
+ /* default.css */
+body
+{
+ font: 12px "Lucida Grande", Tahoma, Arial, Helvetica, sans-serif;
+ width: 800px;
+}
+
+.header
+{
+ clear: both;
+ background-color: #ccc;
+ padding: 8px;
+}
+
+h1
+{
+ font-size: 150%;
+ font-weight: bold;
+ padding: 0;
+ margin: 1em 0 0 .3em;
+}
+
+hr
+{
+ border: none 0;
+ border-top: 1px solid #7F8FB1;
+ height: 1px;
+}
+
+pre.code
+{
+ display: block;
+ padding: 8px;
+ border: 1px dashed #ccc;
+}
+
+#index
+{
+ margin-top: 24px;
+ float: left;
+ width: 160px;
+ position: absolute;
+ left: 8px;
+ background-color: #F3F3F3;
+ padding: 8px;
+}
+
+#content
+{
+ margin-left: 190px;
+ width: 600px;
+}
+
+.classList
+{
+ list-style-type: none;
+ padding: 0;
+ margin: 0 0 0 8px;
+ font-family: arial, sans-serif;
+ font-size: 1em;
+ overflow: auto;
+}
+
+.classList li
+{
+ padding: 0;
+ margin: 0 0 8px 0;
+}
+
+.summaryTable { width: 100%; }
+
+h1.classTitle
+{
+ font-size:170%;
+ line-height:130%;
+}
+
+h2 { font-size: 110%; }
+caption, div.sectionTitle
+{
+ background-color: #7F8FB1;
+ color: #fff;
+ font-size:130%;
+ text-align: left;
+ padding: 2px 6px 2px 6px;
+ border: 1px #7F8FB1 solid;
+}
+
+div.sectionTitle { margin-bottom: 8px; }
+.summaryTable thead { display: none; }
+
+.summaryTable td
+{
+ vertical-align: top;
+ padding: 4px;
+ border-bottom: 1px #7F8FB1 solid;
+ border-right: 1px #7F8FB1 solid;
+}
+
+/*col#summaryAttributes {}*/
+.summaryTable td.attributes
+{
+ border-left: 1px #7F8FB1 solid;
+ width: 140px;
+ text-align: right;
+}
+
+td.attributes, .fixedFont
+{
+ line-height: 15px;
+ color: #002EBE;
+ font-family: "Courier New",Courier,monospace;
+ font-size: 13px;
+}
+
+.summaryTable td.nameDescription
+{
+ text-align: left;
+ font-size: 13px;
+ line-height: 15px;
+}
+
+.summaryTable td.nameDescription, .description
+{
+ line-height: 15px;
+ padding: 4px;
+ padding-left: 4px;
+}
+
+.summaryTable { margin-bottom: 8px; }
+
+ul.inheritsList
+{
+ list-style: square;
+ margin-left: 20px;
+ padding-left: 0;
+}
+
+.detailList {
+ margin-left: 20px;
+ line-height: 15px;
+}
+.detailList dt { margin-left: 20px; }
+
+.detailList .heading
+{
+ font-weight: bold;
+ padding-bottom: 6px;
+ margin-left: 0;
+}
+
+.light, td.attributes, .light a:link, .light a:visited
+{
+ color: #777;
+ font-style: italic;
+}
+
+.fineprint
+{
+ text-align: right;
+ font-size: 10px;
+}
+ </style>
+ </head>
+
+ <body>
+ <div id="header">
+</div>
+
+ <div id="index">
+ <div align="center"><a href="index.html">Class Index</a>
+| <a href="files.html">File Index</a></div>
+<hr />
+<h2>Classes</h2>
+<ul class="classList">
+
+ <li><i><a href="symbols/_global_.html">_global_</a></i></li>
+
+ <li><a href="symbols/BindPlugin.html">BindPlugin</a></li>
+
+ <li><a href="symbols/EventPlugin.html">EventPlugin</a></li>
+
+ <li><a href="symbols/LocalStore.html">LocalStore</a></li>
+
+ <li><a href="symbols/LocationRouter.html">LocationRouter</a></li>
+
+ <li><a href="symbols/OObject.html">OObject</a></li>
+
+ <li><a href="symbols/PlacePlugin.html">PlacePlugin</a></li>
+
+ <li><a href="symbols/Plugins.html">Plugins</a></li>
+
+ <li><a href="symbols/SocketIOTransport.html">SocketIOTransport</a></li>
+
+ <li><a href="symbols/Stack.html">Stack</a></li>
+
+</ul>
+<hr />
+ </div>
+
+ <div id="content">
+ <h1 class="classTitle">File Index</h1>
+
+
+ <div>
+ <h2><a href="symbols/src/src_Bind.plugin.js.html">src/Bind.plugin.js</a></h2>
+
+ <dl>
+
+
+
+
+ </dl>
+ </div>
+ <hr />
+
+ <div>
+ <h2><a href="symbols/src/src_DomUtils.js.html">src/DomUtils.js</a></h2>
+
+ <dl>
+
+
+
+
+ </dl>
+ </div>
+ <hr />
+
+ <div>
+ <h2><a href="symbols/src/src_Event.plugin.js.html">src/Event.plugin.js</a></h2>
+
+ <dl>
+
+
+
+
+ </dl>
+ </div>
+ <hr />
+
+ <div>
+ <h2><a href="symbols/src/src_LocalStore.js.html">src/LocalStore.js</a></h2>
+
+ <dl>
+
+
+
+
+ </dl>
+ </div>
+ <hr />
+
+ <div>
+ <h2><a href="symbols/src/src_LocationRouter.js.html">src/LocationRouter.js</a></h2>
+
+ <dl>
+
+
+
+
+ </dl>
+ </div>
+ <hr />
+
+ <div>
+ <h2><a href="symbols/src/src_OObject.js.html">src/OObject.js</a></h2>
+
+ <dl>
+
+
+
+
+ </dl>
+ </div>
+ <hr />
+
+ <div>
+ <h2><a href="symbols/src/src_Place.plugin.js.html">src/Place.plugin.js</a></h2>
+
+ <dl>
+
+
+
+
+ </dl>
+ </div>
+ <hr />
+
+ <div>
+ <h2><a href="symbols/src/src_Plugins.js.html">src/Plugins.js</a></h2>
+
+ <dl>
+
+
+
+
+ </dl>
+ </div>
+ <hr />
+
+ <div>
+ <h2><a href="symbols/src/src_SocketIOTransport.js.html">src/SocketIOTransport.js</a></h2>
+
+ <dl>
+
+
+
+
+ </dl>
+ </div>
+ <hr />
+
+ <div>
+ <h2><a href="symbols/src/src_Stack.js.html">src/Stack.js</a></h2>
+
+ <dl>
+
+
+
+
+ </dl>
+ </div>
+ <hr />
+
+
+ </div>
+ <div class="fineprint" style="clear:both">
+
+ Documentation generated by <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blankt">JsDoc Toolkit</a> 2.4.0 on Sat Sep 07 2013 17:44:35 GMT+0100 (BST)
+ </div>
+ </body>
+</html>
View
285 docs/1.6.0/index.html
@@ -0,0 +1,285 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+ <head>
+ <meta http-equiv="content-type" content="text/html; charset=utf-8" />
+
+ <title>JsDoc Reference - Index</title>
+ <meta name="generator" content="JsDoc Toolkit" />
+
+ <style type="text/css">
+ /* default.css */
+body
+{
+ font: 12px "Lucida Grande", Tahoma, Arial, Helvetica, sans-serif;
+ width: 800px;
+}
+
+.header
+{
+ clear: both;
+ background-color: #ccc;
+ padding: 8px;
+}
+
+h1
+{
+ font-size: 150%;
+ font-weight: bold;
+ padding: 0;
+ margin: 1em 0 0 .3em;
+}
+
+hr
+{
+ border: none 0;
+ border-top: 1px solid #7F8FB1;
+ height: 1px;
+}
+
+pre.code
+{
+ display: block;
+ padding: 8px;
+ border: 1px dashed #ccc;
+}
+
+#index
+{
+ margin-top: 24px;
+ float: left;
+ width: 160px;
+ position: absolute;
+ left: 8px;
+ background-color: #F3F3F3;
+ padding: 8px;
+}
+
+#content
+{
+ margin-left: 190px;
+ width: 600px;
+}
+
+.classList
+{
+ list-style-type: none;
+ padding: 0;
+ margin: 0 0 0 8px;
+ font-family: arial, sans-serif;
+ font-size: 1em;
+ overflow: auto;
+}
+
+.classList li
+{
+ padding: 0;
+ margin: 0 0 8px 0;
+}
+
+.summaryTable { width: 100%; }
+
+h1.classTitle
+{
+ font-size:170%;
+ line-height:130%;
+}
+
+h2 { font-size: 110%; }
+caption, div.sectionTitle
+{
+ background-color: #7F8FB1;
+ color: #fff;
+ font-size:130%;
+ text-align: left;
+ padding: 2px 6px 2px 6px;
+ border: 1px #7F8FB1 solid;
+}
+
+div.sectionTitle { margin-bottom: 8px; }
+.summaryTable thead { display: none; }
+
+.summaryTable td
+{
+ vertical-align: top;
+ padding: 4px;
+ border-bottom: 1px #7F8FB1 solid;
+ border-right: 1px #7F8FB1 solid;
+}
+
+/*col#summaryAttributes {}*/
+.summaryTable td.attributes
+{
+ border-left: 1px #7F8FB1 solid;
+ width: 140px;
+ text-align: right;
+}
+
+td.attributes, .fixedFont
+{
+ line-height: 15px;
+ color: #002EBE;
+ font-family: "Courier New",Courier,monospace;
+ font-size: 13px;
+}
+
+.summaryTable td.nameDescription
+{
+ text-align: left;
+ font-size: 13px;
+ line-height: 15px;
+}
+
+.summaryTable td.nameDescription, .description
+{
+ line-height: 15px;
+ padding: 4px;
+ padding-left: 4px;
+}
+
+.summaryTable { margin-bottom: 8px; }
+
+ul.inheritsList
+{
+ list-style: square;
+ margin-left: 20px;
+ padding-left: 0;
+}
+
+.detailList {
+ margin-left: 20px;
+ line-height: 15px;
+}
+.detailList dt { margin-left: 20px; }
+
+.detailList .heading
+{
+ font-weight: bold;
+ padding-bottom: 6px;
+ margin-left: 0;
+}
+
+.light, td.attributes, .light a:link, .light a:visited
+{
+ color: #777;
+ font-style: italic;
+}
+
+.fineprint
+{
+ text-align: right;
+ font-size: 10px;
+}
+ </style>
+ </head>
+
+ <body>
+ <div id="header">
+</div>
+
+ <div id="index">
+ <div align="center"><a href="index.html">Class Index</a>
+| <a href="files.html">File Index</a></div>
+<hr />
+<h2>Classes</h2>
+<ul class="classList">
+
+ <li><i><a href="symbols/_global_.html">_global_</a></i></li>
+
+ <li><a href="symbols/BindPlugin.html">BindPlugin</a></li>
+
+ <li><a href="symbols/EventPlugin.html">EventPlugin</a></li>
+
+ <li><a href="symbols/LocalStore.html">LocalStore</a></li>
+
+ <li><a href="symbols/LocationRouter.html">LocationRouter</a></li>
+
+ <li><a href="symbols/OObject.html">OObject</a></li>
+
+ <li><a href="symbols/PlacePlugin.html">PlacePlugin</a></li>
+
+ <li><a href="symbols/Plugins.html">Plugins</a></li>
+
+ <li><a href="symbols/SocketIOTransport.html">SocketIOTransport</a></li>
+
+ <li><a href="symbols/Stack.html">Stack</a></li>
+
+</ul>
+<hr />
+ </div>
+
+ <div id="content">
+ <h1 class="classTitle">Class Index</h1>
+
+
+ <div>
+ <h2><a href="symbols/_global_.html">_global_</a></h2>
+
+ </div>
+ <hr />
+
+ <div>
+ <h2><a href="symbols/BindPlugin.html">BindPlugin</a></h2>
+ This plugin links dom nodes to a model
+ </div>
+ <hr />
+
+ <div>
+ <h2><a href="symbols/EventPlugin.html">EventPlugin</a></h2>
+ Event plugin adds events listeners to DOM nodes.
+ </div>
+ <hr />
+
+ <div>
+ <h2><a href="symbols/LocalStore.html">LocalStore</a></h2>
+ LocalStore is an Emily's Store that can be synchronized with localStorage
+Synchronize the store, reload your page/browser and resynchronize it with the same value
+and it gets restored.
+ </div>
+ <hr />
+
+ <div>
+ <h2><a href="symbols/LocationRouter.html">LocationRouter</a></h2>
+ A locationRouter is a router which navigates to the route defined in the URL and updates this URL
+while navigating.
+ </div>
+ <hr />
+
+ <div>
+ <h2><a href="symbols/OObject.html">OObject</a></h2>
+ OObject is a container for dom elements.
+ </div>
+ <hr />
+
+ <div>
+ <h2><a href="symbols/PlacePlugin.html">PlacePlugin</a></h2>
+ Place plugin places OObject in the DOM.
+ </div>
+ <hr />
+
+ <div>
+ <h2><a href="symbols/Plugins.html">Plugins</a></h2>
+ Plugins is the link between the UI and your plugins.
+ </div>
+ <hr />
+
+ <div>
+ <h2><a href="symbols/SocketIOTransport.html">SocketIOTransport</a></h2>
+ SocketIOTransport allows for client-server eventing.
+ </div>
+ <hr />
+
+ <div>
+ <h2><a href="symbols/Stack.html">Stack</a></h2>
+ A Stack is a tool for managing DOM elements as groups.
+ </div>
+ <hr />
+
+
+ </div>
+ <div class="fineprint" style="clear:both">
+
+ Documentation generated by <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blankt">JsDoc Toolkit</a> 2.4.0 on Sat Sep 07 2013 17:44:35 GMT+0100 (BST)
+ </div>
+ </body>
+</html>
View
885 docs/1.6.0/symbols/BindPlugin.html
@@ -0,0 +1,885 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+ <head>
+ <meta http-equiv="content-type" content="text/html; charset=utf-8" />
+ <meta name="generator" content="JsDoc Toolkit" />
+
+ <title>JsDoc Reference - BindPlugin</title>
+
+ <style type="text/css">
+ /* default.css */
+body
+{
+ font: 12px "Lucida Grande", Tahoma, Arial, Helvetica, sans-serif;
+ width: 800px;
+}
+
+.header
+{
+ clear: both;
+ background-color: #ccc;
+ padding: 8px;
+}
+
+h1
+{
+ font-size: 150%;
+ font-weight: bold;
+ padding: 0;
+ margin: 1em 0 0 .3em;
+}
+
+hr
+{
+ border: none 0;
+ border-top: 1px solid #7F8FB1;
+ height: 1px;
+}
+
+pre.code
+{
+ display: block;
+ padding: 8px;
+ border: 1px dashed #ccc;
+}
+
+#index
+{
+ margin-top: 24px;
+ float: left;
+ width: 160px;
+ position: absolute;
+ left: 8px;
+ background-color: #F3F3F3;
+ padding: 8px;
+}
+
+#content
+{
+ margin-left: 190px;
+ width: 600px;
+}
+
+.classList
+{
+ list-style-type: none;
+ padding: 0;
+ margin: 0 0 0 8px;
+ font-family: arial, sans-serif;
+ font-size: 1em;
+ overflow: auto;
+}
+
+.classList li
+{
+ padding: 0;
+ margin: 0 0 8px 0;
+}
+
+.summaryTable { width: 100%; }
+
+h1.classTitle
+{
+ font-size:170%;
+ line-height:130%;
+}
+
+h2 { font-size: 110%; }
+caption, div.sectionTitle
+{
+ background-color: #7F8FB1;
+ color: #fff;
+ font-size:130%;
+ text-align: left;
+ padding: 2px 6px 2px 6px;
+ border: 1px #7F8FB1 solid;
+}
+
+div.sectionTitle { margin-bottom: 8px; }
+.summaryTable thead { display: none; }
+
+.summaryTable td
+{
+ vertical-align: top;
+ padding: 4px;
+ border-bottom: 1px #7F8FB1 solid;
+ border-right: 1px #7F8FB1 solid;
+}
+
+/*col#summaryAttributes {}*/
+.summaryTable td.attributes
+{
+ border-left: 1px #7F8FB1 solid;
+ width: 140px;
+ text-align: right;
+}
+
+td.attributes, .fixedFont
+{
+ line-height: 15px;
+ color: #002EBE;
+ font-family: "Courier New",Courier,monospace;
+ font-size: 13px;
+}
+
+.summaryTable td.nameDescription
+{
+ text-align: left;
+ font-size: 13px;
+ line-height: 15px;
+}
+
+.summaryTable td.nameDescription, .description
+{
+ line-height: 15px;
+ padding: 4px;
+ padding-left: 4px;
+}
+
+.summaryTable { margin-bottom: 8px; }
+
+ul.inheritsList
+{
+ list-style: square;
+ margin-left: 20px;
+ padding-left: 0;
+}
+
+.detailList {
+ margin-left: 20px;
+ line-height: 15px;
+}
+.detailList dt { margin-left: 20px; }
+
+.detailList .heading
+{
+ font-weight: bold;
+ padding-bottom: 6px;
+ margin-left: 0;
+}
+
+.light, td.attributes, .light a:link, .light a:visited
+{
+ color: #777;
+ font-style: italic;
+}
+
+.fineprint
+{
+ text-align: right;
+ font-size: 10px;
+}
+ </style>
+ </head>
+
+ <body>
+<!-- ============================== header ================================= -->
+ <!-- begin static/header.html -->
+ <div id="header">
+</div>
+ <!-- end static/header.html -->
+
+<!-- ============================== classes index ============================ -->
+ <div id="index">
+ <!-- begin publish.classesIndex -->
+ <div align="center"><a href="../index.html">Class Index</a>
+| <a href="../files.html">File Index</a></div>
+<hr />
+<h2>Classes</h2>
+<ul class="classList">
+
+ <li><i><a href="../symbols/_global_.html">_global_</a></i></li>
+
+ <li><a href="../symbols/BindPlugin.html">BindPlugin</a></li>
+
+ <li><a href="../symbols/EventPlugin.html">EventPlugin</a></li>
+
+ <li><a href="../symbols/LocalStore.html">LocalStore</a></li>
+
+ <li><a href="../symbols/LocationRouter.html">LocationRouter</a></li>
+
+ <li><a href="../symbols/OObject.html">OObject</a></li>
+
+ <li><a href="../symbols/PlacePlugin.html">PlacePlugin</a></li>
+
+ <li><a href="../symbols/Plugins.html">Plugins</a></li>
+
+ <li><a href="../symbols/SocketIOTransport.html">SocketIOTransport</a></li>
+
+ <li><a href="../symbols/Stack.html">Stack</a></li>
+
+</ul>
+<hr />
+ <!-- end publish.classesIndex -->
+ </div>
+
+ <div id="content">
+<!-- ============================== class title ============================ -->
+ <h1 class="classTitle">
+
+ Class BindPlugin
+ </h1>
+
+<!-- ============================== class summary ========================== -->
+ <p class="description">
+
+
+
+ This plugin links dom nodes to a model
+
+
+ <br /><i>Defined in: </i> <a href="../symbols/src/src_Bind.plugin.js.html">Bind.plugin.js</a>.
+
+ </p>
+
+<!-- ============================== constructor summary ==================== -->
+
+ <table class="summaryTable" cellspacing="0" summary="A summary of the constructor documented in the class BindPlugin.">
+ <caption>Class Summary</caption>
+ <thead>
+ <tr>
+ <th scope="col">Constructor Attributes</th>
+ <th scope="col">Constructor Name and Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td class="attributes">&nbsp;</td>
+ <td class="nameDescription" >
+ <div class="fixedFont">
+ <b><a href="../symbols/BindPlugin.html#constructor">BindPlugin</a></b>(Store, Observable, Tools, DomUtils)
+ </div>
+ <div class="description"></div>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+
+
+<!-- ============================== properties summary ===================== -->
+
+
+<!-- ============================== methods summary ======================== -->
+
+
+
+ <table class="summaryTable" cellspacing="0" summary="A summary of the methods documented in the class BindPlugin.">
+ <caption>Method Summary</caption>
+ <thead>
+ <tr>
+ <th scope="col">Method Attributes</th>
+ <th scope="col">Method Name and Description</th>
+ </tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td class="attributes">&nbsp;</td>
+ <td class="nameDescription">
+ <div class="fixedFont"><b><a href="../symbols/BindPlugin.html#addBinding">addBinding</a></b>(name, binding)
+ </div>
+ <div class="description">Add a new way to handle a binding</div>
+ </td>
+ </tr>
+
+ <tr>
+ <td class="attributes">&nbsp;</td>
+ <td class="nameDescription">
+ <div class="fixedFont"><b><a href="../symbols/BindPlugin.html#addBindings">addBindings</a></b>(list)
+ </div>
+ <div class="description">Add multiple binding at once</div>
+ </td>
+ </tr>
+
+ <tr>
+ <td class="attributes">&nbsp;</td>
+ <td class="nameDescription">
+ <div class="fixedFont"><b><a href="../symbols/BindPlugin.html#bind">bind</a></b>(node, name, name)
+ </div>
+ <div class="description">Both ways binding between a dom node attributes and the model</div>
+ </td>
+ </tr>
+
+ <tr>
+ <td class="attributes">&nbsp;</td>
+ <td class="nameDescription">
+ <div class="fixedFont"><b><a href="../symbols/BindPlugin.html#foreach">foreach</a></b>(node, idItemRenderer, start, nb)
+ </div>
+ <div class="description">Expands the inner dom nodes of a given dom node, filling it with model's values</div>
+ </td>
+ </tr>
+
+ <tr>
+ <td class="attributes">&nbsp;</td>
+ <td class="nameDescription">
+ <div class="fixedFont"><b><a href="../symbols/BindPlugin.html#form">form</a></b>(DOMfrom)
+ </div>
+ <div class="description">Prevents the submit and set the model with all form's inputs</div>
+ </td>
+ </tr>
+
+ <tr>
+ <td class="attributes">&nbsp;</td>
+ <td class="nameDescription">
+ <div class="fixedFont"><b><a href="../symbols/BindPlugin.html#refresh">refresh</a></b>(id)
+ </div>
+ <div class="description">Refresh a foreach after having modified its limits</div>
+ </td>
+ </tr>
+
+ <tr>
+ <td class="attributes">&nbsp;</td>
+ <td class="nameDescription">
+ <div class="fixedFont"><b><a href="../symbols/BindPlugin.html#setModel">setModel</a></b>(model)
+ </div>
+ <div class="description">Define the model to watch for</div>
+ </td>
+ </tr>
+
+ <tr>
+ <td class="attributes">&nbsp;</td>
+ <td class="nameDescription">
+ <div class="fixedFont"><b><a href="../symbols/BindPlugin.html#updateNb">updateNb</a></b>(id, nb)
+ </div>
+ <div class="description">Update the number of item to display in a foreach</div>
+ </td>
+ </tr>
+
+ <tr>
+ <td class="attributes">&nbsp;</td>
+ <td class="nameDescription">
+ <div class="fixedFont"><b><a href="../symbols/BindPlugin.html#updateStart">updateStart</a></b>(id, start)
+ </div>
+ <div class="description">Update the lower boundary of a foreach</div>
+ </td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
+
+
+<!-- ============================== events summary ======================== -->
+
+
+<!-- ============================== constructor details ==================== -->
+
+ <div class="details"><a name="constructor"> </a>
+ <div class="sectionTitle">
+ Class Detail
+ </div>
+
+ <div class="fixedFont">
+ <b>BindPlugin</b>(Store, Observable, Tools, DomUtils)
+ </div>
+
+ <div class="description">
+
+
+ </div>
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Parameters:</dt>
+
+ <dt>
+ <b>Store</b>
+
+ </dt>
+ <dd></dd>
+
+ <dt>
+ <b>Observable</b>
+
+ </dt>
+ <dd></dd>
+
+ <dt>
+ <b>Tools</b>
+
+ </dt>
+ <dd></dd>
+
+ <dt>
+ <b>DomUtils</b>
+
+ </dt>
+ <dd></dd>
+
+ </dl>
+
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Requires:</dt>
+
+ <dd>Store, Observable</dd>
+
+ </dl>
+
+
+
+ </div>
+
+
+<!-- ============================== field details ========================== -->
+
+
+<!-- ============================== method details ========================= -->
+
+ <div class="sectionTitle">
+ Method Detail
+ </div>
+
+ <a name="addBinding"> </a>
+ <div class="fixedFont">
+
+
+ <b>addBinding</b>(name, binding)
+
+ </div>
+ <div class="description">
+ Add a new way to handle a binding
+
+
+ </div>
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Parameters:</dt>
+
+ <dt>
+ <span class="light fixedFont">{String}</span> <b>name</b>
+
+ </dt>
+ <dd>of the binding</dd>
+
+ <dt>
+ <span class="light fixedFont">{Function}</span> <b>binding</b>
+
+ </dt>
+ <dd>the function to handle the binding</dd>
+
+ </dl>
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Returns:</dt>
+
+ <dd></dd>
+
+ </dl>
+
+
+
+
+ <hr />
+
+ <a name="addBindings"> </a>
+ <div class="fixedFont">
+
+
+ <b>addBindings</b>(list)
+
+ </div>
+ <div class="description">
+ Add multiple binding at once
+
+
+ </div>
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Parameters:</dt>
+
+ <dt>
+ <span class="light fixedFont">{Object}</span> <b>list</b>
+
+ </dt>
+ <dd>the list of bindings to add</dd>
+
+ </dl>
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Returns:</dt>
+
+ <dd></dd>
+
+ </dl>
+
+
+
+
+ <hr />
+
+ <a name="bind"> </a>
+ <div class="fixedFont">
+
+
+ <b>bind</b>(node, name, name)
+
+ </div>
+ <div class="description">
+ Both ways binding between a dom node attributes and the model
+
+
+ </div>
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Parameters:</dt>
+
+ <dt>
+ <span class="light fixedFont">{HTMLElement|SVGElement}</span> <b>node</b>
+
+ </dt>
+ <dd>the dom node to apply the plugin to</dd>
+
+ <dt>
+ <span class="light fixedFont">{String}</span> <b>name</b>
+
+ </dt>
+ <dd>the name of the property to look for in the model's value</dd>
+
+ <dt>
+ <b>name</b>
+
+ </dt>
+ <dd></dd>
+
+ </dl>
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Returns:</dt>
+
+ <dd></dd>
+
+ </dl>
+
+
+
+
+ <hr />
+
+ <a name="foreach"> </a>
+ <div class="fixedFont">
+
+
+ <b>foreach</b>(node, idItemRenderer, start, nb)
+
+ </div>
+ <div class="description">
+ Expands the inner dom nodes of a given dom node, filling it with model's values
+
+
+ </div>
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Parameters:</dt>
+
+ <dt>
+ <span class="light fixedFont">{HTMLElement|SVGElement}</span> <b>node</b>
+
+ </dt>
+ <dd>the dom node to apply foreach to</dd>
+
+ <dt>
+ <b>idItemRenderer</b>
+
+ </dt>
+ <dd></dd>
+
+ <dt>
+ <b>start</b>
+
+ </dt>
+ <dd></dd>
+
+ <dt>
+ <b>nb</b>
+
+ </dt>
+ <dd></dd>
+
+ </dl>
+
+
+
+
+
+
+
+
+ <hr />
+
+ <a name="form"> </a>
+ <div class="fixedFont">
+
+
+ <b>form</b>(DOMfrom)
+
+ </div>
+ <div class="description">
+ Prevents the submit and set the model with all form's inputs
+
+
+ </div>
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Parameters:</dt>
+
+ <dt>
+ <span class="light fixedFont">{HTMLFormElement}</span> <b>DOMfrom</b>
+
+ </dt>
+ <dd></dd>
+
+ </dl>
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Returns:</dt>
+
+ <dd>true if valid form</dd>
+
+ </dl>
+
+
+
+
+ <hr />
+
+ <a name="refresh"> </a>
+ <div class="fixedFont">
+
+
+ <b>refresh</b>(id)
+
+ </div>
+ <div class="description">
+ Refresh a foreach after having modified its limits
+
+
+ </div>
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Parameters:</dt>
+
+ <dt>
+ <span class="light fixedFont">{String}</span> <b>id</b>
+
+ </dt>
+ <dd>the id of the foreach to refresh</dd>
+
+ </dl>
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Returns:</dt>
+
+ <dd>true if the foreach exists</dd>
+
+ </dl>
+
+
+
+
+ <hr />
+
+ <a name="setModel"> </a>
+ <div class="fixedFont">
+
+ <span class="light">{Boolean}</span>
+ <b>setModel</b>(model)
+
+ </div>
+ <div class="description">
+ Define the model to watch for
+
+
+ </div>
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Parameters:</dt>
+
+ <dt>
+ <span class="light fixedFont">{Store}</span> <b>model</b>
+
+ </dt>
+ <dd>the model to watch for changes</dd>
+
+ </dl>
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Returns:</dt>
+
+ <dd><span class="light fixedFont">{Boolean}</span> true if the model was set</dd>
+
+ </dl>
+
+
+
+
+ <hr />
+
+ <a name="updateNb"> </a>
+ <div class="fixedFont">
+
+
+ <b>updateNb</b>(id, nb)
+
+ </div>
+ <div class="description">
+ Update the number of item to display in a foreach
+
+
+ </div>
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Parameters:</dt>
+
+ <dt>
+ <span class="light fixedFont">{String}</span> <b>id</b>
+
+ </dt>
+ <dd>the id of the foreach to update</dd>
+
+ <dt>
+ <span class="light fixedFont">{Number}</span> <b>nb</b>
+
+ </dt>
+ <dd>the number of items to display</dd>
+
+ </dl>
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Returns:</dt>
+
+ <dd>true if the foreach exists</dd>
+
+ </dl>
+
+
+
+
+ <hr />
+
+ <a name="updateStart"> </a>
+ <div class="fixedFont">
+
+
+ <b>updateStart</b>(id, start)
+
+ </div>
+ <div class="description">
+ Update the lower boundary of a foreach
+
+
+ </div>
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Parameters:</dt>
+
+ <dt>
+ <span class="light fixedFont">{String}</span> <b>id</b>
+
+ </dt>
+ <dd>the id of the foreach to update</dd>
+
+ <dt>
+ <span class="light fixedFont">{Number}</span> <b>start</b>
+
+ </dt>
+ <dd>the new value</dd>
+
+ </dl>
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Returns:</dt>
+
+ <dd>true if the foreach exists</dd>
+
+ </dl>
+
+
+
+
+
+
+
+
+<!-- ============================== event details ========================= -->
+
+
+ <hr />
+ </div>
+
+
+<!-- ============================== footer ================================= -->
+ <div class="fineprint" style="clear:both">
+
+ Documentation generated by <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blank">JsDoc Toolkit</a> 2.4.0 on Sat Sep 07 2013 17:44:35 GMT+0100 (BST)
+ </div>
+ </body>
+</html>
View
747 docs/1.6.0/symbols/EventPlugin.html
@@ -0,0 +1,747 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+ <head>
+ <meta http-equiv="content-type" content="text/html; charset=utf-8" />
+ <meta name="generator" content="JsDoc Toolkit" />
+
+ <title>JsDoc Reference - EventPlugin</title>
+
+ <style type="text/css">
+ /* default.css */
+body
+{
+ font: 12px "Lucida Grande", Tahoma, Arial, Helvetica, sans-serif;
+ width: 800px;
+}
+
+.header
+{
+ clear: both;
+ background-color: #ccc;
+ padding: 8px;
+}
+
+h1
+{
+ font-size: 150%;
+ font-weight: bold;
+ padding: 0;
+ margin: 1em 0 0 .3em;
+}
+
+hr
+{
+ border: none 0;
+ border-top: 1px solid #7F8FB1;
+ height: 1px;
+}
+
+pre.code
+{
+ display: block;
+ padding: 8px;
+ border: 1px dashed #ccc;
+}
+
+#index
+{
+ margin-top: 24px;
+ float: left;
+ width: 160px;
+ position: absolute;
+ left: 8px;
+ background-color: #F3F3F3;
+ padding: 8px;
+}
+
+#content
+{
+ margin-left: 190px;
+ width: 600px;
+}
+
+.classList
+{
+ list-style-type: none;
+ padding: 0;
+ margin: 0 0 0 8px;
+ font-family: arial, sans-serif;
+ font-size: 1em;
+ overflow: auto;
+}
+
+.classList li
+{
+ padding: 0;
+ margin: 0 0 8px 0;
+}
+
+.summaryTable { width: 100%; }
+
+h1.classTitle
+{
+ font-size:170%;
+ line-height:130%;
+}
+
+h2 { font-size: 110%; }
+caption, div.sectionTitle
+{
+ background-color: #7F8FB1;
+ color: #fff;
+ font-size:130%;
+ text-align: left;
+ padding: 2px 6px 2px 6px;
+ border: 1px #7F8FB1 solid;
+}
+
+div.sectionTitle { margin-bottom: 8px; }
+.summaryTable thead { display: none; }
+
+.summaryTable td
+{
+ vertical-align: top;
+ padding: 4px;
+ border-bottom: 1px #7F8FB1 solid;
+ border-right: 1px #7F8FB1 solid;
+}
+
+/*col#summaryAttributes {}*/
+.summaryTable td.attributes
+{
+ border-left: 1px #7F8FB1 solid;
+ width: 140px;
+ text-align: right;
+}
+
+td.attributes, .fixedFont
+{
+ line-height: 15px;
+ color: #002EBE;
+ font-family: "Courier New",Courier,monospace;
+ font-size: 13px;
+}
+
+.summaryTable td.nameDescription
+{
+ text-align: left;
+ font-size: 13px;
+ line-height: 15px;
+}
+
+.summaryTable td.nameDescription, .description
+{
+ line-height: 15px;
+ padding: 4px;
+ padding-left: 4px;
+}
+
+.summaryTable { margin-bottom: 8px; }
+
+ul.inheritsList
+{
+ list-style: square;
+ margin-left: 20px;
+ padding-left: 0;
+}
+
+.detailList {
+ margin-left: 20px;
+ line-height: 15px;
+}
+.detailList dt { margin-left: 20px; }
+
+.detailList .heading
+{
+ font-weight: bold;
+ padding-bottom: 6px;
+ margin-left: 0;
+}
+
+.light, td.attributes, .light a:link, .light a:visited
+{
+ color: #777;
+ font-style: italic;
+}
+
+.fineprint
+{
+ text-align: right;
+ font-size: 10px;
+}
+ </style>
+ </head>
+
+ <body>
+<!-- ============================== header ================================= -->
+ <!-- begin static/header.html -->
+ <div id="header">
+</div>
+ <!-- end static/header.html -->
+
+<!-- ============================== classes index ============================ -->
+ <div id="index">
+ <!-- begin publish.classesIndex -->
+ <div align="center"><a href="../index.html">Class Index</a>
+| <a href="../files.html">File Index</a></div>
+<hr />
+<h2>Classes</h2>
+<ul class="classList">
+
+ <li><i><a href="../symbols/_global_.html">_global_</a></i></li>
+
+ <li><a href="../symbols/BindPlugin.html">BindPlugin</a></li>
+
+ <li><a href="../symbols/EventPlugin.html">EventPlugin</a></li>
+
+ <li><a href="../symbols/LocalStore.html">LocalStore</a></li>
+
+ <li><a href="../symbols/LocationRouter.html">LocationRouter</a></li>
+
+ <li><a href="../symbols/OObject.html">OObject</a></li>
+
+ <li><a href="../symbols/PlacePlugin.html">PlacePlugin</a></li>
+
+ <li><a href="../symbols/Plugins.html">Plugins</a></li>
+
+ <li><a href="../symbols/SocketIOTransport.html">SocketIOTransport</a></li>
+
+ <li><a href="../symbols/Stack.html">Stack</a></li>
+
+</ul>
+<hr />
+ <!-- end publish.classesIndex -->
+ </div>
+
+ <div id="content">
+<!-- ============================== class title ============================ -->
+ <h1 class="classTitle">
+
+ Class EventPlugin
+ </h1>
+
+<!-- ============================== class summary ========================== -->
+ <p class="description">
+
+
+
+ Event plugin adds events listeners to DOM nodes.
+It can also delegate the event handling to a parent dom node
+
+
+ <br /><i>Defined in: </i> <a href="../symbols/src/src_Event.plugin.js.html">Event.plugin.js</a>.
+
+ </p>
+
+<!-- ============================== constructor summary ==================== -->
+
+ <table class="summaryTable" cellspacing="0" summary="A summary of the constructor documented in the class EventPlugin.">
+ <caption>Class Summary</caption>
+ <thead>
+ <tr>
+ <th scope="col">Constructor Attributes</th>
+ <th scope="col">Constructor Name and Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td class="attributes">&nbsp;</td>
+ <td class="nameDescription" >
+ <div class="fixedFont">
+ <b><a href="../symbols/EventPlugin.html#constructor">EventPlugin</a></b>(Utils)
+ </div>
+ <div class="description"></div>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+
+
+<!-- ============================== properties summary ===================== -->
+
+
+<!-- ============================== methods summary ======================== -->
+
+
+
+ <table class="summaryTable" cellspacing="0" summary="A summary of the methods documented in the class EventPlugin.">
+ <caption>Method Summary</caption>
+ <thead>
+ <tr>
+ <th scope="col">Method Attributes</th>
+ <th scope="col">Method Name and Description</th>
+ </tr>
+ </thead>
+ <tbody>
+
+ <tr>
+ <td class="attributes">&nbsp;</td>
+ <td class="nameDescription">
+ <div class="fixedFont"><b><a href="../symbols/EventPlugin.html#delegate">delegate</a></b>(node, selector, name, listener, useCapture)
+ </div>
+ <div class="description">Delegate the event handling to a parent DOM element</div>
+ </td>
+ </tr>
+
+ <tr>
+ <td class="attributes">&lt;inner&gt; &nbsp;</td>
+ <td class="nameDescription">
+ <div class="fixedFont"><b><a href="../symbols/EventPlugin.html#-EventPluginConstructor">EventPluginConstructor</a></b>(the, $isMobile)
+ </div>
+ <div class="description">The event plugin constructor.</div>
+ </td>
+ </tr>
+
+ <tr>
+ <td class="attributes">&nbsp;</td>
+ <td class="nameDescription">
+ <div class="fixedFont"><b><a href="../symbols/EventPlugin.html#getParent">getParent</a></b>()
+ </div>
+ <div class="description">Get the parent object.</div>
+ </td>
+ </tr>
+
+ <tr>
+ <td class="attributes">&nbsp;</td>
+ <td class="nameDescription">
+ <div class="fixedFont"><b><a href="../symbols/EventPlugin.html#listen">listen</a></b>(node, name, listener, useCapture)
+ </div>
+ <div class="description">Listen to DOM events.</div>
+ </td>
+ </tr>
+
+ <tr>
+ <td class="attributes">&nbsp;</td>
+ <td class="nameDescription">
+ <div class="fixedFont"><b><a href="../symbols/EventPlugin.html#map">map</a></b>(event's)
+ </div>
+ <div class="description">Get event mapping.</div>
+ </td>
+ </tr>
+
+ <tr>
+ <td class="attributes">&nbsp;</td>
+ <td class="nameDescription">
+ <div class="fixedFont"><b><a href="../symbols/EventPlugin.html#setMap">setMap</a></b>(event's, event's)
+ </div>
+ <div class="description">Set event mapping.</div>
+ </td>
+ </tr>
+
+ <tr>
+ <td class="attributes">&nbsp;</td>
+ <td class="nameDescription">
+ <div class="fixedFont"><b><a href="../symbols/EventPlugin.html#setParent">setParent</a></b>(the)
+ </div>
+ <div class="description">Set the parent object.</div>
+ </td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
+
+
+<!-- ============================== events summary ======================== -->
+
+
+<!-- ============================== constructor details ==================== -->
+
+ <div class="details"><a name="constructor"> </a>
+ <div class="sectionTitle">
+ Class Detail
+ </div>
+
+ <div class="fixedFont">
+ <b>EventPlugin</b>(Utils)
+ </div>
+
+ <div class="description">
+
+
+ </div>
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Parameters:</dt>
+
+ <dt>
+ <b>Utils</b>
+
+ </dt>
+ <dd></dd>
+
+ </dl>
+
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Requires:</dt>
+
+ <dd>Utils</dd>
+
+ </dl>
+
+
+
+ </div>
+
+
+<!-- ============================== field details ========================== -->
+
+
+<!-- ============================== method details ========================= -->
+
+ <div class="sectionTitle">
+ Method Detail
+ </div>
+
+ <a name="delegate"> </a>
+ <div class="fixedFont">
+
+
+ <b>delegate</b>(node, selector, name, listener, useCapture)
+
+ </div>
+ <div class="description">
+ Delegate the event handling to a parent DOM element
+
+
+ </div>
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Parameters:</dt>
+
+ <dt>
+ <span class="light fixedFont">{Object}</span> <b>node</b>
+
+ </dt>
+ <dd>DOM node</dd>
+
+ <dt>
+ <span class="light fixedFont">{String}</span> <b>selector</b>
+
+ </dt>
+ <dd>CSS3 selector to the element that listens to the event</dd>
+
+ <dt>
+ <span class="light fixedFont">{String}</span> <b>name</b>
+
+ </dt>
+ <dd>event's name</dd>
+
+ <dt>
+ <span class="light fixedFont">{String}</span> <b>listener</b>
+
+ </dt>
+ <dd>callback's name</dd>
+
+ <dt>
+ <span class="light fixedFont">{String}</span> <b>useCapture</b>
+
+ </dt>
+ <dd>string</dd>
+
+ </dl>
+
+
+
+
+
+
+
+
+ <hr />
+
+ <a name="-EventPluginConstructor"> </a>
+ <div class="fixedFont">&lt;inner&gt;
+
+
+ <b>EventPluginConstructor</b>(the, $isMobile)
+
+ </div>
+ <div class="description">
+ The event plugin constructor.
+ex: new EventPlugin({method: function(){} ...}, false);
+
+
+ </div>
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Parameters:</dt>
+
+ <dt>
+ <span class="light fixedFont">{Object}</span> <b>the</b>
+
+ </dt>
+ <dd>object that has the event handling methods</dd>
+
+ <dt>
+ <span class="light fixedFont">{Boolean}</span> <b>$isMobile</b>
+
+ </dt>
+ <dd>if the event handler has to map with touch events</dd>
+
+ </dl>
+
+
+
+
+
+
+
+
+ <hr />
+
+ <a name="getParent"> </a>
+ <div class="fixedFont">
+
+ <span class="light">{Object}</span>
+ <b>getParent</b>()
+
+ </div>
+ <div class="description">
+ Get the parent object.
+
+
+ </div>
+
+
+
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Returns:</dt>
+
+ <dd><span class="light fixedFont">{Object}</span> the parent object</dd>
+
+ </dl>
+
+
+
+
+ <hr />
+
+ <a name="listen"> </a>
+ <div class="fixedFont">
+
+
+ <b>listen</b>(node, name, listener, useCapture)
+
+ </div>
+ <div class="description">
+ Listen to DOM events.
+
+
+ </div>
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Parameters:</dt>
+
+ <dt>
+ <span class="light fixedFont">{Object}</span> <b>node</b>
+
+ </dt>
+ <dd>DOM node</dd>
+
+ <dt>
+ <span class="light fixedFont">{String}</span> <b>name</b>
+
+ </dt>
+ <dd>event's name</dd>
+
+ <dt>
+ <span class="light fixedFont">{String}</span> <b>listener</b>
+
+ </dt>
+ <dd>callback's name</dd>
+
+ <dt>
+ <span class="light fixedFont">{String}</span> <b>useCapture</b>
+
+ </dt>
+ <dd>string</dd>
+
+ </dl>
+
+
+
+
+
+
+
+
+ <hr />
+
+ <a name="map"> </a>
+ <div class="fixedFont">
+
+
+ <b>map</b>(event's)
+
+ </div>
+ <div class="description">
+ Get event mapping.
+
+
+ </div>
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Parameters:</dt>
+
+ <dt>
+ <span class="light fixedFont">{String}</span> <b>event's</b>
+
+ </dt>
+ <dd>name</dd>
+
+ </dl>
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Returns:</dt>
+
+ <dd>the mapped event's name</dd>
+
+ </dl>
+
+
+
+
+ <hr />
+
+ <a name="setMap"> </a>
+ <div class="fixedFont">
+
+
+ <b>setMap</b>(event's, event's)
+
+ </div>
+ <div class="description">
+ Set event mapping.
+
+
+ </div>
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Parameters:</dt>
+
+ <dt>
+ <span class="light fixedFont">{String}</span> <b>event's</b>
+
+ </dt>
+ <dd>name</dd>
+
+ <dt>
+ <span class="light fixedFont">{String}</span> <b>event's</b>
+
+ </dt>
+ <dd>value</dd>
+
+ </dl>
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Returns:</dt>
+
+ <dd>true if mapped</dd>
+
+ </dl>
+
+
+
+
+ <hr />
+
+ <a name="setParent"> </a>
+ <div class="fixedFont">
+
+
+ <b>setParent</b>(the)
+
+ </div>
+ <div class="description">
+ Set the parent object.
+The parent object is an object which the functions are called by node listeners.
+
+
+ </div>
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Parameters:</dt>
+
+ <dt>
+ <span class="light fixedFont">{Object}</span> <b>the</b>
+
+ </dt>
+ <dd>parent object</dd>
+
+ </dl>
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Returns:</dt>
+
+ <dd>true if object has been set</dd>
+
+ </dl>
+
+
+
+
+
+
+
+
+<!-- ============================== event details ========================= -->
+
+
+ <hr />
+ </div>
+
+
+<!-- ============================== footer ================================= -->
+ <div class="fineprint" style="clear:both">
+
+ Documentation generated by <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blank">JsDoc Toolkit</a> 2.4.0 on Sat Sep 07 2013 17:44:35 GMT+0100 (BST)
+ </div>
+ </body>
+</html>
View
412 docs/1.6.0/symbols/LocalStore.html
@@ -0,0 +1,412 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+ <head>
+ <meta http-equiv="content-type" content="text/html; charset=utf-8" />
+ <meta name="generator" content="JsDoc Toolkit" />
+
+ <title>JsDoc Reference - LocalStore</title>
+
+ <style type="text/css">
+ /* default.css */
+body
+{
+ font: 12px "Lucida Grande", Tahoma, Arial, Helvetica, sans-serif;
+ width: 800px;
+}
+
+.header
+{
+ clear: both;
+ background-color: #ccc;
+ padding: 8px;
+}
+
+h1
+{
+ font-size: 150%;
+ font-weight: bold;
+ padding: 0;
+ margin: 1em 0 0 .3em;
+}
+
+hr
+{
+ border: none 0;
+ border-top: 1px solid #7F8FB1;
+ height: 1px;
+}
+
+pre.code
+{
+ display: block;
+ padding: 8px;
+ border: 1px dashed #ccc;
+}
+
+#index
+{
+ margin-top: 24px;
+ float: left;
+ width: 160px;
+ position: absolute;
+ left: 8px;
+ background-color: #F3F3F3;
+ padding: 8px;
+}
+
+#content
+{
+ margin-left: 190px;
+ width: 600px;
+}
+
+.classList
+{
+ list-style-type: none;
+ padding: 0;
+ margin: 0 0 0 8px;
+ font-family: arial, sans-serif;
+ font-size: 1em;
+ overflow: auto;
+}
+
+.classList li
+{
+ padding: 0;
+ margin: 0 0 8px 0;
+}
+
+.summaryTable { width: 100%; }
+
+h1.classTitle
+{
+ font-size:170%;
+ line-height:130%;
+}
+
+h2 { font-size: 110%; }
+caption, div.sectionTitle
+{
+ background-color: #7F8FB1;
+ color: #fff;
+ font-size:130%;
+ text-align: left;
+ padding: 2px 6px 2px 6px;
+ border: 1px #7F8FB1 solid;
+}
+
+div.sectionTitle { margin-bottom: 8px; }
+.summaryTable thead { display: none; }
+
+.summaryTable td
+