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="http://roojs.com/roojs1/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),
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])
132 <!-- stuff usefull for debuggin -->
133 <tr><td class="label">[isa]:</td><td class="hd-info"> {+ data.isa +}
134 <tr><td class="label">[namespace]:</td><td class="hd-info"> {+ data.namespace +}
143 <!-- ============================== class summary ========================== -->
144 <div class="description">
145 {+resolveLinks(data.desc)+}
149 <!-- ============================== Class comment block... ========================== -->
151 <div class="comments">
152 <b>Class Comments / Notes</B> =>
153 <u onclick="parent.CommentDialog.showCommentId = '{+data.alias+}';">[Add Your comment/notes about this class]</u>
155 <iframe frameborder="0" id="comments-{+data.memberOf+}" style="border: none;width:100%;"
156 src="/blog.php/GtkDjsComments/{+data.alias+}.html"></iframe>
161 <!-- ============================== config options ========================== -->
168 var cfgProperties = [];
169 if (!data.comment.getTag('singleton').length) {
170 cfgProperties = data.configToArray();
171 cfgProperties = cfgProperties.sort(makeSortby("name"));
179 <div class="hr"></div>
180 <a id="{+data.alias+}-configs"></a>
182 <if test="!cfgProperties.length">
184 <table cellspacing="0" class="member-table">
185 <caption class="Empty">Config Options - Has None</caption>
190 <if test="cfgProperties.length">
192 <table cellspacing="0" class="member-table">
193 <caption>Config Options (Usually are also Properties)</caption>
197 <th class="sig-header" colspan="2">Options</th>
199 <th class="msource-header">Defined By</th>
204 <for each="dtag" in="cfgProperties">
206 <tr class="config-row expandable config-row-alt{+$dtag_i % 2+}{+ ((dtag.memberOf == data.alias) ? " not-inherited" : "") +}">
207 <td class="micon"><a class="exi" href="#expand"> </a></td>
210 <a id="{+dtag.memberOf+}-cfg-{+dtag.name+}" name=".{+dtag.name+}"></a>
211 <div class="fixedFont">
212 <b class="itemname">{+dtag.name+}</b> : {+((dtag.type) ? (new Link().toSymbol(dtag.type)) : "" )+}
218 <div class="short">{+resolveLinks(summarize(dtag.desc))+}</div>
222 <div class="long">{+resolveLinks(dtag.desc)+}</div>
229 {# - fixme - add inheritied as link here #}
230 {+ (dtag.memberOf == data.alias) ? dtag.memberOf : new Link().toSymbol(dtag.memberOf) +}
246 <!-- ============================== public properties ==================== -->
250 <a id="{+data.alias+}-props"></a>
253 var ownProperties = [];
254 var psorted = data.properties.sort(makeSortby("isStatic", "name"));
258 if (/$.hide/.test($.desc)) {
262 /* if ( !$.isNamespace || (($.memberOf != data.alias) && $.isStatic)) {
263 if ($.isStatic) ownProperties.push($);
265 /* config should not be listed in properties */
266 if (typeof(data.cfgs[$.name]) != 'undefined') {
270 ownProperties.push($);
277 <if test="!ownProperties.length">
279 <table cellspacing="0" class="member-table">
280 <caption class="Empty">Public Properties - Has None</caption>
285 <if test="ownProperties.length">
287 <table cellspacing="0" class="member-table">
288 <caption>Public Properties </caption>
290 <th class="sig-header" colspan="2">Property</th>
291 <th class="sig-header">Description</th>
292 <th class="msource-header">Defined By</th>
298 <for each="member" in="ownProperties">
302 <tr class="property-row config-row-alt{+$member_i % 2+}{!
304 if (member.memberOf == data.alias) {
305 output += " not-inherited";
307 if (member.isPrivate) {
308 output += " is-private";
312 <a class="exi" href="#expand"> </a>
315 <a id="{+member.memberOf+}-prop-{+member.name+}" name=".{+member.name+}"></a>
316 <div class="fixedFont">
317 <span class="attributes">{!
318 if (member.isPrivate) output += "<private> ";
319 if (member.isInner) output += "<inner> ";
321 if (member.isConstant) output += "<constant> ";
322 if (member.isStatic) output += ""+data.alias +".";
323 !}</span><b class="itemname">{+member.name+}</b> :
324 <span type="etype">{+((member.type) ? (new Link().toSymbol(member.type)) : "" )+}</span>
334 {+resolveLinks(summarize(member.desc))+}
342 {+resolveLinks(member.desc)+}
349 {+ (member.memberOf == data.alias) ? member.memberOf : new Link().toSymbol(member.memberOf) +}
358 <!-- TODO: implement this alt row. also notice non-linked "Defined by" when property is a part of this class.
359 <tr class="property-row alt">
366 <!-- ============================== methods summary / details ======================== -->
369 <a id="{+data.alias+}-methods"></a>
370 <!-- constructor?? -->
374 if (data.comment.getTag('class').length &&
376 !data.comment.getTag('singleton').length &&
377 !data.comment.getTag('static').length
379 data.isInherited = false;
380 ownMethods.push(data);
383 var msorted = data.methods.sort(makeSortby("name"));
393 if (/@hide/.test($.desc)) {
397 if (!$.isEvent && (data.comment.getTag("instanceOf").length || data.comment.getTag("singleton").length)) {
398 if ($.isStatic && (data.comment.getTag("instanceOf").length || data.comment.getTag("singleton").length) &&
399 ($.memberOf != data.alias)) {
402 $.isInherited = ($.memberOf != data.alias);
408 if ($.isNamespace || $.isEvent || (($.memberOf != data.alias) && $.isStatic)){
412 $.isInherited = ($.memberOf != data.alias);
420 <!-- then dynamics first -->
424 if (/@hide/.test($.desc)) {
427 if (data.comment.getTag("instanceOf").length || data.comment.getTag("singleton").length) {
430 if ($.isNamespace || $.isEvent || (($.memberOf != data.alias) && $.isStatic)){
435 $.isInherited = ($.memberOf != data.alias);
446 <if test="!ownMethods.length">
448 <table cellspacing="0" class="member-table">
449 <caption class="Empty">Public Methods - Has None</caption>
453 <if test="ownMethods.length">
455 <table cellspacing="0" class="member-table">
456 <caption>Public Methods</caption>
458 <th class="sig-header" colspan="2">Method</th>
459 <th class="msource-header">Defined By</th>
467 <for each="member" in="ownMethods">
469 <tr class="method-row config-row-alt{+$member_i % 2+}{!
470 if (member.is("CONSTRUCTOR") && !member.params.length) {
473 output += ' expandable';
477 if (!member.isInherited) {
478 output += " not-inherited";
480 if (member.isPrivate) {
481 output += " is-private";
484 <td class="micon"><a class="exi" href="#expand"> </a></td>
488 <a id="{+member.memberOf+}-method-{+member.name+}" name=".{+member.name+}"></a>
489 <div class="fixedFont">
492 <span class="attributes">{!
494 var memberOf = member.memberOf;
495 if (data.ignoreNamespace) {
496 var ar = member.memberOf.split('.');
498 memberOf = ar.join('.');
502 if (member.is('CONSTRUCTOR')) {
503 output += "new <B>" + memberOf + (memberOf.length ? "." : "") +"</B>";
507 if (member.isPrivate) output += "<private> ";
508 if (member.isInner) output += "<inner> ";
509 if (member.isStatic || data.comment.getTag("singleton").length || data.comment.getTag("instanceOf").length) {
510 output += data.alias + ".";
513 !}</span><b class="itemname">{+member.name+}</b>
515 {+makeSignature(member.params)+}
517 <if test="member.returns.length">
519 <for each="item" in="member.returns">
520 <if test="$item_i > 0"> or </if>
521 {+((item.type) ? (new Link().toSymbol(item.type)) : "" )+}
529 <if test="!member.is('CONSTRUCTOR')">
530 <div class="short">{+resolveLinks(summarize(member.desc))+}</div>
532 <if test="member.is('CONSTRUCTOR')">
533 <div class="short">Create a new {+data.alias +}</div>
537 <if test="!member.is('CONSTRUCTOR')">
538 {+resolveLinks(member.desc)+}
540 <if test="member.example">
541 <pre class="code">{+member.example+}</pre>
545 <if test="member.is('CONSTRUCTOR')">
546 Create a new {+data.alias +}
548 <if test="member.params.length">
549 <dl class="detailList">
550 <dt class="heading">Parameters:</dt>
551 <for each="item" in="member.params">
553 {+((item.type)?"<span class=\"fixedFont\">"+(new Link().toSymbol(item.type))+"</span> " : "")+} <b>{+item.name+}</b>
554 <if test="item.isOptional"><i>Optional
555 <if test="item.defaultValue">,
556 Default: {+item.defaultValue+}
559 <dd>{+resolveLinks(item.desc)+}</dd>
563 <if test="member.deprecated">
564 <dl class="detailList">
565 <dt class="heading">Deprecated:</dt>
567 {+member.deprecated+}
571 <if test="member.since.length">
572 <dl class="detailList">
573 <dt class="heading">Since:</dt>
574 <dd>{+ member.since +}</dd>
578 <if test="member.exceptions.length">
579 <dl class="detailList">
580 <dt class="heading">Throws:</dt>
581 <for each="item" in="member.exceptions">
583 {+((item.type)?"<span class=\"fixedFont\">{"+(new Link().toSymbol(item.type))+"}</span> " : "")+} <b>{+item.name+}</b>
585 <dd>{+resolveLinks(item.desc)+}</dd>
589 <if test="member.returns.length">
590 <dl class="detailList">
591 <dt class="heading">Returns:</dt>
592 <for each="item" in="member.returns">
593 <dd>{+((item.type)?"<span class=\"fixedFont\">"+(new Link().toSymbol(item.type))+"</span> " : "")+} {+resolveLinks(item.desc)+}</dd>
597 <if test="member.requires.length">
598 <dl class="detailList">
599 <dt class="heading">Requires:</dt>
600 <for each="item" in="member.requires">
601 <dd>{+ resolveLinks(item) +}</dd>
605 <if test="member.see.length">
606 <dl class="detailList">
607 <dt class="heading">See:</dt>
608 <for each="item" in="member.see">
609 <dd>{+ new Link().toSymbol(item) +}</dd>
622 <if test="!member.is('CONSTRUCTOR')">
623 {+ (member.memberOf == data.alias) ? member.memberOf : new Link().toSymbol(member.memberOf) +}
632 <!-- ============================== events summary / details ======================== -->
635 <a id="{+data.alias+}-events"></a>
641 var ownEvents = data.methods.filter(
644 return $.isEvent && !$.comment.getTag('hide').length;
647 ).sort(makeSortby("name"));
650 <if test="!ownEvents.length">
652 <table cellspacing="0" class="member-table">
653 <caption class="Empty">Events - Has None</caption>
659 <if test="ownEvents.length">
661 <table cellspacing="0" class="member-table">
662 <caption>Events</caption>
665 <th class="sig-header" colspan="2">Event</th>
666 <th class="msource-header">Defined By</th>
674 <for each="member" in="ownEvents">
675 <tr class="method-row expandable config-row-alt{+$member_i % 2+}{!
677 if (member.memberOf == data.alias) {
678 output += " not-inherited";
682 <td class="micon"><a class="exi" href="#expand"> </a></td>
685 <a id="{+member.memberOf+}-event-{+member.name+}"></a>
687 <div class="fixedFont">
688 <b class="itemname">{+member.name.substring(1)+}</b> {+makeSignature(member.params)+}
694 <div class="short">{+resolveLinks(summarize(member.desc))+}
700 {+resolveLinks(member.desc)+}
702 <if test="member.example">
703 <pre class="code">{+member.example+}</pre>
707 <if test="member.params.length">
708 <dl class="detailList">
709 <dt class="heading">Parameters:</dt>
710 <for each="item" in="member.params">
712 {+((item.type)?"<span class=\"fixedFont\">"+(new Link().toSymbol(item.type))+"</span> " : "")+}<b>{+item.name+}</b>
713 <if test="item.isOptional"><i>Optional
714 <if test="item.defaultValue">,
715 Default: {+item.defaultValue+}
718 <dd>{+resolveLinks(item.desc)+}</dd>
722 <if test="member.deprecated">
723 <dl class="detailList">
724 <dt class="heading">Deprecated:</dt>
726 {+member.deprecated+}
730 <if test="member.since.length">
731 <dl class="detailList">
732 <dt class="heading">Since:</dt>
733 <dd>{+ member.since +}</dd>
737 <if test="member.exceptions.length">
738 <dl class="detailList">
739 <dt class="heading">Throws:</dt>
740 <for each="item" in="member.exceptions">
742 {+((item.type)?"<span class=\"light fixedFont\">{"+(new Link().toSymbol(item.type))+"}</span> " : "")+} <b>{+item.name+}</b>
744 <dd>{+resolveLinks(item.desc)+}</dd>
748 <if test="member.returns.length">
749 <dl class="detailList">
750 <dt class="heading">Returns:</dt>
751 <for each="item" in="member.returns">
752 <dd>{+((item.type)?"<span class=\"light fixedFont\">{"+(new Link().toSymbol(item.type))+"}</span> " : "")+}{+resolveLinks(item.desc)+}</dd>
756 <if test="member.requires.length">
757 <dl class="detailList">
758 <dt class="heading">Requires:</dt>
759 <for each="item" in="member.requires">
760 <dd>{+ resolveLinks(item) +}</dd>
764 <if test="member.see.length">
765 <dl class="detailList">
766 <dt class="heading">See:</dt>
767 <for each="item" in="member.see">
768 <dd>{+ new Link().toSymbol(item) +}</dd>
781 {+ (member.memberOf == data.alias) ? member.memberOf : new Link().toSymbol(member.memberOf) +}
791 {+ JSON.stringify(data, null,4) +}
795 <!-- ============================== footer ================================= -->
796 <div class="fineprint" style="clear:both">
797 <if test="Options.copyright">©{+Options.copyright+}<br /></if>
798 Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a> on {+new Date()+}
800 <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>