Web   ·   Wiki   ·   Activities   ·   Blog   ·   Lists   ·   Chat   ·   Meeting   ·   Bugs   ·   Git   ·   Translate   ·   Archive   ·   People   ·   Donate
summaryrefslogtreecommitdiffstats
path: root/docs/symbols/$.ui.kFooter.html
diff options
context:
space:
mode:
authorBryan Berry <bryan@olenepal.org>2010-02-17 09:39:34 (GMT)
committer Bryan Berry <bryan@olenepal.org>2010-02-17 09:39:34 (GMT)
commit0aa48d0503c69c9ebc1d2bb209bfbec10e8bed64 (patch)
tree5008d89f95d62696440785a85c08949a7fd27c97 /docs/symbols/$.ui.kFooter.html
initial commit. Lesson English_Animal_Identification is current template
Diffstat (limited to 'docs/symbols/$.ui.kFooter.html')
-rwxr-xr-xdocs/symbols/$.ui.kFooter.html866
1 files changed, 866 insertions, 0 deletions
diff --git a/docs/symbols/$.ui.kFooter.html b/docs/symbols/$.ui.kFooter.html
new file mode 100755
index 0000000..a419e20
--- /dev/null
+++ b/docs/symbols/$.ui.kFooter.html
@@ -0,0 +1,866 @@
+<!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 - $.ui.kFooter</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><a href="../symbols/%24.ui.feedback.html">$.ui.feedback</a></li>
+
+ <li><a href="../symbols/%24.ui.feedback.defaults.html">$.ui.feedback.defaults</a></li>
+
+ <li><a href="../symbols/%24.ui.kFooter.html">$.ui.kFooter</a></li>
+
+ <li><a href="../symbols/%24.ui.kFooter.defaults.html">$.ui.kFooter.defaults</a></li>
+
+ <li><a href="../symbols/%24.ui.kHeader.html">$.ui.kHeader</a></li>
+
+ <li><a href="../symbols/%24.ui.kHeader.defaults.html">$.ui.kHeader.defaults</a></li>
+
+ <li><i><a href="../symbols/_global_.html">_global_</a></i></li>
+
+ <li><a href="../symbols/Karma.html">Karma</a></li>
+
+ <li><a href="../symbols/Karma.kAudio.html">Karma.kAudio</a></li>
+
+ <li><a href="../symbols/Karma.kCanvas.html">Karma.kCanvas</a></li>
+
+ <li><a href="../symbols/Karma.kImage.html">Karma.kImage</a></li>
+
+ <li><a href="../symbols/Karma.kSvg.html">Karma.kSvg</a></li>
+
+ <li><a href="../symbols/Karma.kVideo.html">Karma.kVideo</a></li>
+
+</ul>
+<hr />
+ <!-- end publish.classesIndex -->
+ </div>
+
+ <div id="content">
+<!-- ============================== class title ============================ -->
+ <h1 class="classTitle">
+
+ Namespace $.ui.kFooter
+ </h1>
+
+<!-- ============================== class summary ========================== -->
+ <p class="description">
+
+
+
+ kFooter widget
+
+
+ <br /><i>Defined in: </i> <a href="../symbols/src/js_ui.kFooter.js.html">ui.kFooter.js</a>.
+
+ </p>
+
+<!-- ============================== constructor summary ==================== -->
+
+ <table class="summaryTable" cellspacing="0" summary="A summary of the constructor documented in the class $.ui.kFooter.">
+ <caption>Namespace 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/%24.ui.kFooter.html#constructor">$.ui.kFooter</a></b>
+ </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 $.ui.kFooter.">
+ <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/%24.ui.kFooter.html#dec">dec</a></b>(val)
+ </div>
+ <div class="description">Decrements the score by 1 or by the supplied numeric argument</div>
+ </td>
+ </tr>
+
+ <tr>
+ <td class="attributes">&nbsp;</td>
+ <td class="nameDescription">
+ <div class="fixedFont"><b><a href="../symbols/%24.ui.kFooter.html#decTotal">decTotal</a></b>(val)
+ </div>
+ <div class="description">Decrements the total by 1 or by the supplied numeric argument</div>
+ </td>
+ </tr>
+
+ <tr>
+ <td class="attributes">&nbsp;</td>
+ <td class="nameDescription">
+ <div class="fixedFont"><b><a href="../symbols/%24.ui.kFooter.html#destroy">destroy</a></b>()
+ </div>
+ <div class="description">Removes the kFooter widget and all related data from the DOM</div>
+ </td>
+ </tr>
+
+ <tr>
+ <td class="attributes">&nbsp;</td>
+ <td class="nameDescription">
+ <div class="fixedFont"><b><a href="../symbols/%24.ui.kFooter.html#getScore">getScore</a></b>()
+ </div>
+ <div class="description">Gets the current score</div>
+ </td>
+ </tr>
+
+ <tr>
+ <td class="attributes">&nbsp;</td>
+ <td class="nameDescription">
+ <div class="fixedFont"><b><a href="../symbols/%24.ui.kFooter.html#getTotal">getTotal</a></b>()
+ </div>
+ <div class="description">Gets the current total</div>
+ </td>
+ </tr>
+
+ <tr>
+ <td class="attributes">&nbsp;</td>
+ <td class="nameDescription">
+ <div class="fixedFont"><b><a href="../symbols/%24.ui.kFooter.html#inc">inc</a></b>(val)
+ </div>
+ <div class="description">Increments the score by 1 or by the supplied numeric argument</div>
+ </td>
+ </tr>
+
+ <tr>
+ <td class="attributes">&nbsp;</td>
+ <td class="nameDescription">
+ <div class="fixedFont"><b><a href="../symbols/%24.ui.kFooter.html#incTotal">incTotal</a></b>(val)
+ </div>
+ <div class="description">Increments the total by 1 or by the supplied numeric argument</div>
+ </td>
+ </tr>
+
+ <tr>
+ <td class="attributes">&nbsp;</td>
+ <td class="nameDescription">
+ <div class="fixedFont"><b><a href="../symbols/%24.ui.kFooter.html#restart">restart</a></b>()
+ </div>
+ <div class="description">Resets the score and total to initial values and triggers
+the "kFooterRestart" event</div>
+ </td>
+ </tr>
+
+ <tr>
+ <td class="attributes">&nbsp;</td>
+ <td class="nameDescription">
+ <div class="fixedFont"><b><a href="../symbols/%24.ui.kFooter.html#setScore">setScore</a></b>(newScore)
+ </div>
+ <div class="description">Sets the current score</div>
+ </td>
+ </tr>
+
+ <tr>
+ <td class="attributes">&nbsp;</td>
+ <td class="nameDescription">
+ <div class="fixedFont"><b><a href="../symbols/%24.ui.kFooter.html#setTotal">setTotal</a></b>(newTotal)
+ </div>
+ <div class="description">Sets the current total</div>
+ </td>
+ </tr>
+
+ <tr>
+ <td class="attributes">&nbsp;</td>
+ <td class="nameDescription">
+ <div class="fixedFont"><b><a href="../symbols/%24.ui.kFooter.html#startTimer">startTimer</a></b>(minutes, seconds)
+ </div>
+ <div class="description">Start the timer, defaults to 0:00 if no arguments supplied</div>
+ </td>
+ </tr>
+
+ <tr>
+ <td class="attributes">&nbsp;</td>
+ <td class="nameDescription">
+ <div class="fixedFont"><b><a href="../symbols/%24.ui.kFooter.html#stopTimer">stopTimer</a></b>()
+ </div>
+ <div class="description">Stop the timer</div>
+ </td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
+
+
+<!-- ============================== events summary ======================== -->
+
+
+<!-- ============================== constructor details ==================== -->
+
+ <div class="details"><a name="constructor"> </a>
+ <div class="sectionTitle">
+ Namespace Detail
+ </div>
+
+ <div class="fixedFont">
+ <b>$.ui.kFooter</b>
+ </div>
+
+ <div class="description">
+
+
+ </div>
+
+
+
+ <pre class="code">Emits the event kFooterWinGame when the maxScore is reached <br />
+Emits the event kFooterRestart when game restarted <br />
+Start button emits kFooterStart event when clicked <br />
+Restart button emits kFooterRestart event when clicked <br />
+Pause button emits the kFooterPause event when clicked <br /></pre>
+
+
+
+
+
+
+
+
+
+
+
+
+ </div>
+
+
+<!-- ============================== field details ========================== -->
+
+
+<!-- ============================== method details ========================= -->
+
+ <div class="sectionTitle">
+ Method Detail
+ </div>
+
+ <a name="dec"> </a>
+ <div class="fixedFont">
+
+
+ <b>dec</b>(val)
+
+ </div>
+ <div class="description">
+ Decrements the score by 1 or by the supplied numeric argument
+
+
+ </div>
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Parameters:</dt>
+
+ <dt>
+ <span class="light fixedFont">{Number}</span> <b>val</b>
+ <i>Optional</i>
+ </dt>
+ <dd>decrement value</dd>
+
+ </dl>
+
+
+
+
+
+
+
+
+ <hr />
+
+ <a name="decTotal"> </a>
+ <div class="fixedFont">
+
+
+ <b>decTotal</b>(val)
+
+ </div>
+ <div class="description">
+ Decrements the total by 1 or by the supplied numeric argument
+
+
+ </div>
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Parameters:</dt>
+
+ <dt>
+ <span class="light fixedFont">{Number}</span> <b>val</b>
+ <i>Optional</i>
+ </dt>
+ <dd>decrement value</dd>
+
+ </dl>
+
+
+
+
+
+
+
+
+ <hr />
+
+ <a name="destroy"> </a>
+ <div class="fixedFont">
+
+
+ <b>destroy</b>()
+
+ </div>
+ <div class="description">
+ Removes the kFooter widget and all related data from the DOM
+
+
+ </div>
+
+
+
+
+
+
+
+
+
+
+
+ <hr />
+
+ <a name="getScore"> </a>
+ <div class="fixedFont">
+
+ <span class="light">{Number}</span>
+ <b>getScore</b>()
+
+ </div>
+ <div class="description">
+ Gets the current score
+
+
+ </div>
+
+
+
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Returns:</dt>
+
+ <dd><span class="light fixedFont">{Number}</span> current score</dd>
+
+ </dl>
+
+
+
+
+ <hr />
+
+ <a name="getTotal"> </a>
+ <div class="fixedFont">
+
+ <span class="light">{Number}</span>
+ <b>getTotal</b>()
+
+ </div>
+ <div class="description">
+ Gets the current total
+
+
+ </div>
+
+
+
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Returns:</dt>
+
+ <dd><span class="light fixedFont">{Number}</span> current total</dd>
+
+ </dl>
+
+
+
+
+ <hr />
+
+ <a name="inc"> </a>
+ <div class="fixedFont">
+
+
+ <b>inc</b>(val)
+
+ </div>
+ <div class="description">
+ Increments the score by 1 or by the supplied numeric argument
+
+
+ </div>
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Parameters:</dt>
+
+ <dt>
+ <span class="light fixedFont">{Number}</span> <b>val</b>
+ <i>Optional</i>
+ </dt>
+ <dd>increment value</dd>
+
+ </dl>
+
+
+
+
+
+
+
+
+ <hr />
+
+ <a name="incTotal"> </a>
+ <div class="fixedFont">
+
+
+ <b>incTotal</b>(val)
+
+ </div>
+ <div class="description">
+ Increments the total by 1 or by the supplied numeric argument
+
+
+ </div>
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Parameters:</dt>
+
+ <dt>
+ <span class="light fixedFont">{Number}</span> <b>val</b>
+ <i>Optional</i>
+ </dt>
+ <dd>increment value</dd>
+
+ </dl>
+
+
+
+
+
+
+
+
+ <hr />
+
+ <a name="restart"> </a>
+ <div class="fixedFont">
+
+
+ <b>restart</b>()
+
+ </div>
+ <div class="description">
+ Resets the score and total to initial values and triggers
+the "kFooterRestart" event
+
+
+ </div>
+
+
+
+
+
+
+
+
+
+
+
+ <hr />
+
+ <a name="setScore"> </a>
+ <div class="fixedFont">
+
+
+ <b>setScore</b>(newScore)
+
+ </div>
+ <div class="description">
+ Sets the current score
+
+
+ </div>
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Parameters:</dt>
+
+ <dt>
+ <span class="light fixedFont">{Number}</span> <b>newScore</b>
+
+ </dt>
+ <dd>new score</dd>
+
+ </dl>
+
+
+
+
+
+
+
+
+ <hr />
+
+ <a name="setTotal"> </a>
+ <div class="fixedFont">
+
+
+ <b>setTotal</b>(newTotal)
+
+ </div>
+ <div class="description">
+ Sets the current total
+
+
+ </div>
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Parameters:</dt>
+
+ <dt>
+ <span class="light fixedFont">{Number}</span> <b>newTotal</b>
+
+ </dt>
+ <dd>new total</dd>
+
+ </dl>
+
+
+
+
+
+
+
+
+ <hr />
+
+ <a name="startTimer"> </a>
+ <div class="fixedFont">
+
+
+ <b>startTimer</b>(minutes, seconds)
+
+ </div>
+ <div class="description">
+ Start the timer, defaults to 0:00 if no arguments supplied
+
+
+ </div>
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Parameters:</dt>
+
+ <dt>
+ <span class="light fixedFont">{Number}</span> <b>minutes</b>
+ <i>Optional</i>
+ </dt>
+ <dd>value for minutes, default to 0</dd>
+
+ <dt>
+ <span class="light fixedFont">{Number}</span> <b>seconds</b>
+ <i>Optional</i>
+ </dt>
+ <dd>value for seconds, default to 0</dd>
+
+ </dl>
+
+
+
+
+
+
+
+
+ <hr />
+
+ <a name="stopTimer"> </a>
+ <div class="fixedFont">
+
+
+ <b>stopTimer</b>()
+
+ </div>
+ <div class="description">
+ Stop the timer
+
+
+ </div>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+<!-- ============================== 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.3.2 on Wed Feb 17 2010 14:55:42 GMT+0545 (NPT)
+ </div>
+ </body>
+</html>
generated by cgit v0.9.1 at 2024-04-19 07:44:34 (GMT)