<p>[[Sandals.js]] is the interface to [[BeachHouse]].</p>
<h1>Global objects</h1>
<p>Sandals creates a few global objects. One of them is <code>app</code>.</p>
<p>The <code>app</code> object contains:</p>
<ul>
<li><code>name</code>, the name of the application window</li>
<li><code>location</code>, the location where the application is running</li>
<li><code>started</code>, tells us whether or not the application is running</li>
</ul>
<p>The other global object is <code>Sandals</code> where the important Sandals functions and objects are stored.</p>
<h1>Creating a Sandals.js Application</h1>
<p>The following is a list of steps to create the starting point for a Sandals.js application.</p>
<p>Load the Sandals.js interface file:<br />
<pre><br />
load(“sandals.js”);<br />
</pre></p>
<p>Use the JavaScript <code>with</code> statement with the global <code>Sandals</code> object<sup class="footnote"><a href="#fn1">1</a></sup>:<br />
<pre><br />
with (Sandals) {<br />
// Next step goes here<br />
}<br />
</pre></p>
<p>(<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Statements:with">Click here for information on the with statement</a>)</p>
<p>Within the body of the <code>with</code> statement, call the <code>go</code> function of the <code>Sandals</code> object with a function as an argument.</p>
<p>Whatever function you pass to <code>go</code>, it should accept no arguments:<br />
<pre><br />
go(function () {<br />
// Next step goes here<br />
}<br />
);<br />
</pre></p>
<p>Write up the body of the function. In this function, you have access to the global <code>app</code> object and any other variables in the global <code>Sandals</code> object:<br />
<pre><br />
para(“Woah, Sandals.js works!”);<br />
</pre></p>
<p>The final result looks like this:<br />
<pre><br />
load(“sandals.js”);<br />
with (Sandals) {<br />
go(function () {<br />
para(“Woah, Sandals.js works!”);<br />
}<br />
);<br />
)<br />
</pre></p>
<p>An alternative way of writing out this example application (it uses a global function and passes it to <code>Sandals.go</code>.):<br />
<pre><br />
function para_test() {<br />
with (Sandals) {<br />
para(“Woah, Sandals.js works!”);<br />
}<br />
// The above with can be re-written as:<br />
// Sandals.para(“Woah, Sandals.js works!”);<br />
}</p>
<p>load(“sandals.js”);<br />
Sandals.go(para_test);<br />
</pre></p>
<p class="footnote" id="fn1"><sup>1</sup> The <code>with (Sandals) { ... }</code> needs to be used with the <code>Sandals</code> global object because it contains the toolkit functions. If you didn’t use the <code>with</code> and you wanted to create a paragraph with some inserted text you would have to write <code>Sandals.para(Sandals.ins("Inserted text"), "...more text")</code>. If you <strong>really</strong> want to, you can have Sandals turn all of its functions into global functions with the <code>Sandals_to_global</code> function.</p>
2008-07-25T16:08:59-07:00
39630
usingsandals-js
37072
UsingSandals.js
2008-07-25T17:53:59-07:00
13960