+++ /dev/null
-<!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={+Options.encoding+}" />
- <meta name="generator" content="JsDoc Toolkit" />
- {! Link.base = "../"; /* all generated links will be relative to this */ !}
-
- <title>JsDoc Reference - {+data.alias+}</title>
-
-
- <link rel="stylesheet" type="text/css" href="../../css/roojs.css" />
- <link rel="stylesheet" type="text/css" href="../default.css" />
-
-
- <script type="text/javascript" src="../page.js">
-
- </script>
-
-
- </head>
-
- <body onload="RooDocsPage.onload();">
-
-
-<div class="body-wrap">
-
- <!-- ============================== links to methods. ================================= -->
-
- <div class="top-tools">
- <!--
- <a class="inner-link" href="#{+data.alias+}-props"><img src="resources/s.gif" class="item-icon icon-prop">Properties</a>
- <a class="inner-link" href="#{+data.alias+}-methods"><img src="resources/s.gif" class="item-icon icon-method">Methods</a>
- <a class="inner-link" href="#{+data.alias+}-events"><img src="resources/s.gif" class="item-icon icon-event">Events</a>
- <a class="inner-link" href="#{+data.alias+}-configs"><img src="resources/s.gif" class="item-icon icon-config">Config Options</a>
- <a class="bookmark" href="NEED_TO_CREATE_DIRECT_LINK_HREF"><img src="resources/s.gif" class="item-icon icon-fav">Direct Link</a>
- -->
- </div>
-
-
-<!-- ============================== inheritance Block. ================================= -->
- <if test="data.augments.length">
- <div class="inheritance res-block">
- <pre class="res-block-inner">{!
- var iblock_indent = 0;
- data.augments.reverse().map(
- function($) {
- output += iblock_indent ? ('<img src="../../images/default/s.gif" height="1" width="' +
- iblock_indent + '"/><img src="../../images/default/tree/elbow-end.gif" class="elbow"/>') : '';
- output += new Link().toSymbol($) + "\n";
- iblock_indent += 20;
- }
- )
- !}<img src="../../images/default/s.gif" height="1" width="{+ iblock_indent +}"/><img class="elbow" src="../../images/default/tree/elbow-end.gif"/>{+data.alias+}
-
- </pre>
- </div>
- </if>
-<!-- ============================== class title / details ============================ -->
-
- {!
- var fullpath = data.alias.split('.');
- var cls = fullpath.pop();
- var packge = fullpath.join(".");
-
-
-
- !}
- <h1 class="classTitle">
- {!
- var classType = "";
-
- if (data.isBuiltin()) {
- classType += "Built-In ";
- }
-
- if (data.isNamespace) {
- if (data.is('FUNCTION')) {
- classType += "Function ";
- }
- classType += "Namespace ";
- }
- else {
- classType += "Class ";
- }
- !}
- {+classType+}{+data.alias+}
- </h1>
-
- <table cellspacing="0" class="class-summary-table">
- <if test="packge.length">
- <tr><td class="label">Package:</td><td class="hd-info">{+packge+}</td></tr>
- </if>
- <tr><td class="label">Defined In:</td><td class="hd-info">
- <if test="data.srcFile.length">{# isn't defined in any file #}
- {+new Link({
- url : './src/' + Link.srcFileFlatName(data.srcFile),
- text : Link.srcFileRelName(data.srcFile)
- })+}.
- </if>
- </td></tr>
- <tr><td class="label">Class:</td><td class="hd-info">{+cls+}</td></tr>
-
- <if test="data.childClasses.length">
- <tr><td class="label">Subclasses:</td><td class="hd-info">
- {+
- data.childClasses
- .sort()
- .map(
- function($) { return new Link().toSymbol($); }
- )
- .join(", ")
- +}
-
-
-
- </td></tr>
- </if>
- <if test="data.augments.length">
-
- <tr><td class="label">Extends:</td><td class="hd-info">
- {+
- new Link().toSymbol(data.augments[data.augments.length -1])
-
- +}
-
- </td></tr>
- </if>
-
- </table>
-
-
-<!-- ============================== class summary ========================== -->
- <div class="description">
- {+resolveLinks(data.desc)+}
- </div>
-
-
-<!-- ============================== Class comment block... ========================== -->
-
-<div class="comments">
- <b>Class Comments / Notes</B> =>
- <u onclick="parent.CommentDialog.showCommentId = '{+data.alias+}';">[Add Your comment/notes about this class]</u>
- <br/>
- <iframe frameborder="0" id="comments-{+data.memberOf+}" style="border: none;width:100%;"
- src="/blog.php/GtkDjsComments/{+data.alias+}.html"></iframe>
-</div>
-
-
-
-<!-- ============================== config options ========================== -->
-
-
- {!
-
-
-
- var cfgProperties = [];
- if (!data.comment.getTag('singleton').length) {
- cfgProperties = data.configToArray();
- cfgProperties = cfgProperties.sort(makeSortby("name"));
-
- }
-
-
-
- !}
-
- <div class="hr"></div>
- <a id="{+data.alias+}-configs"></a>
-
- <if test="!cfgProperties.length">
-
- <table cellspacing="0" class="member-table">
- <caption class="Empty">Config Options - Has None</caption>
- </table>
-
- </if>
-
- <if test="cfgProperties.length">
-
- <table cellspacing="0" class="member-table">
- <caption>Config Options (Usually are also Properties)</caption>
-
-
- <tr>
- <th class="sig-header" colspan="2">Options</th>
-
- <th class="msource-header">Defined By</th>
- </tr>
-
-
-
- <for each="dtag" in="cfgProperties">
-
- <tr class="config-row expandable config-row-alt{+$dtag_i % 2+}{+ ((dtag.memberOf == data.alias) ? " notInherited" : "") +}">
- <td class="micon"><a class="exi" href="#expand"> </a></td>
- <td class="sig">
-
- <a id="{+dtag.memberOf+}-cfg-{+dtag.name+}" name=".{+dtag.name+}"></a>
- <div class="fixedFont">
- <b class="itemname">{+dtag.name+}</b> : {+((dtag.type) ? (new Link().toSymbol(dtag.type)) : "" )+}
-
-
- </div>
-
- <div class="mdesc">
- <div class="short">{+resolveLinks(summarize(dtag.desc))+}</div>
- </div>
-
- <div class="mdesc">
- <div class="long">
- {+resolveLinks(dtag.desc)+}
- {+dtag.optvalues ? ("<BR/>Possible Values: " + dtag.optvalues.map(function(v) { return v.length ? v : "<B>Empty</B>"; }).join(", ")) : '' +}
- </div>
- </div>
-
-
-
- </td>
- <td class="msource">
- {# - fixme - add inheritied as link here #}
- {+ (dtag.memberOf == data.alias) ? dtag.memberOf : new Link().toSymbol(dtag.memberOf) +}
-
- </td>
- </tr>
- </for>
-
- </table>
- </if>
-
-
-
-
-
-
-
-
- <!-- ============================== public properties ==================== -->
-
-
-
- <a id="{+data.alias+}-props"></a>
-
- {!
- var ownProperties = [];
- var psorted = data.properties.sort(makeSortby("name"));
- psorted.filter(
-
- function($){
- if (/$.hide/.test($.desc)) {
- return false;
- }
- if ( !$.isNamespace || (($.memberOf != data.alias) && $.isStatic)) {
- if ($.isStatic) ownProperties.push($);
- }
- return true;
-
- }
- );
-
- !}
-
- <if test="!ownProperties.length">
-
- <table cellspacing="0" class="member-table">
- <caption class="Empty">Public Properties - Has None</caption>
- </table>
-
- </if>
-
- <if test="ownProperties.length">
-
- <table cellspacing="0" class="member-table">
- <caption>Public Properties </caption>
- <tr>
- <th class="sig-header" colspan="2">Property</th>
- <th class="sig-header">Description</th>
- <th class="msource-header">Defined By</th>
- </tr>
-
-
-
-
- <for each="member" in="ownProperties">
-
-
-
- <tr class="property-row config-row-alt{+$member_i % 2+}{!
-
- if (member.memberOf == data.alias) {
- output += " notInherited";
- }
-
- !}">
- <td class="micon">
- <a class="exi" href="#expand"> </a>
- </td>
- <td class="sig">
- <a id="{+member.memberOf+}-prop-{+member.name+}" name=".{+member.name+}"></a>
- <div class="fixedFont">
- <span class="attributes">{!
- if (member.isPrivate) output += "<private> ";
- if (member.isInner) output += "<inner> ";
-
- if (member.isConstant) output += "<constant> ";
- if (member.isStatic) output += ""+data.alias +".";
- !}</span><b class="itemname">{+member.name+}</b> :
- <span type="etype">{+((member.type) ? (new Link().toSymbol(member.type)) : "" )+}</span>
- </div>
- </td>
- <td class="sig">
- <div class="mdesc">
-
-
- <div class="short">
- {+resolveLinks(summarize(member.desc))+}
-
-
-
- </div>
-
- <div class="long">
-
- {+resolveLinks(member.desc)+}
-
- </div>
- </div>
- </td>
-
- <td class="msource">
- {+ (member.memberOf == data.alias) ? member.memberOf : new Link().toSymbol(member.memberOf) +}
- </td>
-
- </tr>
- </for>
-
-
-
-
- <!-- TODO: implement this alt row. also notice non-linked "Defined by" when property is a part of this class.
- <tr class="property-row alt">
-
- -->
-
- </table>
-
- </if>
- <!-- ============================== methods summary / details ======================== -->
-
-
- <a id="{+data.alias+}-methods"></a>
- <!-- constructor?? -->
- {!
- var ownMethods = [];
-
- if (data.comment.getTag('class').length &&
- !data.isBuiltin() &&
- !data.comment.getTag('singleton').length &&
- !data.comment.getTag('static').length
- ) {
- data.isInherited = false;
- ownMethods.push(data);
- }
-
- var msorted = data.methods.sort(makeSortby("name"));
- !}
- <!-- static's first
-
-
- -->
- {!
- msorted.filter(
- function($){
-
- if (/@hide/.test($.desc)) {
- return false;
- }
-
- if (!$.isEvent && (data.comment.getTag("instanceOf").length || data.comment.getTag("singleton").length)) {
- if ($.isStatic && (data.comment.getTag("instanceOf").length || data.comment.getTag("singleton").length) &&
- ($.memberOf != data.alias)) {
- return true;
- }
- $.isInherited = ($.memberOf != data.alias);
- ownMethods.push($);
- return true;
- }
-
-
- if ($.isNamespace || $.isEvent || (($.memberOf != data.alias) && $.isStatic)){
- return true;
- }
- if ($.isStatic) {
- $.isInherited = ($.memberOf != data.alias);
- ownMethods.push($);
- }
-
- return true;
- }
- );
- !}
- <!-- then dynamics first -->
- {!
- msorted.filter(
- function($){
- if (/@hide/.test($.desc)) {
- return false;
- }
- if (data.comment.getTag("instanceOf").length || data.comment.getTag("singleton").length) {
- return true;
- }
- if ($.isNamespace || $.isEvent || (($.memberOf != data.alias) && $.isStatic)){
-
- return true;
- }
- if (!$.isStatic) {
- $.isInherited = ($.memberOf != data.alias);
- ownMethods.push($);
- }
-
- return true;
- }
- );
-
- !}
-
-
- <if test="!ownMethods.length">
-
- <table cellspacing="0" class="member-table">
- <caption class="Empty">Public Methods - Has None</caption>
- </table>
-
- </if>
- <if test="ownMethods.length">
-
- <table cellspacing="0" class="member-table">
- <caption>Public Methods</caption>
- <tr>
- <th class="sig-header" colspan="2">Method</th>
- <th class="msource-header">Defined By</th>
-
- </tr>
-
-
-
-
-
- <for each="member" in="ownMethods">
-
- <tr class="method-row config-row-alt{+$member_i % 2+}{!
- if (member.is("CONSTRUCTOR") && !member.params.length) {
- output += '';
- } else {
- output += ' expandable';
- }
-
-
- if (!member.isInherited) {
- output += " notInherited";
- }
-
- !}">
- <td class="micon"><a class="exi" href="#expand"> </a></td>
-
-
- <td class="sig">
- <a id="{+member.memberOf+}-method-{+member.name+}" name=".{+member.name+}"></a>
- <div class="fixedFont">
- <span class="attributes">{!
- if (member.is('CONSTRUCTOR')) {
- output += "new <B>" + member.memberOf + (member.memberOf.length ? "." : "") +"</B>";
- } else {
-
-
- if (member.isPrivate) output += "<private> ";
- if (member.isInner) output += "<inner> ";
- if (member.isStatic || data.comment.getTag("singleton").length || data.comment.getTag("instanceOf").length) {
- output += data.alias + ".";
- }
- }
- !}</span><b class="itemname">{+member.name+}</b>
-
- {+makeSignature(member.params)+}
-
- <if test="member.returns.length">
- :
- <for each="item" in="member.returns">
- <if test="$item_i > 0"> or </if>
- {+((item.type) ? (new Link().toSymbol(item.type)) : "" )+}
-
- </for>
-
- </if>
-
- </div>
- <div class="mdesc">
- <if test="!member.is('CONSTRUCTOR')">
- <div class="short">{+resolveLinks(summarize(member.desc))+}</div>
- </if>
- <if test="member.is('CONSTRUCTOR')">
- <div class="short">Create a new {+data.alias +}</div>
- </if>
-
- <div class="long">
- <if test="!member.is('CONSTRUCTOR')">
- {+resolveLinks(member.desc)+}
-
- <if test="member.example">
- <pre class="code">{+member.example+}</pre>
- </if>
- </if>
-
- <if test="member.is('CONSTRUCTOR')">
- Create a new {+data.alias +}
- </if>
- <if test="member.params.length">
- <dl class="detailList">
- <dt class="heading">Parameters:</dt>
- <for each="item" in="member.params">
- <dt>
- {+((item.type)?"<span class=\"fixedFont\">"+(new Link().toSymbol(item.type))+"</span> " : "")+} <b>{+item.name+}</b>
- <if test="item.isOptional"><i>Optional
- <if test="item.defaultValue">,
- Default: {+item.defaultValue+}
- </if></i></if>
- </dt>
- <dd>{+resolveLinks(item.desc)+}</dd>
- </for>
- </dl>
- </if>
- <if test="member.deprecated">
- <dl class="detailList">
- <dt class="heading">Deprecated:</dt>
- <dt>
- {+member.deprecated+}
- </dt>
- </dl>
- </if>
- <if test="member.since.length">
- <dl class="detailList">
- <dt class="heading">Since:</dt>
- <dd>{+ member.since +}</dd>
- </dl>
- </dl>
- </if>
- <if test="member.exceptions.length">
- <dl class="detailList">
- <dt class="heading">Throws:</dt>
- <for each="item" in="member.exceptions">
- <dt>
- {+((item.type)?"<span class=\"fixedFont\">{"+(new Link().toSymbol(item.type))+"}</span> " : "")+} <b>{+item.name+}</b>
- </dt>
- <dd>{+resolveLinks(item.desc)+}</dd>
- </for>
- </dl>
- </if>
- <if test="member.returns.length">
- <dl class="detailList">
- <dt class="heading">Returns:</dt>
- <for each="item" in="member.returns">
- <dd>{+((item.type)?"<span class=\"fixedFont\">"+(new Link().toSymbol(item.type))+"</span> " : "")+} {+resolveLinks(item.desc)+}</dd>
- </for>
- </dl>
- </if>
- <if test="member.requires.length">
- <dl class="detailList">
- <dt class="heading">Requires:</dt>
- <for each="item" in="member.requires">
- <dd>{+ resolveLinks(item) +}</dd>
- </for>
- </dl>
- </if>
- <if test="member.see.length">
- <dl class="detailList">
- <dt class="heading">See:</dt>
- <for each="item" in="member.see">
- <dd>{+ new Link().toSymbol(item) +}</dd>
- </for>
- </dl>
- </if>
-
-
-
-
- </div>
- </div>
-
- </td>
- <td class="msource">
- <if test="!member.is('CONSTRUCTOR')">
- {+ (member.memberOf == data.alias) ? member.memberOf : new Link().toSymbol(member.memberOf) +}
- </if>
- </td>
- </tr>
- </for>
-
- </table>
-</if>
-
- <!-- ============================== events summary / details ======================== -->
-
-
- <a id="{+data.alias+}-events"></a>
-
-
- {!
-
-
- var ownEvents = data.methods.filter(
- function($){
-
- return $.isEvent && !$.comment.getTag('hide').length;
-
- }
- ).sort(makeSortby("name"));
-
- !}
- <if test="!ownEvents.length">
-
- <table cellspacing="0" class="member-table">
- <caption class="Empty">Events - Has None</caption>
- </table>
-
- </if>
-
-
- <if test="ownEvents.length">
-
- <table cellspacing="0" class="member-table">
- <caption>Events</caption>
- <thead>
- <tr>
- <th class="sig-header" colspan="2">Event</th>
- <th class="msource-header">Defined By</th>
-
- </tr>
- </thead>
-
-
-
-
- <for each="member" in="ownEvents">
- <tr class="method-row expandable config-row-alt{+$member_i % 2+}{!
-
- if (member.memberOf == data.alias) {
- output += " notInherited";
- }
-
- !}">
- <td class="micon"><a class="exi" href="#expand"> </a></td>
-
- <td class="sig">
- <a id="{+member.memberOf+}-event-{+member.name+}"></a>
-
- <div class="fixedFont">
- <b class="itemname">{+member.name.substring(1)+}</b> {+makeSignature(member.params)+}
-
- </div>
-
- <div class="mdesc">
-
- <div class="short">{+resolveLinks(summarize(member.desc))+}
-
- </div>
-
- <div class="long">
-
- {+resolveLinks(member.desc)+}
-
- <if test="member.example">
- <pre class="code">{+member.example+}</pre>
- </if>
-
-
- <if test="member.params.length">
- <dl class="detailList">
- <dt class="heading">Parameters:</dt>
- <for each="item" in="member.params">
- <dt>
- {+((item.type)?"<span class=\"fixedFont\">"+(new Link().toSymbol(item.type))+"</span> " : "")+}<b>{+item.name+}</b>
- <if test="item.isOptional"><i>Optional
- <if test="item.defaultValue">,
- Default: {+item.defaultValue+}
- </if></i></if>
- </dt>
- <dd>{+resolveLinks(item.desc)+}</dd>
- </for>
- </dl>
- </if>
- <if test="member.deprecated">
- <dl class="detailList">
- <dt class="heading">Deprecated:</dt>
- <dt>
- {+member.deprecated+}
- </dt>
- </dl>
- </if>
- <if test="member.since.length">
- <dl class="detailList">
- <dt class="heading">Since:</dt>
- <dd>{+ member.since +}</dd>
- </dl>
- </dl>
- </if>
- <if test="member.exceptions.length">
- <dl class="detailList">
- <dt class="heading">Throws:</dt>
- <for each="item" in="member.exceptions">
- <dt>
- {+((item.type)?"<span class=\"light fixedFont\">{"+(new Link().toSymbol(item.type))+"}</span> " : "")+} <b>{+item.name+}</b>
- </dt>
- <dd>{+resolveLinks(item.desc)+}</dd>
- </for>
- </dl>
- </if>
- <if test="member.returns.length">
- <dl class="detailList">
- <dt class="heading">Returns:</dt>
- <for each="item" in="member.returns">
- <dd>{+((item.type)?"<span class=\"light fixedFont\">{"+(new Link().toSymbol(item.type))+"}</span> " : "")+}{+resolveLinks(item.desc)+}</dd>
- </for>
- </dl>
- </if>
- <if test="member.requires.length">
- <dl class="detailList">
- <dt class="heading">Requires:</dt>
- <for each="item" in="member.requires">
- <dd>{+ resolveLinks(item) +}</dd>
- </for>
- </dl>
- </if>
- <if test="member.see.length">
- <dl class="detailList">
- <dt class="heading">See:</dt>
- <for each="item" in="member.see">
- <dd>{+ new Link().toSymbol(item) +}</dd>
- </for>
- </dl>
- </if>
-
-
-
-
- </div>
- </div>
-
- </td>
- <td class="msource">
- {+ (member.memberOf == data.alias) ? member.memberOf : new Link().toSymbol(member.memberOf) +}
- </td>
- </tr>
- </for>
-
- </table>
-</if>
-
-
-
-
-<!-- ============================== footer ================================= -->
- <div class="fineprint" style="clear:both">
- <if test="Options.copyright">©{+Options.copyright+}<br /></if>
- Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a> on {+new Date()+}
- Based on
- <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>
- </div>
- </body>
-</html>
projects / roojs1 / blobdiff