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={+Options.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 #}
99 url : './src/' + Link.srcFileFlatName(data.srcFile),
100 text : Link.srcFileRelName(data.srcFile)
104 <tr><td class="label">Class:</td><td class="hd-info">{+cls+}</td></tr>
106 <if test="data.childClasses.length">
107 <tr><td class="label">Subclasses:</td><td class="hd-info">
112 function($) { return new Link().toSymbol($); }
121 <if test="data.augments.length">
123 <tr><td class="label">Extends:</td><td class="hd-info">
125 new Link().toSymbol(data.augments[data.augments.length -1])
135 <!-- ============================== class summary ========================== -->
136 <div class="description">
137 {+resolveLinks(data.desc)+}
141 <!-- ============================== Class comment block... ========================== -->
143 <div class="comments">
144 <b>Class Comments / Notes</B> =>
145 <u onclick="parent.CommentDialog.showCommentId = '{+data.alias+}';">[Add Your comment/notes about this class]</u>
147 <iframe frameborder="0" id="comments-{+data.memberOf+}" style="border: none;width:100%;"
148 src="/blog.php/GtkDjsComments/{+data.alias+}.html"></iframe>
153 <!-- ============================== config options ========================== -->
160 var cfgProperties = [];
161 if (!data.comment.getTag('singleton').length) {
162 cfgProperties = data.configToArray();
163 cfgProperties = cfgProperties.sort(makeSortby("name"));
171 <div class="hr"></div>
172 <a id="{+data.alias+}-configs"></a>
174 <if test="!cfgProperties.length">
176 <table cellspacing="0" class="member-table">
177 <caption class="Empty">Config Options - Has None</caption>
182 <if test="cfgProperties.length">
184 <table cellspacing="0" class="member-table">
185 <caption>Config Options (Usually are also Properties)</caption>
189 <th class="sig-header" colspan="2">Options</th>
191 <th class="msource-header">Defined By</th>
196 <for each="dtag" in="cfgProperties">
198 <tr class="config-row expandable config-row-alt{+$dtag_i % 2+}{+ ((dtag.memberOf == data.alias) ? " notInherited" : "") +}">
199 <td class="micon"><a class="exi" href="#expand"> </a></td>
202 <a id="{+dtag.memberOf+}-cfg-{+dtag.name+}" name=".{+dtag.name+}"></a>
203 <div class="fixedFont">
204 <b class="itemname">{+dtag.name+}</b> : {+((dtag.type) ? (new Link().toSymbol(dtag.type)) : "" )+}
210 <div class="short">{+resolveLinks(summarize(dtag.desc))+}</div>
215 {+resolveLinks(dtag.desc)+}
216 {+dtag.optvalues ? ("<BR/>Possible Values: " + dtag.optvalues.map(function(v) { return v.length ? v : "<B>Empty</B>"; }).join(", ")) : '' +}
224 {# - fixme - add inheritied as link here #}
225 {+ (dtag.memberOf == data.alias) ? dtag.memberOf : new Link().toSymbol(dtag.memberOf) +}
241 <!-- ============================== public properties ==================== -->
245 <a id="{+data.alias+}-props"></a>
248 var ownProperties = [];
249 var psorted = data.properties.sort(makeSortby("name"));
253 if (/$.hide/.test($.desc)) {
256 if ( !$.isNamespace || (($.memberOf != data.alias) && $.isStatic)) {
257 if ($.isStatic) ownProperties.push($);
266 <if test="!ownProperties.length">
268 <table cellspacing="0" class="member-table">
269 <caption class="Empty">Public Properties - Has None</caption>
274 <if test="ownProperties.length">
276 <table cellspacing="0" class="member-table">
277 <caption>Public Properties </caption>
279 <th class="sig-header" colspan="2">Property</th>
280 <th class="sig-header">Description</th>
281 <th class="msource-header">Defined By</th>
287 <for each="member" in="ownProperties">
291 <tr class="property-row config-row-alt{+$member_i % 2+}{!
293 if (member.memberOf == data.alias) {
294 output += " notInherited";
299 <a class="exi" href="#expand"> </a>
302 <a id="{+member.memberOf+}-prop-{+member.name+}" name=".{+member.name+}"></a>
303 <div class="fixedFont">
304 <span class="attributes">{!
305 if (member.isPrivate) output += "<private> ";
306 if (member.isInner) output += "<inner> ";
308 if (member.isConstant) output += "<constant> ";
309 if (member.isStatic) output += ""+data.alias +".";
310 !}</span><b class="itemname">{+member.name+}</b> :
311 <span type="etype">{+((member.type) ? (new Link().toSymbol(member.type)) : "" )+}</span>
319 {+resolveLinks(summarize(member.desc))+}
327 {+resolveLinks(member.desc)+}
334 {+ (member.memberOf == data.alias) ? member.memberOf : new Link().toSymbol(member.memberOf) +}
343 <!-- TODO: implement this alt row. also notice non-linked "Defined by" when property is a part of this class.
344 <tr class="property-row alt">
351 <!-- ============================== methods summary / details ======================== -->
354 <a id="{+data.alias+}-methods"></a>
355 <!-- constructor?? -->
359 if (data.comment.getTag('class').length &&
361 !data.comment.getTag('singleton').length &&
362 !data.comment.getTag('static').length
364 data.isInherited = false;
365 ownMethods.push(data);
368 var msorted = data.methods.sort(makeSortby("name"));
378 if (/@hide/.test($.desc)) {
382 if (!$.isEvent && (data.comment.getTag("instanceOf").length || data.comment.getTag("singleton").length)) {
383 if ($.isStatic && (data.comment.getTag("instanceOf").length || data.comment.getTag("singleton").length) &&
384 ($.memberOf != data.alias)) {
387 $.isInherited = ($.memberOf != data.alias);
393 if ($.isNamespace || $.isEvent || (($.memberOf != data.alias) && $.isStatic)){
397 $.isInherited = ($.memberOf != data.alias);
405 <!-- then dynamics first -->
409 if (/@hide/.test($.desc)) {
412 if (data.comment.getTag("instanceOf").length || data.comment.getTag("singleton").length) {
415 if ($.isNamespace || $.isEvent || (($.memberOf != data.alias) && $.isStatic)){
420 $.isInherited = ($.memberOf != data.alias);
431 <if test="!ownMethods.length">
433 <table cellspacing="0" class="member-table">
434 <caption class="Empty">Public Methods - Has None</caption>
438 <if test="ownMethods.length">
440 <table cellspacing="0" class="member-table">
441 <caption>Public Methods</caption>
443 <th class="sig-header" colspan="2">Method</th>
444 <th class="msource-header">Defined By</th>
452 <for each="member" in="ownMethods">
454 <tr class="method-row config-row-alt{+$member_i % 2+}{!
455 if (member.is("CONSTRUCTOR") && !member.params.length) {
458 output += ' expandable';
462 if (!member.isInherited) {
463 output += " notInherited";
467 <td class="micon"><a class="exi" href="#expand"> </a></td>
471 <a id="{+member.memberOf+}-method-{+member.name+}" name=".{+member.name+}"></a>
472 <div class="fixedFont">
473 <span class="attributes">{!
474 if (member.is('CONSTRUCTOR')) {
475 output += "new <B>" + member.memberOf + (member.memberOf.length ? "." : "") +"</B>";
479 if (member.isPrivate) output += "<private> ";
480 if (member.isInner) output += "<inner> ";
481 if (member.isStatic || data.comment.getTag("singleton").length || data.comment.getTag("instanceOf").length) {
482 output += data.alias + ".";
485 !}</span><b class="itemname">{+member.name+}</b>
487 {+makeSignature(member.params)+}
489 <if test="member.returns.length">
491 <for each="item" in="member.returns">
492 <if test="$item_i > 0"> or </if>
493 {+((item.type) ? (new Link().toSymbol(item.type)) : "" )+}
501 <if test="!member.is('CONSTRUCTOR')">
502 <div class="short">{+resolveLinks(summarize(member.desc))+}</div>
504 <if test="member.is('CONSTRUCTOR')">
505 <div class="short">Create a new {+data.alias +}</div>
509 <if test="!member.is('CONSTRUCTOR')">
510 {+resolveLinks(member.desc)+}
512 <if test="member.example">
513 <pre class="code">{+member.example+}</pre>
517 <if test="member.is('CONSTRUCTOR')">
518 Create a new {+data.alias +}
520 <if test="member.params.length">
521 <dl class="detailList">
522 <dt class="heading">Parameters:</dt>
523 <for each="item" in="member.params">
525 {+((item.type)?"<span class=\"fixedFont\">"+(new Link().toSymbol(item.type))+"</span> " : "")+} <b>{+item.name+}</b>
526 <if test="item.isOptional"><i>Optional
527 <if test="item.defaultValue">,
528 Default: {+item.defaultValue+}
531 <dd>{+resolveLinks(item.desc)+}</dd>
535 <if test="member.deprecated">
536 <dl class="detailList">
537 <dt class="heading">Deprecated:</dt>
539 {+member.deprecated+}
543 <if test="member.since.length">
544 <dl class="detailList">
545 <dt class="heading">Since:</dt>
546 <dd>{+ member.since +}</dd>
550 <if test="member.exceptions.length">
551 <dl class="detailList">
552 <dt class="heading">Throws:</dt>
553 <for each="item" in="member.exceptions">
555 {+((item.type)?"<span class=\"fixedFont\">{"+(new Link().toSymbol(item.type))+"}</span> " : "")+} <b>{+item.name+}</b>
557 <dd>{+resolveLinks(item.desc)+}</dd>
561 <if test="member.returns.length">
562 <dl class="detailList">
563 <dt class="heading">Returns:</dt>
564 <for each="item" in="member.returns">
565 <dd>{+((item.type)?"<span class=\"fixedFont\">"+(new Link().toSymbol(item.type))+"</span> " : "")+} {+resolveLinks(item.desc)+}</dd>
569 <if test="member.requires.length">
570 <dl class="detailList">
571 <dt class="heading">Requires:</dt>
572 <for each="item" in="member.requires">
573 <dd>{+ resolveLinks(item) +}</dd>
577 <if test="member.see.length">
578 <dl class="detailList">
579 <dt class="heading">See:</dt>
580 <for each="item" in="member.see">
581 <dd>{+ new Link().toSymbol(item) +}</dd>
594 <if test="!member.is('CONSTRUCTOR')">
595 {+ (member.memberOf == data.alias) ? member.memberOf : new Link().toSymbol(member.memberOf) +}
604 <!-- ============================== events summary / details ======================== -->
607 <a id="{+data.alias+}-events"></a>
613 var ownEvents = data.methods.filter(
616 return $.isEvent && !$.comment.getTag('hide').length;
619 ).sort(makeSortby("name"));
622 <if test="!ownEvents.length">
624 <table cellspacing="0" class="member-table">
625 <caption class="Empty">Events - Has None</caption>
631 <if test="ownEvents.length">
633 <table cellspacing="0" class="member-table">
634 <caption>Events</caption>
637 <th class="sig-header" colspan="2">Event</th>
638 <th class="msource-header">Defined By</th>
646 <for each="member" in="ownEvents">
647 <tr class="method-row expandable config-row-alt{+$member_i % 2+}{!
649 if (member.memberOf == data.alias) {
650 output += " notInherited";
654 <td class="micon"><a class="exi" href="#expand"> </a></td>
657 <a id="{+member.memberOf+}-event-{+member.name+}"></a>
659 <div class="fixedFont">
660 <b class="itemname">{+member.name.substring(1)+}</b> {+makeSignature(member.params)+}
666 <div class="short">{+resolveLinks(summarize(member.desc))+}
672 {+resolveLinks(member.desc)+}
674 <if test="member.example">
675 <pre class="code">{+member.example+}</pre>
679 <if test="member.params.length">
680 <dl class="detailList">
681 <dt class="heading">Parameters:</dt>
682 <for each="item" in="member.params">
684 {+((item.type)?"<span class=\"fixedFont\">"+(new Link().toSymbol(item.type))+"</span> " : "")+}<b>{+item.name+}</b>
685 <if test="item.isOptional"><i>Optional
686 <if test="item.defaultValue">,
687 Default: {+item.defaultValue+}
690 <dd>{+resolveLinks(item.desc)+}</dd>
694 <if test="member.deprecated">
695 <dl class="detailList">
696 <dt class="heading">Deprecated:</dt>
698 {+member.deprecated+}
702 <if test="member.since.length">
703 <dl class="detailList">
704 <dt class="heading">Since:</dt>
705 <dd>{+ member.since +}</dd>
709 <if test="member.exceptions.length">
710 <dl class="detailList">
711 <dt class="heading">Throws:</dt>
712 <for each="item" in="member.exceptions">
714 {+((item.type)?"<span class=\"light fixedFont\">{"+(new Link().toSymbol(item.type))+"}</span> " : "")+} <b>{+item.name+}</b>
716 <dd>{+resolveLinks(item.desc)+}</dd>
720 <if test="member.returns.length">
721 <dl class="detailList">
722 <dt class="heading">Returns:</dt>
723 <for each="item" in="member.returns">
724 <dd>{+((item.type)?"<span class=\"light fixedFont\">{"+(new Link().toSymbol(item.type))+"}</span> " : "")+}{+resolveLinks(item.desc)+}</dd>
728 <if test="member.requires.length">
729 <dl class="detailList">
730 <dt class="heading">Requires:</dt>
731 <for each="item" in="member.requires">
732 <dd>{+ resolveLinks(item) +}</dd>
736 <if test="member.see.length">
737 <dl class="detailList">
738 <dt class="heading">See:</dt>
739 <for each="item" in="member.see">
740 <dd>{+ new Link().toSymbol(item) +}</dd>
753 {+ (member.memberOf == data.alias) ? member.memberOf : new Link().toSymbol(member.memberOf) +}
764 <!-- ============================== footer ================================= -->
765 <div class="fineprint" style="clear:both">
766 <if test="Options.copyright">©{+Options.copyright+}<br /></if>
767 Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a> on {+new Date()+}
769 <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>