safeframe

<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8" /> <meta name="generator" content="JsDoc Toolkit" /> <title>$sf.pub.Position | SafeFrames JS API</title> <meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0" /> <meta name="mobileoptimized" content="0" /> <link rel="stylesheet" href="../css/all.css" media="all" /> <link rel="stylesheet" href="../css/handheld.css" media="only screen and (max-width: 660px)" /> <link rel="stylesheet" href="../css/handheld.css" media="handheld" /> <link rel="stylesheet" href="../css/screen.css" media="screen and (min-width: 661px)" /> <script src="../javascript/all.js"></script>  </head> <body> <div class="index"> <div class="menu"> <div class="indexLinks"> </div> <h2 class="heading1">Classes</h2> <input type="text" name="classFilter" class="classFilter" id="ClassFilter" placeholder="Filter"></input> <nav> <ul class="classList" id="ClassList"> <li><a href="../symbols/%24sf.html">$sf</a></li> <li><a href="../symbols/%24sf.env.html">$sf<span class='break'> </span>.<span class='break'> </span>env</a></li> <li><a href="../symbols/%24sf.env.ua.html">$sf<span class='break'> </span>.<span class='break'> </span>env<span class='break'> </span>.<span class='break'> </span>ua</a></li> <li><a href="../symbols/%24sf.lib.html">$sf<span class='break'> </span>.<span class='break'> </span>lib</a></li> <li><a href="../symbols/%24sf.lib.dom.html">$sf<span class='break'> </span>.<span class='break'> </span>lib<span class='break'> </span>.<span class='break'> </span>dom</a></li> <li><a href="../symbols/%24sf.lib.dom.iframes.html">$sf<span class='break'> </span>.<span class='break'> </span>lib<span class='break'> </span>.<span class='break'> </span>dom<span class='break'> </span>.<span class='break'> </span>iframes</a></li> <li><a href="../symbols/%24sf.lib.dom.msghost.html">$sf<span class='break'> </span>.<span class='break'> </span>lib<span class='break'> </span>.<span class='break'> </span>dom<span class='break'> </span>.<span class='break'> </span>msghost</a></li> <li><a href="../symbols/%24sf.lib.lang.html">$sf<span class='break'> </span>.<span class='break'> </span>lib<span class='break'> </span>.<span class='break'> </span>lang</a></li> <li><a href="../symbols/%24sf.lib.lang.ParamHash.html">$sf<span class='break'> </span>.<span class='break'> </span>lib<span class='break'> </span>.<span class='break'> </span>lang<span class='break'> </span>.<span class='break'> </span>ParamHash</a></li> <li><a href="../symbols/%24sf.pub.html">$sf<span class='break'> </span>.<span class='break'> </span>pub</a></li> <li><a href="../symbols/%24sf.pub.Config.html">$sf<span class='break'> </span>.<span class='break'> </span>pub<span class='break'> </span>.<span class='break'> </span>Config</a></li> <li><a href="../symbols/%24sf.pub.PosConfig.html">$sf<span class='break'> </span>.<span class='break'> </span>pub<span class='break'> </span>.<span class='break'> </span>PosConfig</a></li> <li><a href="../symbols/%24sf.pub.Position.html">$sf<span class='break'> </span>.<span class='break'> </span>pub<span class='break'> </span>.<span class='break'> </span>Position</a></li> <li><a href="../symbols/%24sf.vend.html">$sf<span class='break'> </span>.<span class='break'> </span>vend</a></li> </ul> </nav> </div> <div class="fineprint" style="clear:both"> <footer> Documentation generator: <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blank">JsDoc Toolkit</a> 2.4.0<br /> Template: <a href="" target="_blank">Codeview</a> 1.2.1<br /> Generated on: <time datetime='2012-7-6' pubdate>2012-7-6 16:05</time> </footer> </div> </div> <div class="index indexStatic"></div> <div class="content"> <div class="innerContent"> <article> <header> <h1 class="classTitle"> Class <span>$sf.pub.Position</span> </h1> <div class="intro"> <p class="description summary"> </p> <ul class="summary"> </ul> </div> </header> <section> <div class="props"> <table class="summaryTable" cellspacing="0" summary="A summary of the constructor documented in the class $sf.pub.Position."> <caption class="sectionTitle">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/%24sf.pub.Position.html#constructor">$sf.pub.Position</a></b>(posIDorObj, html, meta, conf) </div> <div class="description">Construction a postion content object that contains HTML, optionally meta-data, and optionally a position configuration to use.</div> </td> </tr> </tbody> </table> </div> </section>    <section> <div class="details props"> <div class="innerProps"> <h2 class="sectionTitle" id="constructor"> Class Detail </h2> <div class="fixedFont"> <b>$sf.pub.Position</b>(posIDorObj, html, meta, conf) </div> <div class="description"> Construction a postion content object that contains HTML, optionally meta-data, and optionally a position configuration to use. The id specified must match an id for a $sf.pub.PosConfig (although said config could be specfied directly here via arguments). </div> <dl class="detailList params"> <dt class="heading">Parameters:</dt> <dt> <span class="light fixedFont">{Object|String}</span> <b>posIDorObj</b> </dt> <dd>The id of the position which maps to its configuration, or an object represeting the various values of an $sf.pub.Position instance.</dd> <dt> <span class="light fixedFont">{String}</span> <b>posIDorObj.id</b> <i>Optional</i> </dt> <dd>The id of the position which maps to its configuration.</dd> <dt> <span class="light fixedFont">{String}</span> <b>posIDorObj.html</b> <i>Optional</i> </dt> <dd>The HTML content to be rendered inside the SafeFrame. Note that HTML strings which have SCRIPT tags or other special characters may need to be properly escaped in order to avoid JavaScript syntax errors.</dd> <dt> <span class="light fixedFont">{String}</span> <b>posIDorObj.src</b> <i>Optional</i> </dt> <dd>An optional URL to be used for redering inside the SafeFrame which will automatically generate a SCRIPT tag with the specified URL.</dd> <dt> <span class="light fixedFont">{$sf.pub.PosMeta}</span> <b>posIDorObj.meta</b> <i>Optional</i> </dt> <dd>An optional instance of the $sf.pub.PosMeta object to be passed along into the SafeFrame</dd> <dt> <span class="light fixedFont">{Object}</span> <b>posIDorObj.conf</b> <i>Optional</i> </dt> <dd>An optional representation of an $sf.pub.PosConfig object to be used as the configuration for the SafeFrame position.</dd> <dt> <span class="light fixedFont">{String}</span> <b>html</b> <i>Optional</i> </dt> <dd>The HTML content to be rendered inside the SafeFrame. Note that HTML strings which have SCRIPT tags or other special characters may need to be properly escaped in order to avoid JavaScript syntax errors.</dd> <dt> <span class="light fixedFont">{$sf.pub.PosMeta}</span> <b>meta</b> <i>Optional</i> </dt> <dd>An optional instance of the $sf.pub.PosMeta object to be passed along into the SafeFrame</dd> <dt> <span class="light fixedFont">{Object}</span> <b>conf</b> <i>Optional</i> </dt> <dd>An optional representation of an $sf.pub.PosConfig object to be used as the configuration for the SafeFrame position.</dd> </dl> </div> </div> </section>    </article> </div> </div> <script type="text/javascript"> wbos.CssTools.MediaQueryFallBack.LoadCss('../css/screen.css', '../css/handheld.css', 660) codeview.classFilter.Init() </script> </body> </html>