5 summary : function (data)
8 output = this.resolveLinks(data.desc) ;
9 if (data.example.length) {
10 output += '<pre class="code">'+data.example+'</pre>';
17 augments : function(data)
19 if (!data.augments.length) {
22 var linkSymbol = this.linkSymbol;
23 var output = '<div class="inheritance res-block"> <pre class="res-block-inner">';
25 var iblock_indent = 0;
26 data.augments.reverse().map(
28 output += iblock_indent ? ('<img src="../images/default/s.gif" height="1" width="' +
29 iblock_indent + '"/><img src="../images/default/tree/elbow-end.gif" class="elbow"/>') : '';
30 output += linkSymbol($) + "\n";
35 return output + '<img src="../images/default/s.gif" height="1" width="' + iblock_indent +'"/>' +
36 '<img class="elbow" src="../images/default/tree/elbow-end.gif"/>'+data.name+
42 implementors : function(data)
44 if (!data.childClasses || typeof(data.childClasses[data.name]) == 'undefined') {
47 var linkSymbol = this.linkSymbol;
48 //var linkSymbol = this.linkSymbol;
49 var output = '<ul class="inheritance res-block"> ';
51 var iterArray = function(ar) {
52 for(var i = 0; i < ar.length; i++) {
53 output += '<li>' +linkSymbol(ar[i]) ; // a href...
54 if (typeof(data.childClasses[ar[i]]) != 'undefined') {
56 iterArray(data.childClasses[ar[i]]);
64 iterArray(data.childClasses[data.name]);
66 return output + '</ul>'
70 doc_children : function(data)
72 if (!data.tree_children || data.tree_children < 1) {
76 var ar = data.tree_children;
79 var linkSymbol = this.linkSymbol;
80 //var linkSymbol = this.linkSymbol;
81 var output = '<ul class="doc-children-list res-block"> ';
83 for(var i = 0; i < ar.length; i++) {
84 output += '<li>' +linkSymbol(ar[i]) + "</li>";
91 return output + '</ul>'
96 config : function(dtag)
99 var output = '<a name="'+dtag.memberOf+'-cfg-'+dtag.name+'"></a>';
100 output += '<div class="fixedFont"><b class="itemname"> ' + dtag.name + '</b> : ' +
101 (dtag.type.length ? this.linkSymbol(dtag.type) : "" ) + '</div>';
103 output += '<div class="mdesc"><div class="short">'+this.resolveLinks(this.summarize(dtag.desc))+'</div></div>';
105 output += '<div class="mdesc"><div class="long">' + this.resolveLinks(dtag.desc)+ ' ' +
106 (dtag.values && dtag.values.length ? ("<BR/>Possible Values: " +
107 dtag.values.map(function(v) {
108 return v.length ? v : "<B>Empty</B>";
111 Roo.log(JSON.stringify(output));
115 methodsSort : function(data)
121 if (data.name.length &&
127 data.isInherited = false;
128 data.isConstructor = true;
129 ownMethods.push(data); // should push ctor???
132 var msorted = data.methods.sort(this.makeSortby("name"));
142 if (data.isSingleton) {
144 if ($.isStatic && $.memberOf != data.name) { // it's a singleton - can not inherit static methods.
148 $.isInherited = ($.memberOf != data.name);
154 if (($.memberOf != data.name) && $.isStatic){
158 $.isInherited = ($.memberOf != data.name);
170 //if (/@hide/.test($.desc)) {
173 // it's a signleton class - can not have dynamic methods..
174 if (data.isSingleton) {
177 if (($.memberOf != data.name) && $.isStatic){
181 $.isInherited = ($.memberOf != data.alias);
194 method : function(member) {
196 var output = '<a name="' + member.memberOf +'.' + member.name + '"></a>' +
197 '<div class="fixedFont"> <span class="attributes">';
199 if (member.isConstructor) {
203 if (member.isPrivate) output += "<private> ";
204 if (member.isInner) output += "<inner> ";
205 if (member.isStatic || member.isSingleton) { //|| data.comment.getTag("instanceOf").length) {
206 output += member.memberOf + ".";
209 output += '</span><b class="itemname">' + member.name + '</b>';
211 output += this.makeSignature(member.params);
212 if (member.returns && member.returns.length) {
214 for(var i = 0;i< member.returns.length;i++) {
215 var item = member.returns[i];
216 output += (i > 0 ? ' or ' : '') +
217 this.linkSymbol(item.type);
222 output += '</div> <div class="mdesc">';
223 if (!member.isConstructor) {
224 output+= '<div class="short">'+this.resolveLinks(this.summarize(member.desc)) +'</div>';
227 output+= '<div class="short">Create a new '+member.memberOf +'</div>';
229 output +='<div class="long">';
230 if (!member.isConstructor) {
231 output+= this.resolveLinks(member.desc) ;
232 if (member.example.length) {
233 output += '<pre class="code">'+member.example+'</pre>';
237 output+= 'Create a new '+member.memberOf;
238 // example and desc.. are normally on the 'top'...
240 if (member.params.length) {
243 output+= '<dl class="detailList"> <dt class="heading">Parameters:</dt>';
244 for(var i = 0; i < member.params.length ; i++) {
245 var item = member.params[i];
248 '<span class="fixedFont">' + this.linkSymbol(item.type) + '</span> ' :
250 )+ '<b>'+item.name+'</b>';
251 if (item.isOptional) {
252 output+='<i>Optional ';
253 if (item.defaultValue.length) {
254 output+='Default: '+item.defaultValue;
258 output +='</dt><dd>'+this.resolveLinks(item.desc)+'</dd>';
262 if (member.isDeprecated || (member.deprecated && member.deprecated.length)) {
263 output+= '<dl class="detailList"><dt class="heading">Deprecated:</dt><dt>' +
264 +member.deprecated+'</dt></dl>';
268 if (member.since && member.since.length) {
269 output+= '<dl class="detailList"><dt class="heading">Since:</dt><dt>' +
270 +member.since+'</dt></dl>';
273 <if test="member.exceptions.length">
274 <dl class="detailList">
275 <dt class="heading">Throws:</dt>
276 <for each="item" in="member.exceptions">
278 {+((item.type)?"<span class=\"fixedFont\">{"+(new Link().toSymbol(item.type))+"}</span> " : "")+} <b>{+item.name+}</b>
280 <dd>{+resolveLinks(item.desc)+}</dd>
285 if (member.returns && member.returns.length) {
286 output += '<dl class="detailList"><dt class="heading">Returns:</dt>';
287 for (var i =0; i < member.returns.length; i++) {
288 var item = member.returns[i];
289 output+= '<dd>' + this.linkSymbol( item.type ) + ' ' + this.resolveLinks(item.desc) + '</dd></dl>';
295 <if test="member.requires.length">
296 <dl class="detailList">
297 <dt class="heading">Requires:</dt>
298 <for each="item" in="member.requires">
299 <dd>{+ resolveLinks(item) +}</dd>
304 if (member.see && member.see.length) {
305 output+= '<dl class="detailList"><dt class="heading">See:</dt><dt>' +
306 '<dd>' + this.linkSymbol( member.see ) +'</dd></dl>';
308 output +='</div></div>';
314 event : function(member)
318 var output = '<a name="' + member.memberOf +'-event-' + member.name + '"></a>' +
319 '<div class="fixedFont"> ';
322 output += '<b class="itemname">'+member.name+'</b>' +this.makeSignature(member.params) + '</div>';
324 output += '<div class="mdesc">';
325 output += '<div class="short">' +this.resolveLinks(this.summarize(member.desc))+ '</div>';
328 output += '<div class="long">' + this.resolveLinks(member.desc);
330 if (member.example.length) {
331 output +='<pre class="code">'+member.example+'</pre>';
333 if (member.params.length) {
336 output+= '<dl class="detailList"> <dt class="heading">Parameters:</dt>';
337 for(var i = 0; i < member.params.length ; i++) {
338 var item = member.params[i];
341 '<span class="fixedFont">' + this.linkSymbol(item.type) + '</span> ' :
343 )+ '<b>'+item.name+'</b>';
344 if (item.isOptional) {
345 output+='<i>Optional ';
346 if (item.defaultValue.length) {
347 output+='Default: '+item.defaultValue;
351 output +='</dt><dd>'+this.resolveLinks(item.desc)+'</dd>';
355 if ((member.deprecated && member.deprecated.length) || member.isDeprecated) {
356 output+= '<dl class="detailList"><dt class="heading">Deprecated:</dt><dt>' +
357 +member.deprecated+'</dt></dl>';
361 if (member.since && member.since.length) {
362 output+= '<dl class="detailList"><dt class="heading">Since:</dt><dt>' +
363 +member.since+'</dt></dl>';
366 <if test="member.exceptions.length">
367 <dl class="detailList">
368 <dt class="heading">Throws:</dt>
369 <for each="item" in="member.exceptions">
371 {+((item.type)?"<span class=\"fixedFont\">{"+(new Link().toSymbol(item.type))+"}</span> " : "")+} <b>{+item.name+}</b>
373 <dd>{+resolveLinks(item.desc)+}</dd>
378 if (member.returns && member.returns.length) {
379 output += '<dl class="detailList"><dt class="heading">Returns:</dt>';
380 for (var i =0; i < member.returns.length; i++) {
381 var item = member.returns[i];
382 output+= '<dd>' + this.linkSymbol( item.type ) + ' ' + this.resolveLinks(item.desc) + '</dd></dl>';
388 <if test="member.requires.length">
389 <dl class="detailList">
390 <dt class="heading">Requires:</dt>
391 <for each="item" in="member.requires">
392 <dd>{+ resolveLinks(item) +}</dd>
397 if (member.see && member.see.length) {
398 output+= '<dl class="detailList"><dt class="heading">See:</dt><dt>' +
399 '<dd>' + this.linkSymbol( member.see ) +'</dd></dl>';
401 output +='</div></div>';
415 makeSignature : function(params)
418 if (!params.length) return "()";
419 var linkSymbol = this.linkSymbol;
420 var signature = " (" +
423 return $.name.indexOf(".") == -1; // don't show config params in signature
427 $.defaultValue = typeof($.defaultValue) == 'undefined' ? false : $.defaultValue;
430 ($.isOptional ? "[" : "") +
433 (typeof($.type) == 'object' ) ? 'Function' : $.type
436 "<B><i>" +$.name + "</i></B>" +
437 ($.defaultValue ? "=" +item.defaultValue : "") +
438 ($.isOptional ? "]" : "");
448 resolveLinks : function(str)
450 if (!str || typeof(str) == 'undefined') {
454 // gtk specific. now..
455 // @ -> bold.. - they are arguments..
457 str = str.replace(/@([a-z_]+)/gi,
458 function(match, symbolName) {
459 return '<b>' + symbolName + '</b>';
463 str = str.replace(/%([a-z_]+)/gi,
464 function(match, symbolName) {
465 return '<b>' + symbolName + '</b>';
469 str = str.replace(/#([a-z_]+)/gi,
470 function(match, symbolName) {
471 return '<b>' + symbolName + '</b>';
472 // this should do a lookup!!!!
473 /// it could use data in the signature to find out..
474 //return new Link().toSymbol(Template.data.ns + '.' + symbolName);
478 //Roo.log(JSON.stringify(str));
479 str = str.replace(/[ \t]+\n/gi, '\n');
480 str = str.replace(/\n\n+/gi, '<br/><br/>');
481 //str = str.replace(/\n/gi, '<br/>');
482 var linkSymbol = this.linkSymbol;
483 str = str.replace(/\{@link ([^} ]+) ?\}/gi,
484 function(match, symbolName) {
485 return linkSymbol(symbolName);
491 summarize : function(desc)
493 if (typeof desc != "undefined") {
494 // finds the first fulls stop... (and we remove '<' html...)
495 return desc.match(/([\w\W]+?[\.|:])[^a-z0-9]/i)?
496 RegExp.$1.split('<')[0].replace("\n", " ") : desc.split("\n")[0];
500 linkSymbol : function(str)
503 var ar = str.split('<');
505 for(var i = ar.length-1; i > -1; i--) {
506 var bit = ar[i].split('>').shift();
508 out = '<' + out + '>';
510 out = '<span class=\"fixedFont\"><a href="#' + bit+ '">' + bit + '</a>' + out + '</span>';
515 makeSortby : function(attribute) {
516 return function(a, b) {
517 if (a[attribute] != undefined && b[attribute] != undefined) {
518 a = a[attribute]; //.toLowerCase();
519 b = b[attribute];//.toLowerCase();
520 if (a < b) return -1;