initial import
[roojs1] / buildSDK / doc_templates / class.tmpl
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2
3
4 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
5
6         <head>
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 */ !}
10                 
11                 <title>JsDoc Reference - {+data.alias+}</title>
12                 
13                 
14         <link rel="stylesheet" type="text/css" href="../../css/roojs.css" />            
15         <link rel="stylesheet" type="text/css" href="../default.css" />
16         
17         
18         <script type="text/javascript" src="../page.js">
19         
20         </script>
21          
22                 
23         </head>
24
25         <body onload="RooDocsPage.onload();">
26          
27         
28 <div class="body-wrap">
29
30     <!-- ============================== links to methods. ================================= --> 
31
32     <div class="top-tools">
33     <!--
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>
39         -->
40     </div>
41
42     
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(
49                                         function($) {  
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"; 
53                                                 iblock_indent += 20;
54                                         }
55                                 )
56                         !}<img src="../../images/default/s.gif" height="1"  width="{+ iblock_indent +}"/><img class="elbow" src="../../images/default/tree/elbow-end.gif"/>{+data.alias+} 
57
58                    </pre>
59                 </div>
60        </if>
61 <!-- ============================== class title / details ============================ -->
62     
63     {! 
64                         var fullpath = data.alias.split('.');
65                         var cls = fullpath.pop();
66                         var packge = fullpath.join(".");
67                          
68                         
69                         
70         !}
71     <h1 class="classTitle">
72                                 {!
73                                         var classType = "";
74                                         
75                                         if (data.isBuiltin()) {
76                                                 classType += "Built-In ";
77                                         }
78                                         
79                                         if (data.isNamespace) {
80                                                 if (data.is('FUNCTION')) {
81                                                         classType += "Function ";
82                                                 }
83                                                 classType += "Namespace ";
84                                         }
85                                         else {
86                                                 classType += "Class ";
87                                         }
88                                 !}
89                                 {+classType+}{+data.alias+}
90                         </h1>
91                         
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>
95         </if>
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)+}.
99                         </if>
100         </td></tr>
101         <tr><td class="label">Class:</td><td class="hd-info">{+cls+}</td></tr>
102         
103         <if test="data.childClasses.length">
104         <tr><td class="label">Subclasses:</td><td class="hd-info">
105                 {+
106                         data.childClasses
107                         .sort()
108                         .map(
109                                 function($) { return new Link().toSymbol($); }
110                         )
111                         .join(", ")
112                 +}
113
114         
115         
116         </td></tr>
117         </if>
118         <if test="data.augments.length">
119         
120                 <tr><td class="label">Extends:</td><td class="hd-info">
121                         {+
122                                 new Link().toSymbol(data.augments[data.augments.length -1])
123                                 
124                         +}
125         
126                 </td></tr>    
127         </if>
128         
129     </table>
130
131     
132 <!-- ============================== class summary ========================== -->                        
133     <div class="description">
134         {+resolveLinks(data.desc)+}
135     </div>
136
137         
138 <!-- ============================== Class comment block... ========================== -->                                       
139
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>
143         <br/>
144         <iframe frameborder="0"  id="comments-{+data.memberOf+}" style="border: none;width:100%;" 
145                 src="/blog.php/GtkDjsComments/{+data.alias+}.html"></iframe>
146 </div>
147         
148
149                 
150 <!-- ============================== config options ========================== -->                                               
151                  
152     
153     {!
154         
155          
156          
157         var cfgProperties = [];
158         if (!data.comment.getTag('singleton').length) {
159                 cfgProperties = data.configToArray();
160                 cfgProperties = cfgProperties.sort(makeSortby("name"));
161                 
162         }
163         
164                 
165                 
166         !}
167                 
168     <div class="hr"></div>
169     <a id="{+data.alias+}-configs"></a>
170                 
171     <if test="!cfgProperties.length">
172     
173      <table cellspacing="0" class="member-table">
174       <caption class="Empty">Config Options - Has None</caption>
175      </table>
176     
177     </if>
178      
179     <if test="cfgProperties.length">
180         
181       <table cellspacing="0" class="member-table">   
182       <caption>Config Options (Usually are also Properties)</caption>
183     
184         
185         <tr>
186             <th class="sig-header" colspan="2">Options</th>
187             
188             <th class="msource-header">Defined By</th>
189         </tr>
190         
191         
192         
193         <for each="dtag" in="cfgProperties">
194         
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">&nbsp;</a></td>
197                     <td class="sig">
198
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)) : "" )+}
202                                 
203                                 
204                         </div>
205                   
206                         <div class="mdesc">
207                             <div class="short">{+resolveLinks(summarize(dtag.desc))+}</div> 
208                         </div>
209                         
210                         <div class="mdesc">
211                             <div class="long">{+resolveLinks(dtag.desc)+}</div> 
212                         </div>
213                         
214                         
215
216                     </td>
217                     <td class="msource">
218                         {# - fixme - add inheritied as link here #}
219                         {+ (dtag.memberOf == data.alias) ? dtag.memberOf :  new Link().toSymbol(dtag.memberOf) +}
220                                 
221                     </td>
222                 </tr>
223         </for>
224         
225     </table>
226   </if>         
227   
228   
229   
230   
231   
232   
233   
234   
235   <!-- ============================== public properties ==================== -->        
236   
237   
238   
239     <a id="{+data.alias+}-props"></a>      
240     
241     {! 
242                 var ownProperties = [];
243                 var psorted = data.properties.sort(makeSortby("name"));
244                 psorted.filter(
245                         
246                         function($){
247                                 if (/$.hide/.test($.desc)) {
248                                         return false;
249                                 }
250                                 if ( !$.isNamespace || (($.memberOf != data.alias) && $.isStatic)) {
251                                         if ($.isStatic)  ownProperties.push($);
252                                 }
253                                 return true;
254                 
255                         }
256                 );
257      
258     !}
259
260     <if test="!ownProperties.length">
261     
262      <table cellspacing="0" class="member-table">
263       <caption class="Empty">Public Properties - Has None</caption>
264      </table>
265     
266     </if>
267      
268     <if test="ownProperties.length">
269         
270       <table cellspacing="0" class="member-table">   
271       <caption>Public Properties </caption>
272         <tr>
273             <th class="sig-header" colspan="2">Property</th>
274             <th class="sig-header">Description</th>
275             <th class="msource-header">Defined By</th>
276         </tr>
277         
278       
279                     
280           
281         <for each="member" in="ownProperties">   
282          
283         
284         
285           <tr class="property-row config-row-alt{+$member_i % 2+}{!
286
287                 if (member.memberOf == data.alias) {
288                         output += " notInherited";
289                  }
290                   
291                  !}">
292             <td class="micon">
293                 <a class="exi" href="#expand">&nbsp;</a>
294             </td>
295             <td class="sig">
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 += "&lt;private&gt; ";
300                         if (member.isInner) output += "&lt;inner&gt; ";
301                         
302                         if (member.isConstant) output += "&lt;constant&gt; ";
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>
306                      </div>
307             </td>
308             <td class="sig">
309                 <div class="mdesc">
310
311
312                    <div class="short">
313                         {+resolveLinks(summarize(member.desc))+}
314                    
315                    
316                    
317                    </div> 
318                     
319                     <div class="long">
320                     
321                         {+resolveLinks(member.desc)+}                        
322                  
323                 </div>
324                 </div>
325             </td>
326             
327             <td class="msource">  
328             {+ (member.memberOf == data.alias) ? member.memberOf :  new Link().toSymbol(member.memberOf) +}
329             </td>             
330                 
331           </tr>
332         </for>
333         
334          
335         
336       
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">
339              
340         -->
341
342     </table>
343   
344     </if>
345   <!-- ============================== methods summary / details ======================== -->
346   
347   
348   <a id="{+data.alias+}-methods"></a>
349         <!-- constructor?? -->
350         {! 
351                 var ownMethods = [];
352         
353                 if (data.comment.getTag('class').length && 
354                         !data.isBuiltin() && 
355                         !data.comment.getTag('singleton').length &&
356                         !data.comment.getTag('static').length
357                         ) {
358                         data.isInherited = false;
359                         ownMethods.push(data);
360                 }
361                 
362                 var msorted = data.methods.sort(makeSortby("name"));
363         !}
364         <!-- static's first 
365         
366         
367         -->
368         {!
369                 msorted.filter(
370                                 function($){
371                                         
372                                         if (/@hide/.test($.desc)) {
373                                                 return false;
374                                         }
375                                         
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)) {
379                                                                 return true;
380                                                         }
381                                                 $.isInherited = ($.memberOf != data.alias);
382                                                 ownMethods.push($);
383                                                 return true;
384                                         }
385                                         
386                                         
387                                         if ($.isNamespace || $.isEvent || (($.memberOf != data.alias) && $.isStatic)){
388                                                 return true;
389                                         }
390                                         if ($.isStatic) {
391                                                 $.isInherited = ($.memberOf != data.alias);
392                                                 ownMethods.push($);
393                                         }
394                                         
395                                         return true;
396                                 }
397                         );
398         !}
399         <!-- then dynamics first -->
400         {!      
401                 msorted.filter(
402                                 function($){
403                                         if (/@hide/.test($.desc)) {
404                                                 return false;
405                                         }
406                                         if (data.comment.getTag("instanceOf").length  || data.comment.getTag("singleton").length) {
407                                                 return true;
408                                         }
409                                         if ($.isNamespace || $.isEvent || (($.memberOf != data.alias) && $.isStatic)){
410                                                 
411                                                 return true;
412                                         }
413                                         if (!$.isStatic) {
414                                                 $.isInherited = ($.memberOf != data.alias);
415                                                 ownMethods.push($);
416                                         }
417                                         
418                                         return true;
419                                 }
420                         );
421                  
422         !}
423   
424   
425     <if test="!ownMethods.length">
426     
427      <table cellspacing="0" class="member-table">
428       <caption class="Empty">Public Methods - Has None</caption>
429      </table>
430     
431     </if>
432     <if test="ownMethods.length">
433     
434       <table cellspacing="0" class="member-table">
435       <caption>Public Methods</caption>
436         <tr>
437             <th class="sig-header" colspan="2">Method</th>            
438             <th class="msource-header">Defined By</th>
439
440         </tr>
441         
442         
443         
444          
445         
446         <for each="member" in="ownMethods">
447           
448           <tr class="method-row config-row-alt{+$member_i % 2+}{!
449                   if (member.is("CONSTRUCTOR") && !member.params.length) {
450                           output += '';
451                  } else {
452                           output += ' expandable';
453                         }
454                   
455                   
456                 if (!member.isInherited) {
457                         output += " notInherited";
458                  }
459                   
460                  !}">
461             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
462            
463            
464             <td class="sig">
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>";
470                                         } else {
471                                                 
472                                                 
473                                                 if (member.isPrivate) output += "&lt;private&gt; ";
474                                                 if (member.isInner) output += "&lt;inner&gt; ";
475                                                 if (member.isStatic || data.comment.getTag("singleton").length || data.comment.getTag("instanceOf").length) {
476                                                         output +=  data.alias + ".";    
477                                                 }
478                                         }
479                                 !}</span><b class="itemname">{+member.name+}</b>
480                                 
481                                  {+makeSignature(member.params)+} 
482                         
483                                 <if test="member.returns.length">
484                                          : 
485                                         <for each="item" in="member.returns">
486                                                 <if test="$item_i > 0"> or </if>
487                                                 {+((item.type) ? (new Link().toSymbol(item.type)) : "" )+}
488                                         
489                                         </for>
490                                         
491                                 </if>
492                         
493                 </div>
494                 <div class="mdesc">
495                 <if test="!member.is('CONSTRUCTOR')">
496                    <div class="short">{+resolveLinks(summarize(member.desc))+}</div> 
497                  </if>
498                  <if test="member.is('CONSTRUCTOR')">
499                         <div class="short">Create a new {+data.alias +}</div> 
500                  </if>
501                  
502                     <div class="long">
503                         <if test="!member.is('CONSTRUCTOR')">
504                                 {+resolveLinks(member.desc)+}
505                     
506                                 <if test="member.example">
507                                         <pre class="code">{+member.example+}</pre>
508                                 </if>
509                         </if>
510                         
511                         <if test="member.is('CONSTRUCTOR')">
512                                 Create a new {+data.alias +}
513                         </if>
514                         <if test="member.params.length">
515                                 <dl class="detailList">
516                                 <dt class="heading">Parameters:</dt>
517                                 <for each="item" in="member.params">
518                                         <dt>
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+}
523                                                 </if></i></if>
524                                         </dt>
525                                         <dd>{+resolveLinks(item.desc)+}</dd>
526                                 </for>
527                                 </dl>
528                         </if>
529                         <if test="member.deprecated">
530                                 <dl class="detailList">
531                                 <dt class="heading">Deprecated:</dt>
532                                 <dt>
533                                         {+member.deprecated+}
534                                 </dt>
535                                 </dl>
536                         </if>
537                         <if test="member.since.length">
538                                 <dl class="detailList">
539                                 <dt class="heading">Since:</dt>
540                                         <dd>{+ member.since +}</dd>
541                                 </dl>
542                                 </dl>
543                         </if>
544                         <if test="member.exceptions.length">
545                                 <dl class="detailList">
546                                 <dt class="heading">Throws:</dt>
547                                 <for each="item" in="member.exceptions">
548                                         <dt>
549                                                 {+((item.type)?"<span class=\"fixedFont\">{"+(new Link().toSymbol(item.type))+"}</span> " : "")+} <b>{+item.name+}</b>
550                                         </dt>
551                                         <dd>{+resolveLinks(item.desc)+}</dd>
552                                 </for>
553                                 </dl>
554                         </if>
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>
560                                 </for>
561                                 </dl>
562                         </if>
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>
568                                 </for>
569                                 </dl>
570                         </if>
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>
576                                 </for>
577                                 </dl>
578                         </if>
579
580                     
581                     
582                      
583                     </div>                    
584                 </div>
585
586             </td>
587             <td class="msource">
588                 <if test="!member.is('CONSTRUCTOR')">
589                         {+ (member.memberOf == data.alias) ? member.memberOf :  new Link().toSymbol(member.memberOf) +}
590                 </if>&nbsp;
591             </td>
592         </tr>
593         </for>
594                                                        
595     </table>
596 </if>
597   
598   <!-- ============================== events summary / details ======================== -->
599   
600   
601   <a id="{+data.alias+}-events"></a>
602     
603   
604         {! 
605                 
606                 
607                 var ownEvents = data.methods.filter(
608                                 function($){
609                                         
610                                         return $.isEvent && !$.comment.getTag('hide').length;
611                                                 
612                                 }
613                         ).sort(makeSortby("name"));
614                  
615         !}
616    <if test="!ownEvents.length">
617     
618      <table cellspacing="0" class="member-table">
619       <caption class="Empty">Events - Has None</caption>
620      </table>
621     
622     </if>
623   
624     
625     <if test="ownEvents.length">
626     
627       <table cellspacing="0" class="member-table">
628                 <caption>Events</caption>
629               <thead>
630                 <tr>
631                     <th class="sig-header" colspan="2">Event</th>            
632                     <th class="msource-header">Defined By</th>
633
634                 </tr>
635               </thead>  
636         
637         
638          
639         
640         <for each="member" in="ownEvents">
641           <tr class="method-row expandable config-row-alt{+$member_i % 2+}{!
642
643                 if (member.memberOf == data.alias) {
644                         output += " notInherited";
645                  }
646                   
647                  !}">
648             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
649             
650             <td class="sig">
651                 <a id="{+member.memberOf+}-event-{+member.name+}"></a>
652                 
653                <div class="fixedFont">
654                 <b class="itemname">{+member.name.substring(1)+}</b> {+makeSignature(member.params)+} 
655                 
656                 </div>
657
658                 <div class="mdesc">
659
660                    <div class="short">{+resolveLinks(summarize(member.desc))+}
661                    
662                 </div> 
663                     
664                     <div class="long">
665                     
666                         {+resolveLinks(member.desc)+}
667                     
668                         <if test="member.example">
669                                 <pre class="code">{+member.example+}</pre>
670                         </if>
671                         
672                 
673                         <if test="member.params.length">
674                                 <dl class="detailList">
675                                 <dt class="heading">Parameters:</dt>
676                                 <for each="item" in="member.params">
677                                         <dt>
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+}
682                                                 </if></i></if>
683                                         </dt>
684                                         <dd>{+resolveLinks(item.desc)+}</dd>
685                                 </for>
686                                 </dl>
687                         </if>
688                         <if test="member.deprecated">
689                                 <dl class="detailList">
690                                 <dt class="heading">Deprecated:</dt>
691                                 <dt>
692                                         {+member.deprecated+}
693                                 </dt>
694                                 </dl>
695                         </if>
696                         <if test="member.since.length">
697                                 <dl class="detailList">
698                                 <dt class="heading">Since:</dt>
699                                         <dd>{+ member.since +}</dd>
700                                 </dl>
701                                 </dl>
702                         </if>
703                         <if test="member.exceptions.length">
704                                 <dl class="detailList">
705                                 <dt class="heading">Throws:</dt>
706                                 <for each="item" in="member.exceptions">
707                                         <dt>
708                                                 {+((item.type)?"<span class=\"light fixedFont\">{"+(new Link().toSymbol(item.type))+"}</span> " : "")+} <b>{+item.name+}</b>
709                                         </dt>
710                                         <dd>{+resolveLinks(item.desc)+}</dd>
711                                 </for>
712                                 </dl>
713                         </if>
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>
719                                 </for>
720                                 </dl>
721                         </if>
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>
727                                 </for>
728                                 </dl>
729                         </if>
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>
735                                 </for>
736                                 </dl>
737                         </if>
738
739                     
740                     
741                      
742                     </div>                    
743                 </div>
744
745             </td>
746             <td class="msource">
747                 {+ (member.memberOf == data.alias) ? member.memberOf :  new Link().toSymbol(member.memberOf) +}
748             </td>
749         </tr>
750         </for>
751                                                        
752     </table>
753 </if>
754   
755   
756   
757  
758 <!-- ============================== footer ================================= -->
759                 <div class="fineprint" style="clear:both">
760                         <if test="JSDOC.opt.D['copyright']">&copy;{+JSDOC.opt.D.copyright+}<br /></if>
761                         Documentation generated by <a href="http://www.akbkhome.com/rooscript">RooScript/Jstoolkit</a> 
762                         Based on 
763                         <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a> on {+new Date()+}
764                 </div>
765         </body>
766 </html>