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 : './symbol/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>
214 <div class="long">{+resolveLinks(dtag.desc)+}</div>
221 {# - fixme - add inheritied as link here #}
222 {+ (dtag.memberOf == data.alias) ? dtag.memberOf : new Link().toSymbol(dtag.memberOf) +}
238 <!-- ============================== public properties ==================== -->
242 <a id="{+data.alias+}-props"></a>
245 var ownProperties = [];
246 var psorted = data.properties.sort(makeSortby("name"));
250 if (/$.hide/.test($.desc)) {
253 if ( !$.isNamespace || (($.memberOf != data.alias) && $.isStatic)) {
254 if ($.isStatic) ownProperties.push($);
263 <if test="!ownProperties.length">
265 <table cellspacing="0" class="member-table">
266 <caption class="Empty">Public Properties - Has None</caption>
271 <if test="ownProperties.length">
273 <table cellspacing="0" class="member-table">
274 <caption>Public Properties </caption>
276 <th class="sig-header" colspan="2">Property</th>
277 <th class="sig-header">Description</th>
278 <th class="msource-header">Defined By</th>
284 <for each="member" in="ownProperties">
288 <tr class="property-row config-row-alt{+$member_i % 2+}{!
290 if (member.memberOf == data.alias) {
291 output += " notInherited";
296 <a class="exi" href="#expand"> </a>
299 <a id="{+member.memberOf+}-prop-{+member.name+}" name=".{+member.name+}"></a>
300 <div class="fixedFont">
301 <span class="attributes">{!
302 if (member.isPrivate) output += "<private> ";
303 if (member.isInner) output += "<inner> ";
305 if (member.isConstant) output += "<constant> ";
306 if (member.isStatic) output += ""+data.alias +".";
307 !}</span><b class="itemname">{+member.name+}</b> :
308 <span type="etype">{+((member.type) ? (new Link().toSymbol(member.type)) : "" )+}</span>
316 {+resolveLinks(summarize(member.desc))+}
324 {+resolveLinks(member.desc)+}
331 {+ (member.memberOf == data.alias) ? member.memberOf : new Link().toSymbol(member.memberOf) +}
340 <!-- TODO: implement this alt row. also notice non-linked "Defined by" when property is a part of this class.
341 <tr class="property-row alt">
348 <!-- ============================== methods summary / details ======================== -->
351 <a id="{+data.alias+}-methods"></a>
352 <!-- constructor?? -->
356 if (data.comment.getTag('class').length &&
358 !data.comment.getTag('singleton').length &&
359 !data.comment.getTag('static').length
361 data.isInherited = false;
362 ownMethods.push(data);
365 var msorted = data.methods.sort(makeSortby("name"));
375 if (/@hide/.test($.desc)) {
379 if (!$.isEvent && (data.comment.getTag("instanceOf").length || data.comment.getTag("singleton").length)) {
380 if ($.isStatic && (data.comment.getTag("instanceOf").length || data.comment.getTag("singleton").length) &&
381 ($.memberOf != data.alias)) {
384 $.isInherited = ($.memberOf != data.alias);
390 if ($.isNamespace || $.isEvent || (($.memberOf != data.alias) && $.isStatic)){
394 $.isInherited = ($.memberOf != data.alias);
402 <!-- then dynamics first -->
406 if (/@hide/.test($.desc)) {
409 if (data.comment.getTag("instanceOf").length || data.comment.getTag("singleton").length) {
412 if ($.isNamespace || $.isEvent || (($.memberOf != data.alias) && $.isStatic)){
417 $.isInherited = ($.memberOf != data.alias);
428 <if test="!ownMethods.length">
430 <table cellspacing="0" class="member-table">
431 <caption class="Empty">Public Methods - Has None</caption>
435 <if test="ownMethods.length">
437 <table cellspacing="0" class="member-table">
438 <caption>Public Methods</caption>
440 <th class="sig-header" colspan="2">Method</th>
441 <th class="msource-header">Defined By</th>
449 <for each="member" in="ownMethods">
451 <tr class="method-row config-row-alt{+$member_i % 2+}{!
452 if (member.is("CONSTRUCTOR") && !member.params.length) {
455 output += ' expandable';
459 if (!member.isInherited) {
460 output += " notInherited";
464 <td class="micon"><a class="exi" href="#expand"> </a></td>
468 <a id="{+member.memberOf+}-method-{+member.name+}" name=".{+member.name+}"></a>
469 <div class="fixedFont">
470 <span class="attributes">{!
471 if (member.is('CONSTRUCTOR')) {
472 output += "new <B>" + member.memberOf + (member.memberOf.length ? "." : "") +"</B>";
476 if (member.isPrivate) output += "<private> ";
477 if (member.isInner) output += "<inner> ";
478 if (member.isStatic || data.comment.getTag("singleton").length || data.comment.getTag("instanceOf").length) {
479 output += data.alias + ".";
482 !}</span><b class="itemname">{+member.name+}</b>
484 {+makeSignature(member.params)+}
486 <if test="member.returns.length">
488 <for each="item" in="member.returns">
489 <if test="$item_i > 0"> or </if>
490 {+((item.type) ? (new Link().toSymbol(item.type)) : "" )+}
498 <if test="!member.is('CONSTRUCTOR')">
499 <div class="short">{+resolveLinks(summarize(member.desc))+}</div>
501 <if test="member.is('CONSTRUCTOR')">
502 <div class="short">Create a new {+data.alias +}</div>
506 <if test="!member.is('CONSTRUCTOR')">
507 {+resolveLinks(member.desc)+}
509 <if test="member.example">
510 <pre class="code">{+member.example+}</pre>
514 <if test="member.is('CONSTRUCTOR')">
515 Create a new {+data.alias +}
517 <if test="member.params.length">
518 <dl class="detailList">
519 <dt class="heading">Parameters:</dt>
520 <for each="item" in="member.params">
522 {+((item.type)?"<span class=\"fixedFont\">"+(new Link().toSymbol(item.type))+"</span> " : "")+} <b>{+item.name+}</b>
523 <if test="item.isOptional"><i>Optional
524 <if test="item.defaultValue">,
525 Default: {+item.defaultValue+}
528 <dd>{+resolveLinks(item.desc)+}</dd>
532 <if test="member.deprecated">
533 <dl class="detailList">
534 <dt class="heading">Deprecated:</dt>
536 {+member.deprecated+}
540 <if test="member.since.length">
541 <dl class="detailList">
542 <dt class="heading">Since:</dt>
543 <dd>{+ member.since +}</dd>
547 <if test="member.exceptions.length">
548 <dl class="detailList">
549 <dt class="heading">Throws:</dt>
550 <for each="item" in="member.exceptions">
552 {+((item.type)?"<span class=\"fixedFont\">{"+(new Link().toSymbol(item.type))+"}</span> " : "")+} <b>{+item.name+}</b>
554 <dd>{+resolveLinks(item.desc)+}</dd>
558 <if test="member.returns.length">
559 <dl class="detailList">
560 <dt class="heading">Returns:</dt>
561 <for each="item" in="member.returns">
562 <dd>{+((item.type)?"<span class=\"fixedFont\">"+(new Link().toSymbol(item.type))+"</span> " : "")+} {+resolveLinks(item.desc)+}</dd>
566 <if test="member.requires.length">
567 <dl class="detailList">
568 <dt class="heading">Requires:</dt>
569 <for each="item" in="member.requires">
570 <dd>{+ resolveLinks(item) +}</dd>
574 <if test="member.see.length">
575 <dl class="detailList">
576 <dt class="heading">See:</dt>
577 <for each="item" in="member.see">
578 <dd>{+ new Link().toSymbol(item) +}</dd>
591 <if test="!member.is('CONSTRUCTOR')">
592 {+ (member.memberOf == data.alias) ? member.memberOf : new Link().toSymbol(member.memberOf) +}
601 <!-- ============================== events summary / details ======================== -->
604 <a id="{+data.alias+}-events"></a>
610 var ownEvents = data.methods.filter(
613 return $.isEvent && !$.comment.getTag('hide').length;
616 ).sort(makeSortby("name"));
619 <if test="!ownEvents.length">
621 <table cellspacing="0" class="member-table">
622 <caption class="Empty">Events - Has None</caption>
628 <if test="ownEvents.length">
630 <table cellspacing="0" class="member-table">
631 <caption>Events</caption>
634 <th class="sig-header" colspan="2">Event</th>
635 <th class="msource-header">Defined By</th>
643 <for each="member" in="ownEvents">
644 <tr class="method-row expandable config-row-alt{+$member_i % 2+}{!
646 if (member.memberOf == data.alias) {
647 output += " notInherited";
651 <td class="micon"><a class="exi" href="#expand"> </a></td>
654 <a id="{+member.memberOf+}-event-{+member.name+}"></a>
656 <div class="fixedFont">
657 <b class="itemname">{+member.name.substring(1)+}</b> {+makeSignature(member.params)+}
663 <div class="short">{+resolveLinks(summarize(member.desc))+}
669 {+resolveLinks(member.desc)+}
671 <if test="member.example">
672 <pre class="code">{+member.example+}</pre>
676 <if test="member.params.length">
677 <dl class="detailList">
678 <dt class="heading">Parameters:</dt>
679 <for each="item" in="member.params">
681 {+((item.type)?"<span class=\"fixedFont\">"+(new Link().toSymbol(item.type))+"</span> " : "")+}<b>{+item.name+}</b>
682 <if test="item.isOptional"><i>Optional
683 <if test="item.defaultValue">,
684 Default: {+item.defaultValue+}
687 <dd>{+resolveLinks(item.desc)+}</dd>
691 <if test="member.deprecated">
692 <dl class="detailList">
693 <dt class="heading">Deprecated:</dt>
695 {+member.deprecated+}
699 <if test="member.since.length">
700 <dl class="detailList">
701 <dt class="heading">Since:</dt>
702 <dd>{+ member.since +}</dd>
706 <if test="member.exceptions.length">
707 <dl class="detailList">
708 <dt class="heading">Throws:</dt>
709 <for each="item" in="member.exceptions">
711 {+((item.type)?"<span class=\"light fixedFont\">{"+(new Link().toSymbol(item.type))+"}</span> " : "")+} <b>{+item.name+}</b>
713 <dd>{+resolveLinks(item.desc)+}</dd>
717 <if test="member.returns.length">
718 <dl class="detailList">
719 <dt class="heading">Returns:</dt>
720 <for each="item" in="member.returns">
721 <dd>{+((item.type)?"<span class=\"light fixedFont\">{"+(new Link().toSymbol(item.type))+"}</span> " : "")+}{+resolveLinks(item.desc)+}</dd>
725 <if test="member.requires.length">
726 <dl class="detailList">
727 <dt class="heading">Requires:</dt>
728 <for each="item" in="member.requires">
729 <dd>{+ resolveLinks(item) +}</dd>
733 <if test="member.see.length">
734 <dl class="detailList">
735 <dt class="heading">See:</dt>
736 <for each="item" in="member.see">
737 <dd>{+ new Link().toSymbol(item) +}</dd>
750 {+ (member.memberOf == data.alias) ? member.memberOf : new Link().toSymbol(member.memberOf) +}
761 <!-- ============================== footer ================================= -->
762 <div class="fineprint" style="clear:both">
763 <if test="Options.copyright">©{+Options.copyright+}<br /></if>
764 Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspeciton Doc Generator</a> {+Options.version+} on {+new Date()+}
766 <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a> on {+new Date()+}