From 0aa48d0503c69c9ebc1d2bb209bfbec10e8bed64 Mon Sep 17 00:00:00 2001 From: Bryan Berry Date: Wed, 17 Feb 2010 09:39:34 +0000 Subject: initial commit. Lesson English_Animal_Identification is current template --- (limited to 'docs/symbols/$.ui.kFooter.html') 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 @@ + + + + + + + JsDoc Reference - $.ui.kFooter + + + + + + + + + + + +
+ +
Class Index +| File Index
+
+

Classes

+ +
+ +
+ +
+ +

+ + Namespace $.ui.kFooter +

+ + +

+ + + + kFooter widget + + +
Defined in: ui.kFooter.js. + +

+ + + + + + + + + + + + + + + + + +
Namespace Summary
Constructor AttributesConstructor Name and Description
  +
+ $.ui.kFooter +
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Method Summary
Method AttributesMethod Name and Description
  +
dec(val) +
+
Decrements the score by 1 or by the supplied numeric argument
+
  +
decTotal(val) +
+
Decrements the total by 1 or by the supplied numeric argument
+
  +
destroy() +
+
Removes the kFooter widget and all related data from the DOM
+
  +
getScore() +
+
Gets the current score
+
  +
getTotal() +
+
Gets the current total
+
  +
inc(val) +
+
Increments the score by 1 or by the supplied numeric argument
+
  +
incTotal(val) +
+
Increments the total by 1 or by the supplied numeric argument
+
  +
restart() +
+
Resets the score and total to initial values and triggers +the "kFooterRestart" event
+
  +
setScore(newScore) +
+
Sets the current score
+
  +
setTotal(newTotal) +
+
Sets the current total
+
  +
startTimer(minutes, seconds) +
+
Start the timer, defaults to 0:00 if no arguments supplied
+
  +
stopTimer() +
+
Stop the timer
+
+ + + + + + + + + +
+
+ Namespace Detail +
+ +
+ $.ui.kFooter +
+ +
+ + +
+ + + + 
Emits the event kFooterWinGame when the maxScore is reached 

+Emits the event kFooterRestart when game restarted 

+Start button emits kFooterStart event when clicked 

+Restart button emits kFooterRestart event when clicked 

+Pause button emits the kFooterPause event when clicked
+ + + + + + + + + + + + +
+ + + + + + + +
+ Method Detail +
+ + +
+ + + dec(val) + +
+
+ Decrements the score by 1 or by the supplied numeric argument + + +
+ + + + +
+
Parameters:
+ +
+ {Number} val + Optional +
+
decrement value
+ +
+ + + + + + + + +
+ + +
+ + + decTotal(val) + +
+
+ Decrements the total by 1 or by the supplied numeric argument + + +
+ + + + +
+
Parameters:
+ +
+ {Number} val + Optional +
+
decrement value
+ +
+ + + + + + + + +
+ + +
+ + + destroy() + +
+
+ Removes the kFooter widget and all related data from the DOM + + +
+ + + + + + + + + + + +
+ + +
+ + {Number} + getScore() + +
+
+ Gets the current score + + +
+ + + + + + + + +
+
Returns:
+ +
{Number} current score
+ +
+ + + + +
+ + +
+ + {Number} + getTotal() + +
+
+ Gets the current total + + +
+ + + + + + + + +
+
Returns:
+ +
{Number} current total
+ +
+ + + + +
+ + +
+ + + inc(val) + +
+
+ Increments the score by 1 or by the supplied numeric argument + + +
+ + + + +
+
Parameters:
+ +
+ {Number} val + Optional +
+
increment value
+ +
+ + + + + + + + +
+ + +
+ + + incTotal(val) + +
+
+ Increments the total by 1 or by the supplied numeric argument + + +
+ + + + +
+
Parameters:
+ +
+ {Number} val + Optional +
+
increment value
+ +
+ + + + + + + + +
+ + +
+ + + restart() + +
+
+ Resets the score and total to initial values and triggers +the "kFooterRestart" event + + +
+ + + + + + + + + + + +
+ + +
+ + + setScore(newScore) + +
+
+ Sets the current score + + +
+ + + + +
+
Parameters:
+ +
+ {Number} newScore + +
+
new score
+ +
+ + + + + + + + +
+ + +
+ + + setTotal(newTotal) + +
+
+ Sets the current total + + +
+ + + + +
+
Parameters:
+ +
+ {Number} newTotal + +
+
new total
+ +
+ + + + + + + + +
+ + +
+ + + startTimer(minutes, seconds) + +
+
+ Start the timer, defaults to 0:00 if no arguments supplied + + +
+ + + + +
+
Parameters:
+ +
+ {Number} minutes + Optional +
+
value for minutes, default to 0
+ +
+ {Number} seconds + Optional +
+
value for seconds, default to 0
+ +
+ + + + + + + + +
+ + +
+ + + stopTimer() + +
+
+ Stop the timer + + +
+ + + + + + + + + + + + + + + + + + +
+
+ + + +
+ + Documentation generated by JsDoc Toolkit 2.3.2 on Wed Feb 17 2010 14:55:42 GMT+0545 (NPT) +
+ + -- cgit v0.9.1