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 config : function(dtag)
45 var output = '<a name="'+dtag.memberOf+'-cfg-'+dtag.name+'"></a>';
46 output += '<div class="fixedFont"><b class="itemname"> ' + dtag.name + '</b> : ' +
47 (dtag.type.length ? this.linkSymbol(dtag.type) : "" ) + '</div>';
49 output += '<div class="mdesc"><div class="short">'+this.resolveLinks(this.summarize(dtag.desc))+'</div></div>';
51 output += '<div class="mdesc"><div class="long">' + this.resolveLinks(dtag.desc)+ ' ' +
52 (dtag.values && dtag.values.length ? ("<BR/>Possible Values: " +
53 dtag.values.map(function(v) {
54 return v.length ? v : "<B>Empty</B>";
57 Roo.log(JSON.stringify(output));
61 methodsSort : function(data)
67 if (data.name.length &&
73 data.isInherited = false;
74 data.isConstructor = true;
75 ownMethods.push(data); // should push ctor???
78 var msorted = data.methods.sort(this.makeSortby("name"));
88 if (data.isSingleton) {
90 if ($.isStatic && $.memberOf != data.name) { // it's a singleton - can not inherit static methods.
94 $.isInherited = ($.memberOf != data.name);
100 if (($.memberOf != data.name) && $.isStatic){
104 $.isInherited = ($.memberOf != data.name);
116 //if (/@hide/.test($.desc)) {
119 // it's a signleton class - can not have dynamic methods..
120 if (data.isSingleton) {
123 if (($.memberOf != data.name) && $.isStatic){
127 $.isInherited = ($.memberOf != data.alias);
140 method : function(member) {
142 var output = '<a name="' + member.memberOf +'.' + member.name + '"></a>' +
143 '<div class="fixedFont"> <span class="attributes">';
145 if (member.isConstructor) {
149 if (member.isPrivate) output += "<private> ";
150 if (member.isInner) output += "<inner> ";
151 if (member.isStatic || member.isSingleton) { //|| data.comment.getTag("instanceOf").length) {
152 output += member.memberOf + ".";
155 output += '</span><b class="itemname">' + member.name + '</b>';
157 output += this.makeSignature(member.params);
158 if (member.returns && member.returns.length) {
160 for(var i = 0;i< member.returns.length;i++) {
161 var item = member.returns[i];
162 output += (i > 0 ? ' or ' : '') +
163 this.linkSymbol(item.type);
168 output += '</div> <div class="mdesc">';
169 if (!member.isConstructor) {
170 output+= '<div class="short">'+this.resolveLinks(this.summarize(member.desc)) +'</div>';
173 output+= '<div class="short">Create a new '+member.memberOf +'</div>';
175 output +='<div class="long">';
176 if (!member.isConstructor) {
177 output+= this.resolveLinks(member.desc) ;
178 if (member.example.length) {
179 output += '<pre class="code">'+member.example+'</pre>';
183 output+= 'Create a new '+member.memberOf;
184 // example and desc.. are normally on the 'top'...
186 if (member.params.length) {
189 output+= '<dl class="detailList"> <dt class="heading">Parameters:</dt>';
190 for(var i = 0; i < member.params.length ; i++) {
191 var item = member.params[i];
194 '<span class="fixedFont">' + this.linkSymbol(item.type) + '</span> ' :
196 )+ '<b>'+item.name+'</b>';
197 if (item.isOptional) {
198 output+='<i>Optional ';
199 if (item.defaultValue.length) {
200 output+='Default: '+item.defaultValue;
204 output +='</dt><dd>'+this.resolveLinks(item.desc)+'</dd>';
208 if (member.isDeprecated || (member.deprecated && member.deprecated.length)) {
209 output+= '<dl class="detailList"><dt class="heading">Deprecated:</dt><dt>' +
210 +member.deprecated+'</dt></dl>';
214 if (member.since && member.since.length) {
215 output+= '<dl class="detailList"><dt class="heading">Since:</dt><dt>' +
216 +member.since+'</dt></dl>';
219 <if test="member.exceptions.length">
220 <dl class="detailList">
221 <dt class="heading">Throws:</dt>
222 <for each="item" in="member.exceptions">
224 {+((item.type)?"<span class=\"fixedFont\">{"+(new Link().toSymbol(item.type))+"}</span> " : "")+} <b>{+item.name+}</b>
226 <dd>{+resolveLinks(item.desc)+}</dd>
231 if (member.returns && member.returns.length) {
232 output += '<dl class="detailList"><dt class="heading">Returns:</dt>';
233 for (var i =0; i < member.returns.length; i++) {
234 var item = member.returns[i];
235 output+= '<dd>' + this.linkSymbol( item.type ) + ' ' + this.resolveLinks(item.desc) + '</dd></dl>';
241 <if test="member.requires.length">
242 <dl class="detailList">
243 <dt class="heading">Requires:</dt>
244 <for each="item" in="member.requires">
245 <dd>{+ resolveLinks(item) +}</dd>
250 if (member.see && member.see.length) {
251 output+= '<dl class="detailList"><dt class="heading">See:</dt><dt>' +
252 '<dd>' + this.linkSymbol( member.see ) +'</dd></dl>';
254 output +='</div></div>';
260 event : function(member)
264 var output = '<a name="' + member.memberOf +'-event-' + member.name + '"></a>' +
265 '<div class="fixedFont"> ';
268 output += '<b class="itemname">'+member.name+'</b>' +this.makeSignature(member.params) + '</div>';
270 output += '<div class="mdesc">';
271 output += '<div class="short">' +this.resolveLinks(this.summarize(member.desc))+ '</div>';
274 output += '<div class="long">' + this.resolveLinks(member.desc);
276 if (member.example.length) {
277 output +='<pre class="code">'+member.example+'</pre>';
279 if (member.params.length) {
282 output+= '<dl class="detailList"> <dt class="heading">Parameters:</dt>';
283 for(var i = 0; i < member.params.length ; i++) {
284 var item = member.params[i];
287 '<span class="fixedFont">' + this.linkSymbol(item.type) + '</span> ' :
289 )+ '<b>'+item.name+'</b>';
290 if (item.isOptional) {
291 output+='<i>Optional ';
292 if (item.defaultValue.length) {
293 output+='Default: '+item.defaultValue;
297 output +='</dt><dd>'+this.resolveLinks(item.desc)+'</dd>';
301 if ((member.deprecated && member.deprecated.length) || member.isDeprecated) {
302 output+= '<dl class="detailList"><dt class="heading">Deprecated:</dt><dt>' +
303 +member.deprecated+'</dt></dl>';
307 if (member.since && member.since.length) {
308 output+= '<dl class="detailList"><dt class="heading">Since:</dt><dt>' +
309 +member.since+'</dt></dl>';
312 <if test="member.exceptions.length">
313 <dl class="detailList">
314 <dt class="heading">Throws:</dt>
315 <for each="item" in="member.exceptions">
317 {+((item.type)?"<span class=\"fixedFont\">{"+(new Link().toSymbol(item.type))+"}</span> " : "")+} <b>{+item.name+}</b>
319 <dd>{+resolveLinks(item.desc)+}</dd>
324 if (member.returns && member.returns.length) {
325 output += '<dl class="detailList"><dt class="heading">Returns:</dt>';
326 for (var i =0; i < member.returns.length; i++) {
327 var item = member.returns[i];
328 output+= '<dd>' + this.linkSymbol( item.type ) + ' ' + this.resolveLinks(item.desc) + '</dd></dl>';
334 <if test="member.requires.length">
335 <dl class="detailList">
336 <dt class="heading">Requires:</dt>
337 <for each="item" in="member.requires">
338 <dd>{+ resolveLinks(item) +}</dd>
343 if (member.see && member.see.length) {
344 output+= '<dl class="detailList"><dt class="heading">See:</dt><dt>' +
345 '<dd>' + this.linkSymbol( member.see ) +'</dd></dl>';
347 output +='</div></div>';
361 makeSignature : function(params)
364 if (!params.length) return "()";
365 var linkSymbol = this.linkSymbol;
366 var signature = " (" +
369 return $.name.indexOf(".") == -1; // don't show config params in signature
373 $.defaultValue = typeof($.defaultValue) == 'undefined' ? false : $.defaultValue;
376 ($.isOptional ? "[" : "") +
379 (typeof($.type) == 'object' ) ? 'Function' : $.type
382 "<B><i>" +$.name + "</i></B>" +
383 ($.defaultValue ? "=" +item.defaultValue : "") +
384 ($.isOptional ? "]" : "");
394 resolveLinks : function(str)
396 if (!str || typeof(str) == 'undefined') {
400 // gtk specific. now..
401 // @ -> bold.. - they are arguments..
403 str = str.replace(/@([a-z_]+)/gi,
404 function(match, symbolName) {
405 return '<b>' + symbolName + '</b>';
409 str = str.replace(/%([a-z_]+)/gi,
410 function(match, symbolName) {
411 return '<b>' + symbolName + '</b>';
415 str = str.replace(/#([a-z_]+)/gi,
416 function(match, symbolName) {
417 return '<b>' + symbolName + '</b>';
418 // this should do a lookup!!!!
419 /// it could use data in the signature to find out..
420 //return new Link().toSymbol(Template.data.ns + '.' + symbolName);
424 //Roo.log(JSON.stringify(str));
425 str = str.replace(/[ \t]+\n/gi, '\n');
426 str = str.replace(/\n\n+/gi, '<br/><br/>');
427 //str = str.replace(/\n/gi, '<br/>');
428 var linkSymbol = this.linkSymbol;
429 str = str.replace(/\{@link ([^} ]+) ?\}/gi,
430 function(match, symbolName) {
431 return linkSymbol(symbolName);
437 summarize : function(desc)
439 if (typeof desc != "undefined") {
440 // finds the first fulls stop... (and we remove '<' html...)
441 return desc.match(/([\w\W]+?[\.|:])[^a-z0-9]/i)?
442 RegExp.$1.split('<')[0].replace("\n", " ") : desc.split("\n")[0];
446 linkSymbol : function(str)
449 var ar = str.split('<');
451 for(var i = ar.length-1; i > -1; i--) {
452 var bit = ar[0].split('>').pop();
454 out = '<' + out + '>';
456 out = '<span class=\"fixedFont\"><a href="#' + bit+ '">' + bit + '</a>' + out + '</span>';
459 return '<span class=\"fixedFont\"><a href="#' + str + '">' + str + '</a></span>';
461 makeSortby : function(attribute) {
462 return function(a, b) {
463 if (a[attribute] != undefined && b[attribute] != undefined) {
464 a = a[attribute]; //.toLowerCase();
465 b = b[attribute];//.toLowerCase();
466 if (a < b) return -1;