safeframe

<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8" /> <meta name="generator" content="JsDoc Toolkit" /> <title>$sf.pub.PosConfig | 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.PosConfig</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.PosConfig."> <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.PosConfig.html#constructor">$sf.pub.PosConfig</a></b>(posIDorObj, destID, baseConf) </div> <div class="description">Configure a particualar position for rendering a SafeFrame Each $sf.pub.PosConfig object has an id property that should be unique.</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.PosConfig</b>(posIDorObj, destID, baseConf) </div> <div class="description"> Configure a particualar position for rendering a SafeFrame Each $sf.pub.PosConfig object has an id property that should be unique. Creating a new $sf.pub.PosConfig with an id, that has already been used results in changing the old $sf.pub.PosConfig settings, and can only be done if the SafeFrames library is not busy. Automatically ads to the position map of the $sf.pub.Config object if said config has already been created. </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 $sf.pub.PosConfig instance, or an object containing all settings that are to be used for the instance.</dd> <dt> <span class="light fixedFont">{String}</span> <b>posIDorObj.id</b> <i>Optional</i> </dt> <dd>The id of the $sf.pub.PosConfig instance, if not specified one will be generated automatically.</dd> <dt> <span class="light fixedFont">{String}</span> <b>posIDorObj.dest</b> <i>Optional</i> </dt> <dd>The HTML element id attribute of the HTML element in the document where a SafeFrame will be rendered. Said element MUST exist within the page prior to a render.</dd> <dt> <span class="light fixedFont">{String}</span> <b>posIDorObj.bg</b> <i>Optional</i> </dt> <dd>The color of the background to be used inside the SafeFrame. Default equals "transparent".</dd> <dt> <span class="light fixedFont">{String}</span> <b>posIDorObj.tgt</b> <i>Optional</i> </dt> <dd>The name of the target window where hyperlinks inside a SafeFrame will navigate too...Note that "_self" is not allowed and always converted to "_top". Allowed values are any string value not prefixed with "_", or "_top" or "_blank".</dd> <dt> <span class="light fixedFont">{String}</span> <b>posIDorObj.css</b> <i>Optional</i> </dt> <dd>A string of CSS rules, or a URL that points to a CSS style sheet to be used inside the SafeFrame</dd> <dt> <span class="light fixedFont">{Number}</span> <b>posIDorObj.w</b> <i>Optional</i> </dt> <dd>The width of the SafeFrame, specified in pixels. Cannot be specified in em, % or another values.</dd> <dt> <span class="light fixedFont">{Number}</span> <b>posIDorObj.h</b> <i>Optional</i> </dt> <dd>The height of the SafeFrame, specified in pixels. Cannot be specified in em, % or another values.</dd> <dt> <span class="light fixedFont">{String}</span> <b>posIDorObj.size</b> <i>Optional</i> </dt> <dd>A string formated as "widthXheight", that defines the width and height of the SafeFrame. The delimiter character "X" is can be specified as lower or upper case.</dd> <dt> <span class="light fixedFont">{String}</span> <b>posIDorObj.z</b> <i>Optional</i> </dt> <dd>The z-index of the SafeFrame.</dd> <dt> <span class="light fixedFont">{Object}</span> <b>posIDorObj.supports</b> <i>Optional</i> </dt> <dd>An object containing key/value pairs for what features/actions are supported by the SafeFrame, and its corresponding value represents a boolean detereming whether that feature can be used. Currently supported keys are "exp-ovr" == SafeFrame can expand in overlay mode, "exp-push" == SafeFrame can expand in push mode, and "bg" == SafeFrame can change the background of the publisher / host.</dd> <dt> <span class="light fixedFont">{String}</span> <b>destID</b> <i>Optional</i> </dt> <dd>The HTML element id attribute of the HTML element in the document where a SafeFrame will be rendered. Said element MUST exist within the page prior to a render.</dd> <dt> <span class="light fixedFont">{Object}</span> <b>baseConf</b> <i>Optional</i> </dt> <dd>An object representing a $sf.pub.Config object to automatically use / create for the SafeFrames library. Note that baseConf can only be used one time, otherwise you have to use the $sf.pub.Config object directly.</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>