<!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 - rio.Utils</title>
<style type="text/css">
/* default.css */
body
{
font: 12px "Lucida Grande", Tahoma, Arial, Helvetica, sans-serif;
/* width: 100%;*/
}
.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
{
width: 98%;
}
.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="content">
<!-- ============================== class title ============================ -->
<h1 class="classTitle">
Namespace rio.Utils
</h1>
<!-- ============================== class summary ========================== -->
<p class="description">
Random utility methods
<br /><i>Defined in: </i> <a href="../symbols/src/public_javascripts_lib_utils.js.html">utils.js</a>.
</p>
<!-- ============================== constructor summary ==================== -->
<table class="summaryTable" cellspacing="0" summary="A summary of the constructor documented in the class rio.Utils.">
<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"> </td>
<td class="nameDescription" >
<div class="fixedFont">
<b><a href="../symbols/rio.Utils.html#constructor">rio.Utils</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 rio.Utils.">
<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"><static> </td>
<td class="nameDescription">
<div class="fixedFont">rio.Utils.<b><a href="../symbols/rio.Utils.html#.baseUrl">baseUrl</a></b>()
</div>
<div class="description"></div>
</td>
</tr>
<tr>
<td class="attributes"><static> </td>
<td class="nameDescription">
<div class="fixedFont">rio.Utils.<b><a href="../symbols/rio.Utils.html#.browserFromUserAgent">browserFromUserAgent</a></b>(agt)
</div>
<div class="description"></div>
</td>
</tr>
<tr>
<td class="attributes"><static> </td>
<td class="nameDescription">
<div class="fixedFont">rio.Utils.<b><a href="../symbols/rio.Utils.html#.cycle">cycle</a></b>(var1, var2)
</div>
<div class="description">Alternates returning the two input arguments.</div>
</td>
</tr>
<tr>
<td class="attributes"><static> </td>
<td class="nameDescription">
<div class="fixedFont">rio.Utils.<b><a href="../symbols/rio.Utils.html#.navigateTo">navigateTo</a></b>(location, action, token)
</div>
<div class="description">Navigates to a given URL, allowing you to set the Rails-style HTTP method.</div>
</td>
</tr>
<tr>
<td class="attributes"><static> </td>
<td class="nameDescription">
<div class="fixedFont">rio.Utils.<b><a href="../symbols/rio.Utils.html#.osFromUserAgent">osFromUserAgent</a></b>(agt)
</div>
<div class="description"></div>
</td>
</tr>
<tr>
<td class="attributes"><static> </td>
<td class="nameDescription">
<div class="fixedFont">rio.Utils.<b><a href="../symbols/rio.Utils.html#.pluralize">pluralize</a></b>(num, singular, plural)
</div>
<div class="description">Returns the singular argument if num == 1, otherwise returns the plural argument.</div>
</td>
</tr>
<tr>
<td class="attributes"><static> </td>
<td class="nameDescription">
<div class="fixedFont">rio.Utils.<b><a href="../symbols/rio.Utils.html#.urlWithoutHash">urlWithoutHash</a></b>()
</div>
<div class="description"></div>
</td>
</tr>
</tbody>
</table>
<!-- ============================== constructor details ==================== -->
<div class="details"><a name="constructor"> </a>
<div class="sectionTitle">
Namespace Detail
</div>
<div class="fixedFont">
<b>rio.Utils</b>
</div>
<div class="description">
</div>
</div>
<!-- ============================== field details ========================== -->
<!-- ============================== method details ========================= -->
<div class="sectionTitle">
Method Detail
</div>
<a name=".baseUrl"> </a>
<div class="fixedFont"><static>
<span class="light">rio.Utils.</span><b>baseUrl</b>()
</div>
<div class="description">
</div>
<hr />
<a name=".browserFromUserAgent"> </a>
<div class="fixedFont"><static>
<span class="light">rio.Utils.</span><b>browserFromUserAgent</b>(agt)
</div>
<div class="description">
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<b>agt</b>
</dt>
<dd></dd>
</dl>
<hr />
<a name=".cycle"> </a>
<div class="fixedFont"><static>
<span class="light">rio.Utils.</span><b>cycle</b>(var1, var2)
</div>
<div class="description">
Alternates returning the two input arguments.
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<b>var1</b>
</dt>
<dd></dd>
<dt>
<b>var2</b>
</dt>
<dd></dd>
</dl>
<hr />
<a name=".navigateTo"> </a>
<div class="fixedFont"><static>
<span class="light">rio.Utils.</span><b>navigateTo</b>(location, action, token)
</div>
<div class="description">
Navigates to a given URL, allowing you to set the Rails-style HTTP method.
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{String}</span> <b>location</b>
</dt>
<dd>The url to goto</dd>
<dt>
<span class="light fixedFont">{String}</span> <b>action</b>
</dt>
<dd>(optional) The HTTP verb to use. (currently supports get|delete)</dd>
<dt>
<span class="light fixedFont">{String}</span> <b>token</b>
</dt>
<dd>(optional) A Rails-style authenticity token</dd>
</dl>
<hr />
<a name=".osFromUserAgent"> </a>
<div class="fixedFont"><static>
<span class="light">rio.Utils.</span><b>osFromUserAgent</b>(agt)
</div>
<div class="description">
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<b>agt</b>
</dt>
<dd></dd>
</dl>
<hr />
<a name=".pluralize"> </a>
<div class="fixedFont"><static>
<span class="light">rio.Utils.</span><b>pluralize</b>(num, singular, plural)
</div>
<div class="description">
Returns the singular argument if num == 1, otherwise returns the plural argument.
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{Number}</span> <b>num</b>
</dt>
<dd>The number to be evaluated for plurality</dd>
<dt>
<span class="light fixedFont">{<a href="../symbols/Object.html#constructor">Object</a>}</span> <b>singular</b>
</dt>
<dd>The return value if num == 1</dd>
<dt>
<span class="light fixedFont">{<a href="../symbols/Object.html#constructor">Object</a>}</span> <b>plural</b>
</dt>
<dd>The return value if num != 1</dd>
</dl>
<hr />
<a name=".urlWithoutHash"> </a>
<div class="fixedFont"><static>
<span class="light">rio.Utils.</span><b>urlWithoutHash</b>()
</div>
<div class="description">
</div>
<hr />
</div>
<!-- ============================== footer ================================= -->
<div class="fineprint" style="clear:both">
Documentation generated by <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a> 2.0.2 on Fri Jan 29 2010 14:20:38 GMT-0600 (CST)
</div>
</body>
</html>