1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
4 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
7 <meta http-equiv="content-type" content="text/html; charset={+IO.encoding+}" />
8 <meta name="generator" content="JsDoc Toolkit" />
9 {! Link.base = "../"; /* all generated links will be relative to this */ !}
11 <title>JsDoc Reference - {+data.alias+}</title>
14 <link rel="stylesheet" type="text/css" href="../../css/roojs.css" />
15 <link rel="stylesheet" type="text/css" href="../default.css" />
18 <script type="text/javascript" src="../page.js">
25 <body onload="RooDocsPage.onload();">
28 <div class="body-wrap">
30 <!-- ============================== links to methods. ================================= -->
32 <div class="top-tools">
34 <a class="inner-link" href="#{+data.alias+}-props"><img src="resources/s.gif" class="item-icon icon-prop">Properties</a>
35 <a class="inner-link" href="#{+data.alias+}-methods"><img src="resources/s.gif" class="item-icon icon-method">Methods</a>
36 <a class="inner-link" href="#{+data.alias+}-events"><img src="resources/s.gif" class="item-icon icon-event">Events</a>
37 <a class="inner-link" href="#{+data.alias+}-configs"><img src="resources/s.gif" class="item-icon icon-config">Config Options</a>
38 <a class="bookmark" href="NEED_TO_CREATE_DIRECT_LINK_HREF"><img src="resources/s.gif" class="item-icon icon-fav">Direct Link</a>
43 <!-- ============================== inheritance Block. ================================= -->
44 <if test="data.augments.length">
45 <div class="inheritance res-block">
46 <pre class="res-block-inner">{!
47 var iblock_indent = 0;
48 data.augments.reverse().map(
50 output += iblock_indent ? ('<img src="../../images/default/s.gif" height="1" width="' +
51 iblock_indent + '"/><img src="../../images/default/tree/elbow-end.gif" class="elbow"/>') : '';
52 output += new Link().toSymbol($) + "\n";
56 !}<img src="../../images/default/s.gif" height="1" width="{+ iblock_indent +}"/><img class="elbow" src="../../images/default/tree/elbow-end.gif"/>{+data.alias+}
61 <!-- ============================== class title / details ============================ -->
64 var fullpath = data.alias.split('.');
65 var cls = fullpath.pop();
66 var packge = fullpath.join(".");
71 <h1 class="classTitle">
75 if (data.isBuiltin()) {
76 classType += "Built-In ";
79 if (data.isNamespace) {
80 if (data.is('FUNCTION')) {
81 classType += "Function ";
83 classType += "Namespace ";
86 classType += "Class ";
89 {+classType+}{+data.alias+}
92 <table cellspacing="0" class="class-summary-table">
93 <if test="packge.length">
94 <tr><td class="label">Package:</td><td class="hd-info">{+packge+}</td></tr>
96 <tr><td class="label">Defined In:</td><td class="hd-info">
97 <if test="data.srcFile.length">{# isn't defined in any file #}
98 {+new Link().toSrc(data.srcFile)+}.
101 <tr><td class="label">Class:</td><td class="hd-info">{+cls+}</td></tr>
103 <if test="data.childClasses.length">
104 <tr><td class="label">Subclasses:</td><td class="hd-info">
109 function($) { return new Link().toSymbol($); }
118 <if test="data.augments.length">
120 <tr><td class="label">Extends:</td><td class="hd-info">
122 new Link().toSymbol(data.augments[data.augments.length -1])
132 <!-- ============================== class summary ========================== -->
133 <div class="description">
134 {+resolveLinks(data.desc)+}
138 <!-- ============================== Class comment block... ========================== -->
140 <div class="comments">
141 <b>Class Comments / Notes</B> =>
142 <u onclick="parent.CommentDialog.showCommentId = '{+data.alias+}';">[Add Your comment/notes about this class]</u>
144 <iframe frameborder="0" id="comments-{+data.memberOf+}" style="border: none;width:100%;"
145 src="/blog.php/GtkDjsComments/{+data.alias+}.html"></iframe>
150 <!-- ============================== config options ========================== -->
157 var cfgProperties = [];
158 if (!data.comment.getTag('singleton').length) {
159 cfgProperties = data.configToArray();
160 cfgProperties = cfgProperties.sort(makeSortby("name"));
168 <div class="hr"></div>
169 <a id="{+data.alias+}-configs"></a>
171 <if test="!cfgProperties.length">
173 <table cellspacing="0" class="member-table">
174 <caption class="Empty">Config Options - Has None</caption>
179 <if test="cfgProperties.length">
181 <table cellspacing="0" class="member-table">
182 <caption>Config Options (Usually are also Properties)</caption>
186 <th class="sig-header" colspan="2">Options</th>
188 <th class="msource-header">Defined By</th>
193 <for each="dtag" in="cfgProperties">
195 <tr class="config-row expandable config-row-alt{+$dtag_i % 2+}{+ ((dtag.memberOf == data.alias) ? " notInherited" : "") +}">
196 <td class="micon"><a class="exi" href="#expand"> </a></td>
199 <a id="{+dtag.memberOf+}-cfg-{+dtag.name+}" name=".{+dtag.name+}"></a>
200 <div class="fixedFont">
201 <b class="itemname">{+dtag.name+}</b> : {+((dtag.type) ? (new Link().toSymbol(dtag.type)) : "" )+}
207 <div class="short">{+resolveLinks(summarize(dtag.desc))+}</div>
211 <div class="long">{+resolveLinks(dtag.desc)+}</div>
218 {# - fixme - add inheritied as link here #}
219 {+ (dtag.memberOf == data.alias) ? dtag.memberOf : new Link().toSymbol(dtag.memberOf) +}
235 <!-- ============================== public properties ==================== -->
239 <a id="{+data.alias+}-props"></a>
242 var ownProperties = [];
243 var psorted = data.properties.sort(makeSortby("name"));
247 if (/$.hide/.test($.desc)) {
250 if ( !$.isNamespace || (($.memberOf != data.alias) && $.isStatic)) {
251 if ($.isStatic) ownProperties.push($);
260 <if test="!ownProperties.length">
262 <table cellspacing="0" class="member-table">
263 <caption class="Empty">Public Properties - Has None</caption>
268 <if test="ownProperties.length">
270 <table cellspacing="0" class="member-table">
271 <caption>Public Properties </caption>
273 <th class="sig-header" colspan="2">Property</th>
274 <th class="sig-header">Description</th>
275 <th class="msource-header">Defined By</th>
281 <for each="member" in="ownProperties">
285 <tr class="property-row config-row-alt{+$member_i % 2+}{!
287 if (member.memberOf == data.alias) {
288 output += " notInherited";
293 <a class="exi" href="#expand"> </a>
296 <a id="{+member.memberOf+}-prop-{+member.name+}" name=".{+member.name+}"></a>
297 <div class="fixedFont">
298 <span class="attributes">{!
299 if (member.isPrivate) output += "<private> ";
300 if (member.isInner) output += "<inner> ";
302 if (member.isConstant) output += "<constant> ";
303 if (member.isStatic) output += ""+data.alias +".";
304 !}</span><b class="itemname">{+member.name+}</b> :
305 <span type="etype">{+((member.type) ? (new Link().toSymbol(member.type)) : "" )+}</span>
313 {+resolveLinks(summarize(member.desc))+}
321 {+resolveLinks(member.desc)+}
328 {+ (member.memberOf == data.alias) ? member.memberOf : new Link().toSymbol(member.memberOf) +}
337 <!-- TODO: implement this alt row. also notice non-linked "Defined by" when property is a part of this class.
338 <tr class="property-row alt">
345 <!-- ============================== methods summary / details ======================== -->
348 <a id="{+data.alias+}-methods"></a>
349 <!-- constructor?? -->
353 if (data.comment.getTag('class').length &&
355 !data.comment.getTag('singleton').length &&
356 !data.comment.getTag('static').length
358 data.isInherited = false;
359 ownMethods.push(data);
362 var msorted = data.methods.sort(makeSortby("name"));
372 if (/@hide/.test($.desc)) {
376 if (!$.isEvent && (data.comment.getTag("instanceOf").length || data.comment.getTag("singleton").length)) {
377 if ($.isStatic && (data.comment.getTag("instanceOf").length || data.comment.getTag("singleton").length) &&
378 ($.memberOf != data.alias)) {
381 $.isInherited = ($.memberOf != data.alias);
387 if ($.isNamespace || $.isEvent || (($.memberOf != data.alias) && $.isStatic)){
391 $.isInherited = ($.memberOf != data.alias);
399 <!-- then dynamics first -->
403 if (/@hide/.test($.desc)) {
406 if (data.comment.getTag("instanceOf").length || data.comment.getTag("singleton").length) {
409 if ($.isNamespace || $.isEvent || (($.memberOf != data.alias) && $.isStatic)){
414 $.isInherited = ($.memberOf != data.alias);
425 <if test="!ownMethods.length">
427 <table cellspacing="0" class="member-table">
428 <caption class="Empty">Public Methods - Has None</caption>
432 <if test="ownMethods.length">
434 <table cellspacing="0" class="member-table">
435 <caption>Public Methods</caption>
437 <th class="sig-header" colspan="2">Method</th>
438 <th class="msource-header">Defined By</th>
446 <for each="member" in="ownMethods">
448 <tr class="method-row config-row-alt{+$member_i % 2+}{!
449 if (member.is("CONSTRUCTOR") && !member.params.length) {
452 output += ' expandable';
456 if (!member.isInherited) {
457 output += " notInherited";
461 <td class="micon"><a class="exi" href="#expand"> </a></td>
465 <a id="{+member.memberOf+}-method-{+member.name+}" name=".{+member.name+}"></a>
466 <div class="fixedFont">
467 <span class="attributes">{!
468 if (member.is('CONSTRUCTOR')) {
469 output += "new <B>" + member.memberOf + (member.memberOf.length ? "." : "") +"</B>";
473 if (member.isPrivate) output += "<private> ";
474 if (member.isInner) output += "<inner> ";
475 if (member.isStatic || data.comment.getTag("singleton").length || data.comment.getTag("instanceOf").length) {
476 output += data.alias + ".";
479 !}</span><b class="itemname">{+member.name+}</b>
481 {+makeSignature(member.params)+}
483 <if test="member.returns.length">
485 <for each="item" in="member.returns">
486 <if test="$item_i > 0"> or </if>
487 {+((item.type) ? (new Link().toSymbol(item.type)) : "" )+}
495 <if test="!member.is('CONSTRUCTOR')">
496 <div class="short">{+resolveLinks(summarize(member.desc))+}</div>
498 <if test="member.is('CONSTRUCTOR')">
499 <div class="short">Create a new {+data.alias +}</div>
503 <if test="!member.is('CONSTRUCTOR')">
504 {+resolveLinks(member.desc)+}
506 <if test="member.example">
507 <pre class="code">{+member.example+}</pre>
511 <if test="member.is('CONSTRUCTOR')">
512 Create a new {+data.alias +}
514 <if test="member.params.length">
515 <dl class="detailList">
516 <dt class="heading">Parameters:</dt>
517 <for each="item" in="member.params">
519 {+((item.type)?"<span class=\"fixedFont\">"+(new Link().toSymbol(item.type))+"</span> " : "")+} <b>{+item.name+}</b>
520 <if test="item.isOptional"><i>Optional
521 <if test="item.defaultValue">,
522 Default: {+item.defaultValue+}
525 <dd>{+resolveLinks(item.desc)+}</dd>
529 <if test="member.deprecated">
530 <dl class="detailList">
531 <dt class="heading">Deprecated:</dt>
533 {+member.deprecated+}
537 <if test="member.since.length">
538 <dl class="detailList">
539 <dt class="heading">Since:</dt>
540 <dd>{+ member.since +}</dd>
544 <if test="member.exceptions.length">
545 <dl class="detailList">
546 <dt class="heading">Throws:</dt>
547 <for each="item" in="member.exceptions">
549 {+((item.type)?"<span class=\"fixedFont\">{"+(new Link().toSymbol(item.type))+"}</span> " : "")+} <b>{+item.name+}</b>
551 <dd>{+resolveLinks(item.desc)+}</dd>
555 <if test="member.returns.length">
556 <dl class="detailList">
557 <dt class="heading">Returns:</dt>
558 <for each="item" in="member.returns">
559 <dd>{+((item.type)?"<span class=\"fixedFont\">"+(new Link().toSymbol(item.type))+"</span> " : "")+} {+resolveLinks(item.desc)+}</dd>
563 <if test="member.requires.length">
564 <dl class="detailList">
565 <dt class="heading">Requires:</dt>
566 <for each="item" in="member.requires">
567 <dd>{+ resolveLinks(item) +}</dd>
571 <if test="member.see.length">
572 <dl class="detailList">
573 <dt class="heading">See:</dt>
574 <for each="item" in="member.see">
575 <dd>{+ new Link().toSymbol(item) +}</dd>
588 <if test="!member.is('CONSTRUCTOR')">
589 {+ (member.memberOf == data.alias) ? member.memberOf : new Link().toSymbol(member.memberOf) +}
598 <!-- ============================== events summary / details ======================== -->
601 <a id="{+data.alias+}-events"></a>
607 var ownEvents = data.methods.filter(
610 return $.isEvent && !$.comment.getTag('hide').length;
613 ).sort(makeSortby("name"));
616 <if test="!ownEvents.length">
618 <table cellspacing="0" class="member-table">
619 <caption class="Empty">Events - Has None</caption>
625 <if test="ownEvents.length">
627 <table cellspacing="0" class="member-table">
628 <caption>Events</caption>
631 <th class="sig-header" colspan="2">Event</th>
632 <th class="msource-header">Defined By</th>
640 <for each="member" in="ownEvents">
641 <tr class="method-row expandable config-row-alt{+$member_i % 2+}{!
643 if (member.memberOf == data.alias) {
644 output += " notInherited";
648 <td class="micon"><a class="exi" href="#expand"> </a></td>
651 <a id="{+member.memberOf+}-event-{+member.name+}"></a>
653 <div class="fixedFont">
654 <b class="itemname">{+member.name.substring(1)+}</b> {+makeSignature(member.params)+}
660 <div class="short">{+resolveLinks(summarize(member.desc))+}
666 {+resolveLinks(member.desc)+}
668 <if test="member.example">
669 <pre class="code">{+member.example+}</pre>
673 <if test="member.params.length">
674 <dl class="detailList">
675 <dt class="heading">Parameters:</dt>
676 <for each="item" in="member.params">
678 {+((item.type)?"<span class=\"fixedFont\">"+(new Link().toSymbol(item.type))+"</span> " : "")+}<b>{+item.name+}</b>
679 <if test="item.isOptional"><i>Optional
680 <if test="item.defaultValue">,
681 Default: {+item.defaultValue+}
684 <dd>{+resolveLinks(item.desc)+}</dd>
688 <if test="member.deprecated">
689 <dl class="detailList">
690 <dt class="heading">Deprecated:</dt>
692 {+member.deprecated+}
696 <if test="member.since.length">
697 <dl class="detailList">
698 <dt class="heading">Since:</dt>
699 <dd>{+ member.since +}</dd>
703 <if test="member.exceptions.length">
704 <dl class="detailList">
705 <dt class="heading">Throws:</dt>
706 <for each="item" in="member.exceptions">
708 {+((item.type)?"<span class=\"light fixedFont\">{"+(new Link().toSymbol(item.type))+"}</span> " : "")+} <b>{+item.name+}</b>
710 <dd>{+resolveLinks(item.desc)+}</dd>
714 <if test="member.returns.length">
715 <dl class="detailList">
716 <dt class="heading">Returns:</dt>
717 <for each="item" in="member.returns">
718 <dd>{+((item.type)?"<span class=\"light fixedFont\">{"+(new Link().toSymbol(item.type))+"}</span> " : "")+}{+resolveLinks(item.desc)+}</dd>
722 <if test="member.requires.length">
723 <dl class="detailList">
724 <dt class="heading">Requires:</dt>
725 <for each="item" in="member.requires">
726 <dd>{+ resolveLinks(item) +}</dd>
730 <if test="member.see.length">
731 <dl class="detailList">
732 <dt class="heading">See:</dt>
733 <for each="item" in="member.see">
734 <dd>{+ new Link().toSymbol(item) +}</dd>
747 {+ (member.memberOf == data.alias) ? member.memberOf : new Link().toSymbol(member.memberOf) +}
758 <!-- ============================== footer ================================= -->
759 <div class="fineprint" style="clear:both">
760 <if test="JSDOC.opt.D['copyright']">©{+JSDOC.opt.D.copyright+}<br /></if>
761 Documentation generated by <a href="http://www.akbkhome.com/rooscript">RooScript/Jstoolkit</a>
763 <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a> on {+new Date()+}