<!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.NestedResults</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.Env.html">jasmine.Env</a></li> <li><a href="../symbols/jasmine.MultiReporter.html">jasmine.MultiReporter</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.Reporter.html">jasmine.Reporter</a></li> <li><a href="../symbols/jasmine.Runner.html">jasmine.Runner</a></li> <li><a href="../symbols/jasmine.Spec.html">jasmine.Spec</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.NestedResults </h1> <!-- ============================== class summary ========================== --> <p class="description"> <br /><i>Defined in: </i> <a href="../symbols/src/lib_jasmine.js.html">jasmine.js</a>. </p> <!-- ============================== constructor summary ==================== --> <table class="summaryTable" cellspacing="0" summary="A summary of the constructor documented in the class jasmine.NestedResults."> <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.NestedResults.html#constructor">jasmine.NestedResults</a></b>() </div> <div class="description">Holds results for a set of Jasmine spec.</div> </td> </tr> </tbody> </table> <!-- ============================== properties summary ===================== --> <table class="summaryTable" cellspacing="0" summary="A summary of the fields documented in the class jasmine.NestedResults."> <caption>Field Summary</caption> <thead> <tr> <th scope="col">Field Attributes</th> <th scope="col">Field Name and Description</th> </tr> </thead> <tbody> <tr> <td class="attributes"> </td> <td class="nameDescription"> <div class="fixedFont"> <b><a href="../symbols/jasmine.NestedResults.html#failedCount">failedCount</a></b> </div> <div class="description">Number of failed results</div> </td> </tr> <tr> <td class="attributes"> </td> <td class="nameDescription"> <div class="fixedFont"> <b><a href="../symbols/jasmine.NestedResults.html#passedCount">passedCount</a></b> </div> <div class="description">Number of passed results</div> </td> </tr> <tr> <td class="attributes"> </td> <td class="nameDescription"> <div class="fixedFont"> <b><a href="../symbols/jasmine.NestedResults.html#skipped">skipped</a></b> </div> <div class="description">Was this suite/spec skipped?</div> </td> </tr> <tr> <td class="attributes"> </td> <td class="nameDescription"> <div class="fixedFont"> <b><a href="../symbols/jasmine.NestedResults.html#totalCount">totalCount</a></b> </div> <div class="description">The total count of results</div> </td> </tr> </tbody> </table> <!-- ============================== methods summary ======================== --> <table class="summaryTable" cellspacing="0" summary="A summary of the methods documented in the class jasmine.NestedResults."> <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.NestedResults.html#addResult">addResult</a></b>(result) </div> <div class="description">Adds a result, tracking counts (total, passed, & failed)</div> </td> </tr> <tr> <td class="attributes"> </td> <td class="nameDescription"> <div class="fixedFont"><b><a href="../symbols/jasmine.NestedResults.html#getItems">getItems</a></b>() </div> <div class="description">Getter for the results: message & results.</div> </td> </tr> <tr> <td class="attributes"> </td> <td class="nameDescription"> <div class="fixedFont"><b><a href="../symbols/jasmine.NestedResults.html#log">log</a></b>(message) </div> <div class="description">Tracks a result's message.</div> </td> </tr> <tr> <td class="attributes"> </td> <td class="nameDescription"> <div class="fixedFont"><b><a href="../symbols/jasmine.NestedResults.html#passed">passed</a></b>() </div> <div class="description"></div> </td> </tr> <tr> <td class="attributes"> </td> <td class="nameDescription"> <div class="fixedFont"><b><a href="../symbols/jasmine.NestedResults.html#rollupCounts">rollupCounts</a></b>(result) </div> <div class="description">Roll up the result counts.</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.NestedResults</b>() </div> <div class="description"> Holds results for a set of Jasmine spec. Allows for the results array to hold another jasmine.NestedResults </div> </div> <!-- ============================== field details ========================== --> <div class="sectionTitle"> Field Detail </div> <a name="failedCount"> </a> <div class="fixedFont"> <b>failedCount</b> </div> <div class="description"> Number of failed results </div> <hr /> <a name="passedCount"> </a> <div class="fixedFont"> <b>passedCount</b> </div> <div class="description"> Number of passed results </div> <hr /> <a name="skipped"> </a> <div class="fixedFont"> <b>skipped</b> </div> <div class="description"> Was this suite/spec skipped? </div> <hr /> <a name="totalCount"> </a> <div class="fixedFont"> <b>totalCount</b> </div> <div class="description"> The total count of results </div> <!-- ============================== method details ========================= --> <div class="sectionTitle"> Method Detail </div> <a name="addResult"> </a> <div class="fixedFont"> <b>addResult</b>(result) </div> <div class="description"> Adds a result, tracking counts (total, passed, & failed) </div> <dl class="detailList"> <dt class="heading">Parameters:</dt> <dt> <span class="light fixedFont">{jasmine.ExpectationResult|<a href="../symbols/jasmine.NestedResults.html">jasmine.NestedResults</a>}</span> <b>result</b> </dt> <dd></dd> </dl> <hr /> <a name="getItems"> </a> <div class="fixedFont"> <b>getItems</b>() </div> <div class="description"> Getter for the results: message & results. </div> <hr /> <a name="log"> </a> <div class="fixedFont"> <b>log</b>(message) </div> <div class="description"> Tracks a result's message. </div> <dl class="detailList"> <dt class="heading">Parameters:</dt> <dt> <b>message</b> </dt> <dd></dd> </dl> <hr /> <a name="passed"> </a> <div class="fixedFont"> <span class="light">{Boolean}</span> <b>passed</b>() </div> <div class="description"> </div> <dl class="detailList"> <dt class="heading">Returns:</dt> <dd><span class="light fixedFont">{Boolean}</span> True if <b>everything</b> below passed</dd> </dl> <hr /> <a name="rollupCounts"> </a> <div class="fixedFont"> <b>rollupCounts</b>(result) </div> <div class="description"> Roll up the result counts. </div> <dl class="detailList"> <dt class="heading">Parameters:</dt> <dt> <b>result</b> </dt> <dd></dd> </dl> <!-- ============================== event details ========================= --> <hr /> </div> <!-- ============================== footer ================================= --> <div class="fineprint" style="clear:both"> Documentation generated by <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blank">JsDoc Toolkit</a> 2.3.0 on Thu Jul 09 2009 21:42:19 GMT-0700 (PDT) </div> </body> </html>