2009-06-28 20:25:26 +00:00
< !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 - jasmine.ActionCollection< / 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 > < i > < a href = "../symbols/_global_.html" > _global_< / a > < / i > < / li >
< li > < a href = "../symbols/jasmine.html" > jasmine< / a > < / li >
< li > < a href = "../symbols/jasmine.ActionCollection.html" > jasmine.ActionCollection< / a > < / li >
< li > < a href = "../symbols/jasmine.NestedResults.html" > jasmine.NestedResults< / a > < / li >
< li > < a href = "../symbols/jasmine.QueuedFunction.html" > jasmine.QueuedFunction< / a > < / li >
< li > < a href = "../symbols/jasmine.Runner.html" > jasmine.Runner< / a > < / li >
< li > < a href = "../symbols/jasmine.Spy.html" > jasmine.Spy< / a > < / li >
< li > < a href = "../symbols/jasmine.Suite.html" > jasmine.Suite< / a > < / li >
< li > < a href = "../symbols/jasmine.util.html" > jasmine.util< / a > < / li >
< / ul >
< hr / >
<!-- end publish.classesIndex -->
< / div >
< div id = "content" >
<!-- ============================== class title ============================ -->
< h1 class = "classTitle" >
Class jasmine.ActionCollection
< / h1 >
<!-- ============================== class summary ========================== -->
< p class = "description" >
< br / > < i > Defined in: < / i > < a href = "../symbols/src/src_ActionCollection.js.html" > ActionCollection.js< / a > .
< / p >
<!-- ============================== constructor summary ==================== -->
< table class = "summaryTable" cellspacing = "0" summary = "A summary of the constructor documented in the class jasmine.ActionCollection." >
< caption > Class 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/jasmine.ActionCollection.html#constructor" > jasmine.ActionCollection< / a > < / b > (env)
< / div >
< div class = "description" > base for Runner & Suite: allows for a queue of functions to get executed, allowing for
any one action to complete, including asynchronous calls, before going to the next
action.< / div >
< / td >
< / tr >
< / tbody >
< / table >
<!-- ============================== properties summary ===================== -->
<!-- ============================== methods summary ======================== -->
< table class = "summaryTable" cellspacing = "0" summary = "A summary of the methods documented in the class jasmine.ActionCollection." >
< 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" > < / td >
< td class = "nameDescription" >
< div class = "fixedFont" > < b > < a href = "../symbols/jasmine.ActionCollection.html#execute" > execute< / a > < / b > ()
< / div >
< div class = "description" > Starts executing the queue of functions/actions.< / div >
< / td >
< / tr >
< tr >
< td class = "attributes" > < / td >
< td class = "nameDescription" >
< div class = "fixedFont" > < b > < a href = "../symbols/jasmine.ActionCollection.html#finish" > finish< / a > < / b > ()
< / div >
< div class = "description" > Marks the collection as done & calls the finish callback, if there is one< / div >
< / td >
< / tr >
< tr >
< td class = "attributes" > < / td >
< td class = "nameDescription" >
< div class = "fixedFont" > < b > < a href = "../symbols/jasmine.ActionCollection.html#getCurrentAction" > getCurrentAction< / a > < / b > ()
< / div >
< div class = "description" > Gets the current action.< / div >
< / td >
< / tr >
< tr >
< td class = "attributes" > < / td >
< td class = "nameDescription" >
< div class = "fixedFont" > < b > < a href = "../symbols/jasmine.ActionCollection.html#next" > next< / a > < / b > ()
< / div >
< div class = "description" > Executes the next queued function/action.< / div >
< / td >
< / tr >
< tr >
< td class = "attributes" > < / td >
< td class = "nameDescription" >
< div class = "fixedFont" > < b > < a href = "../symbols/jasmine.ActionCollection.html#waitForDone" > waitForDone< / a > < / b > (action)
< / div >
< div class = "description" > < / div >
< / td >
< / tr >
< / tbody >
< / table >
<!-- ============================== events summary ======================== -->
<!-- ============================== constructor details ==================== -->
< div class = "details" > < a name = "constructor" > < / a >
< div class = "sectionTitle" >
Class Detail
< / div >
< div class = "fixedFont" >
< b > jasmine.ActionCollection< / b > (env)
< / div >
< div class = "description" >
base for Runner & Suite: allows for a queue of functions to get executed, allowing for
any one action to complete, including asynchronous calls, before going to the next
action.
< / div >
< dl class = "detailList" >
< dt class = "heading" > Parameters:< / dt >
< dt >
< span class = "light fixedFont" > {< a href = "../symbols/jasmine.html#.Env" > jasmine.Env< / a > }< / span > < b > env< / b >
< / dt >
< dd > < / dd >
< / dl >
< / div >
<!-- ============================== field details ========================== -->
<!-- ============================== method details ========================= -->
< div class = "sectionTitle" >
Method Detail
< / div >
< a name = "execute" > < / a >
< div class = "fixedFont" >
< b > execute< / b > ()
< / div >
< div class = "description" >
Starts executing the queue of functions/actions.
< / div >
< hr / >
< a name = "finish" > < / a >
< div class = "fixedFont" >
< b > finish< / b > ()
< / div >
< div class = "description" >
Marks the collection as done & calls the finish callback, if there is one
< / div >
< hr / >
< a name = "getCurrentAction" > < / a >
< div class = "fixedFont" >
< b > getCurrentAction< / b > ()
< / div >
< div class = "description" >
Gets the current action.
< / div >
< hr / >
< a name = "next" > < / a >
< div class = "fixedFont" >
< b > next< / b > ()
< / div >
< div class = "description" >
Executes the next queued function/action. If there are no more in the queue, calls #finish.
< / div >
< hr / >
< a name = "waitForDone" > < / a >
< div class = "fixedFont" >
< b > waitForDone< / b > (action)
< / div >
< div class = "description" >
< / div >
< dl class = "detailList" >
< dt class = "heading" > Parameters:< / dt >
< dt >
< b > action< / b >
< / dt >
< dd > < / dd >
< / dl >
<!-- ============================== event details ========================= -->
< hr / >
< / div >
<!-- ============================== footer ================================= -->
< div class = "fineprint" style = "clear:both" >
2009-06-28 20:35:52 +00:00
Documentation generated by < a href = "http://code.google.com/p/jsdoc-toolkit/" target = "_blank" > JsDoc Toolkit< / a > 2.3.0 on Sun Jun 28 2009 13:34:05 GMT-0700 (PDT)
2009-06-28 20:25:26 +00:00
< / div >
< / body >
< / html >
