Class Index | File Index

Classes


Class com.jiffeegames.Help

A Help object defines the command handlers that handle "help" and unrecognized commands. Once you create the object, the only thing you need to use it for is to call the "addXxx" methods from other modules.
Defined in: jiffee-help.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
Create a Help object.
Method Summary
Method Attributes Method Name and Description
 
addSummary(cmd, meaning)
Add a row to the summary table that will be displayed by the "help" command.
<private>  
doHelpCmd_(event)
Command handler for the "help" command.
<private>  
Command handler for any user command that is not recognized by some other handler.
<static>  
com.jiffeegames.Help.es()
Set the language to Spanish.
<private>  
formatRow_(cmd, meaning)
Format a row of the summary table.
 
init(locate, language)
Class Detail
com.jiffeegames.Help()
Create a Help object. The typical call is:
var help = new com.jiffeegames.Help();
Method Detail
{void} addSummary(cmd, meaning)
Add a row to the summary table that will be displayed by the "help" command.
Parameters:
{String} cmd
The string to display in the first column ("command").
{String} meaning
The string to display in the second column ("what it means").

<private> {void} doHelpCmd_(event)
Command handler for the "help" command. Displays a summary table of all available commands and what they do.
Parameters:
{Object} event
The event that triggered the call.

<private> {void} doUnrecognizedCmd_(event)
Command handler for any user command that is not recognized by some other handler. Displays an appropriate error message.
Parameters:
{Object} event
The event that triggered the call.

<static> {void} com.jiffeegames.Help.es()
Set the language to Spanish.

<private> {String} formatRow_(cmd, meaning)
Format a row of the summary table.
Parameters:
cmd
meaning
Returns:
The formatted HTML string for one row.

init(locate, language)
Parameters:
locate
language

Documentation generated by JsDoc Toolkit 2.3.2 on Sun Jul 25 2010 13:49:31 GMT-0700 (PDT)