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.realImplementors.length) {
47 var linkSymbol = this.linkSymbol;
48 var output = '<ul class="inheritance res-block"> ';
50 data.realImplementors.sort();
53 var iblock_indent = 0;
54 data.realImplementors.map(
57 output += '<li>' + linkSymbol($) + '</li>';
62 return output + '</ul>'
66 config : function(dtag)
69 var output = '<a name="'+dtag.memberOf+'-cfg-'+dtag.name+'"></a>';
70 output += '<div class="fixedFont"><b class="itemname"> ' + dtag.name + '</b> : ' +
71 (dtag.type.length ? this.linkSymbol(dtag.type) : "" ) + '</div>';
73 output += '<div class="mdesc"><div class="short">'+this.resolveLinks(this.summarize(dtag.desc))+'</div></div>';
75 output += '<div class="mdesc"><div class="long">' + this.resolveLinks(dtag.desc)+ ' ' +
76 (dtag.values && dtag.values.length ? ("<BR/>Possible Values: " +
77 dtag.values.map(function(v) {
78 return v.length ? v : "<B>Empty</B>";
81 Roo.log(JSON.stringify(output));
85 methodsSort : function(data)
91 if (data.name.length &&
97 data.isInherited = false;
98 data.isConstructor = true;
99 ownMethods.push(data); // should push ctor???
102 var msorted = data.methods.sort(this.makeSortby("name"));
112 if (data.isSingleton) {
114 if ($.isStatic && $.memberOf != data.name) { // it's a singleton - can not inherit static methods.
118 $.isInherited = ($.memberOf != data.name);
124 if (($.memberOf != data.name) && $.isStatic){
128 $.isInherited = ($.memberOf != data.name);
140 //if (/@hide/.test($.desc)) {
143 // it's a signleton class - can not have dynamic methods..
144 if (data.isSingleton) {
147 if (($.memberOf != data.name) && $.isStatic){
151 $.isInherited = ($.memberOf != data.alias);
164 method : function(member) {
166 var output = '<a name="' + member.memberOf +'.' + member.name + '"></a>' +
167 '<div class="fixedFont"> <span class="attributes">';
169 if (member.isConstructor) {
173 if (member.isPrivate) output += "<private> ";
174 if (member.isInner) output += "<inner> ";
175 if (member.isStatic || member.isSingleton) { //|| data.comment.getTag("instanceOf").length) {
176 output += member.memberOf + ".";
179 output += '</span><b class="itemname">' + member.name + '</b>';
181 output += this.makeSignature(member.params);
182 if (member.returns && member.returns.length) {
184 for(var i = 0;i< member.returns.length;i++) {
185 var item = member.returns[i];
186 output += (i > 0 ? ' or ' : '') +
187 this.linkSymbol(item.type);
192 output += '</div> <div class="mdesc">';
193 if (!member.isConstructor) {
194 output+= '<div class="short">'+this.resolveLinks(this.summarize(member.desc)) +'</div>';
197 output+= '<div class="short">Create a new '+member.memberOf +'</div>';
199 output +='<div class="long">';
200 if (!member.isConstructor) {
201 output+= this.resolveLinks(member.desc) ;
202 if (member.example.length) {
203 output += '<pre class="code">'+member.example+'</pre>';
207 output+= 'Create a new '+member.memberOf;
208 // example and desc.. are normally on the 'top'...
210 if (member.params.length) {
213 output+= '<dl class="detailList"> <dt class="heading">Parameters:</dt>';
214 for(var i = 0; i < member.params.length ; i++) {
215 var item = member.params[i];
218 '<span class="fixedFont">' + this.linkSymbol(item.type) + '</span> ' :
220 )+ '<b>'+item.name+'</b>';
221 if (item.isOptional) {
222 output+='<i>Optional ';
223 if (item.defaultValue.length) {
224 output+='Default: '+item.defaultValue;
228 output +='</dt><dd>'+this.resolveLinks(item.desc)+'</dd>';
232 if (member.isDeprecated || (member.deprecated && member.deprecated.length)) {
233 output+= '<dl class="detailList"><dt class="heading">Deprecated:</dt><dt>' +
234 +member.deprecated+'</dt></dl>';
238 if (member.since && member.since.length) {
239 output+= '<dl class="detailList"><dt class="heading">Since:</dt><dt>' +
240 +member.since+'</dt></dl>';
243 <if test="member.exceptions.length">
244 <dl class="detailList">
245 <dt class="heading">Throws:</dt>
246 <for each="item" in="member.exceptions">
248 {+((item.type)?"<span class=\"fixedFont\">{"+(new Link().toSymbol(item.type))+"}</span> " : "")+} <b>{+item.name+}</b>
250 <dd>{+resolveLinks(item.desc)+}</dd>
255 if (member.returns && member.returns.length) {
256 output += '<dl class="detailList"><dt class="heading">Returns:</dt>';
257 for (var i =0; i < member.returns.length; i++) {
258 var item = member.returns[i];
259 output+= '<dd>' + this.linkSymbol( item.type ) + ' ' + this.resolveLinks(item.desc) + '</dd></dl>';
265 <if test="member.requires.length">
266 <dl class="detailList">
267 <dt class="heading">Requires:</dt>
268 <for each="item" in="member.requires">
269 <dd>{+ resolveLinks(item) +}</dd>
274 if (member.see && member.see.length) {
275 output+= '<dl class="detailList"><dt class="heading">See:</dt><dt>' +
276 '<dd>' + this.linkSymbol( member.see ) +'</dd></dl>';
278 output +='</div></div>';
284 event : function(member)
288 var output = '<a name="' + member.memberOf +'-event-' + member.name + '"></a>' +
289 '<div class="fixedFont"> ';
292 output += '<b class="itemname">'+member.name+'</b>' +this.makeSignature(member.params) + '</div>';
294 output += '<div class="mdesc">';
295 output += '<div class="short">' +this.resolveLinks(this.summarize(member.desc))+ '</div>';
298 output += '<div class="long">' + this.resolveLinks(member.desc);
300 if (member.example.length) {
301 output +='<pre class="code">'+member.example+'</pre>';
303 if (member.params.length) {
306 output+= '<dl class="detailList"> <dt class="heading">Parameters:</dt>';
307 for(var i = 0; i < member.params.length ; i++) {
308 var item = member.params[i];
311 '<span class="fixedFont">' + this.linkSymbol(item.type) + '</span> ' :
313 )+ '<b>'+item.name+'</b>';
314 if (item.isOptional) {
315 output+='<i>Optional ';
316 if (item.defaultValue.length) {
317 output+='Default: '+item.defaultValue;
321 output +='</dt><dd>'+this.resolveLinks(item.desc)+'</dd>';
325 if ((member.deprecated && member.deprecated.length) || member.isDeprecated) {
326 output+= '<dl class="detailList"><dt class="heading">Deprecated:</dt><dt>' +
327 +member.deprecated+'</dt></dl>';
331 if (member.since && member.since.length) {
332 output+= '<dl class="detailList"><dt class="heading">Since:</dt><dt>' +
333 +member.since+'</dt></dl>';
336 <if test="member.exceptions.length">
337 <dl class="detailList">
338 <dt class="heading">Throws:</dt>
339 <for each="item" in="member.exceptions">
341 {+((item.type)?"<span class=\"fixedFont\">{"+(new Link().toSymbol(item.type))+"}</span> " : "")+} <b>{+item.name+}</b>
343 <dd>{+resolveLinks(item.desc)+}</dd>
348 if (member.returns && member.returns.length) {
349 output += '<dl class="detailList"><dt class="heading">Returns:</dt>';
350 for (var i =0; i < member.returns.length; i++) {
351 var item = member.returns[i];
352 output+= '<dd>' + this.linkSymbol( item.type ) + ' ' + this.resolveLinks(item.desc) + '</dd></dl>';
358 <if test="member.requires.length">
359 <dl class="detailList">
360 <dt class="heading">Requires:</dt>
361 <for each="item" in="member.requires">
362 <dd>{+ resolveLinks(item) +}</dd>
367 if (member.see && member.see.length) {
368 output+= '<dl class="detailList"><dt class="heading">See:</dt><dt>' +
369 '<dd>' + this.linkSymbol( member.see ) +'</dd></dl>';
371 output +='</div></div>';
385 makeSignature : function(params)
388 if (!params.length) return "()";
389 var linkSymbol = this.linkSymbol;
390 var signature = " (" +
393 return $.name.indexOf(".") == -1; // don't show config params in signature
397 $.defaultValue = typeof($.defaultValue) == 'undefined' ? false : $.defaultValue;
400 ($.isOptional ? "[" : "") +
403 (typeof($.type) == 'object' ) ? 'Function' : $.type
406 "<B><i>" +$.name + "</i></B>" +
407 ($.defaultValue ? "=" +item.defaultValue : "") +
408 ($.isOptional ? "]" : "");
418 resolveLinks : function(str)
420 if (!str || typeof(str) == 'undefined') {
424 // gtk specific. now..
425 // @ -> bold.. - they are arguments..
427 str = str.replace(/@([a-z_]+)/gi,
428 function(match, symbolName) {
429 return '<b>' + symbolName + '</b>';
433 str = str.replace(/%([a-z_]+)/gi,
434 function(match, symbolName) {
435 return '<b>' + symbolName + '</b>';
439 str = str.replace(/#([a-z_]+)/gi,
440 function(match, symbolName) {
441 return '<b>' + symbolName + '</b>';
442 // this should do a lookup!!!!
443 /// it could use data in the signature to find out..
444 //return new Link().toSymbol(Template.data.ns + '.' + symbolName);
448 //Roo.log(JSON.stringify(str));
449 str = str.replace(/[ \t]+\n/gi, '\n');
450 str = str.replace(/\n\n+/gi, '<br/><br/>');
451 //str = str.replace(/\n/gi, '<br/>');
452 var linkSymbol = this.linkSymbol;
453 str = str.replace(/\{@link ([^} ]+) ?\}/gi,
454 function(match, symbolName) {
455 return linkSymbol(symbolName);
461 summarize : function(desc)
463 if (typeof desc != "undefined") {
464 // finds the first fulls stop... (and we remove '<' html...)
465 return desc.match(/([\w\W]+?[\.|:])[^a-z0-9]/i)?
466 RegExp.$1.split('<')[0].replace("\n", " ") : desc.split("\n")[0];
470 linkSymbol : function(str)
473 var ar = str.split('<');
475 for(var i = ar.length-1; i > -1; i--) {
476 var bit = ar[i].split('>').shift();
478 out = '<' + out + '>';
480 out = '<span class=\"fixedFont\"><a href="#' + bit+ '">' + bit + '</a>' + out + '</span>';
485 makeSortby : function(attribute) {
486 return function(a, b) {
487 if (a[attribute] != undefined && b[attribute] != undefined) {
488 a = a[attribute]; //.toLowerCase();
489 b = b[attribute];//.toLowerCase();
490 if (a < b) return -1;