1 <html><head><title>../roojs1/roojs-doc-debug.js</title><link rel="stylesheet" type="text/css" href="../../../css/highlight-js.css"/></head><body class="highlightpage"><code class="jsdoc-pretty"><span class="jsdoc-comment">/*
4 * Documentation - designed to generate HTML+Docbook!?!
6 </span><span class="jsdoc-var">Roo.doc </span><span class="jsdoc-syntax">= </span><span class="jsdoc-var">Roo.doc </span><span class="jsdoc-syntax">|| {};
8 </span><span class="jsdoc-comment">/**
10 * @extends Roo.bootstrap.Component
11 * Entry Element class - describes a method etc...
12 * @cfg name {String} name of method
13 * @cfg purpose {String} short description of method.
17 * @param {Object} config The config object
22 </span><span class="jsdoc-var">Roo.doc.Entry </span><span class="jsdoc-syntax">= </span><span class="jsdoc-keyword">function</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">config</span><span class="jsdoc-syntax">){
23 </span><span class="jsdoc-var">Roo.doc.Entry.superclass.constructor.call</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">this</span><span class="jsdoc-syntax">, </span><span class="jsdoc-var">config</span><span class="jsdoc-syntax">);
24 </span><span class="jsdoc-comment">//this.el = Roo.get(document.body);
26 var body = Roo.get(document.body);
36 // call onRender once... and block next call...?
39 //this.onRender = function() { };
42 </span><span class="jsdoc-syntax">};
44 </span><span class="jsdoc-comment">//Roo.doc.Entry._calls = 0;
46 </span><span class="jsdoc-var">Roo.extend</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">Roo.doc.Entry</span><span class="jsdoc-syntax">, </span><span class="jsdoc-var">Roo.bootstrap.Component</span><span class="jsdoc-syntax">, {
49 </span><span class="jsdoc-var">name </span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">''</span><span class="jsdoc-syntax">,
50 </span><span class="jsdoc-var">purpose </span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">''</span><span class="jsdoc-syntax">,
52 </span><span class="jsdoc-var">getAutoCreate </span><span class="jsdoc-syntax">: </span><span class="jsdoc-keyword">function</span><span class="jsdoc-syntax">(){
54 </span><span class="jsdoc-keyword">var </span><span class="jsdoc-var">cfg </span><span class="jsdoc-syntax">={
55 </span><span class="jsdoc-var">cls </span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'refentry'</span><span class="jsdoc-syntax">,
56 </span><span class="jsdoc-var">cn </span><span class="jsdoc-syntax">: [
58 </span><span class="jsdoc-var">tag</span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'h1'</span><span class="jsdoc-syntax">,
59 </span><span class="jsdoc-var">cls</span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'refname'</span><span class="jsdoc-syntax">,
60 </span><span class="jsdoc-var">html </span><span class="jsdoc-syntax">: </span><span class="jsdoc-var">this.name
61 </span><span class="jsdoc-syntax">},
63 </span><span class="jsdoc-var">cls</span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'refnamediv'</span><span class="jsdoc-syntax">,
64 </span><span class="jsdoc-var">html </span><span class="jsdoc-syntax">: </span><span class="jsdoc-var">this.purpose
65 </span><span class="jsdoc-syntax">}
70 </span><span class="jsdoc-keyword">return </span><span class="jsdoc-var">cfg</span><span class="jsdoc-syntax">;
73 </span><span class="jsdoc-var">addxtype </span><span class="jsdoc-syntax">: </span><span class="jsdoc-keyword">function </span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">tree</span><span class="jsdoc-syntax">, </span><span class="jsdoc-var">cntr</span><span class="jsdoc-syntax">)
75 </span><span class="jsdoc-keyword">return </span><span class="jsdoc-var">this.addxtypeChild</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">tree</span><span class="jsdoc-syntax">,</span><span class="jsdoc-var">cntr</span><span class="jsdoc-syntax">);
77 </span><span class="jsdoc-comment">/*
78 onRender : function(ct, position)
81 Roo.doc.Entry._calls++;
82 if (Roo.doc.Entry._calls > 1 || !ct) {
86 // call onRender once... and block next call...?
88 Roo.bootstrap.Component.prototype.onRender.call(this, ct, position);
92 </span><span class="jsdoc-syntax">});
96 </span><span class="jsdoc-comment">/*
102 * @class Roo.doc.Example
103 * @extends Roo.bootstrap.Component
104 * Example Element class
105 * @cfg {String} title short title describing example
106 * @cfg {String} lang (php|txt|sql) code language.
107 * @cfg {String} code example code
108 * @cfg {String} output The expected output from the code
109 * @cfg {String} outputlang php|txt|sql) output language
113 * Create a new Synopsis
114 * @param {Object} config The config object
117 </span><span class="jsdoc-var">Roo.doc.Example </span><span class="jsdoc-syntax">= </span><span class="jsdoc-keyword">function</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">config</span><span class="jsdoc-syntax">){
118 </span><span class="jsdoc-var">Roo.doc.Example.superclass.constructor.call</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">this</span><span class="jsdoc-syntax">, </span><span class="jsdoc-var">config</span><span class="jsdoc-syntax">);
121 </span><span class="jsdoc-var">Roo.extend</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">Roo.doc.Example</span><span class="jsdoc-syntax">, </span><span class="jsdoc-var">Roo.bootstrap.Component</span><span class="jsdoc-syntax">, {
123 </span><span class="jsdoc-var">title </span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">''</span><span class="jsdoc-syntax">,
124 </span><span class="jsdoc-var">lang</span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'php'</span><span class="jsdoc-syntax">,
125 </span><span class="jsdoc-var">code </span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">''</span><span class="jsdoc-syntax">,
126 </span><span class="jsdoc-var">output </span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">''</span><span class="jsdoc-syntax">,
127 </span><span class="jsdoc-var">outputlang </span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'txt'</span><span class="jsdoc-syntax">,
129 </span><span class="jsdoc-var">getAutoCreate </span><span class="jsdoc-syntax">: </span><span class="jsdoc-keyword">function</span><span class="jsdoc-syntax">(){
131 </span><span class="jsdoc-comment">// no colour highlighting in here....
133 </span><span class="jsdoc-keyword">var </span><span class="jsdoc-var">code </span><span class="jsdoc-syntax">= </span><span class="jsdoc-var">hljs </span><span class="jsdoc-syntax">? </span><span class="jsdoc-var">hljs.highlight</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">this.lang</span><span class="jsdoc-syntax">,</span><span class="jsdoc-var">this.code</span><span class="jsdoc-syntax">)</span><span class="jsdoc-var">.value </span><span class="jsdoc-syntax">:
134 </span><span class="jsdoc-var">String.format</span><span class="jsdoc-syntax">(</span><span class="jsdoc-string">'{0}'</span><span class="jsdoc-syntax">,</span><span class="jsdoc-var">this.code</span><span class="jsdoc-syntax">)</span><span class="jsdoc-var">.replace</span><span class="jsdoc-syntax">(/\n/g, </span><span class="jsdoc-string">'<br/>'</span><span class="jsdoc-syntax">);
136 </span><span class="jsdoc-var">Roo.log</span><span class="jsdoc-syntax">(</span><span class="jsdoc-string">"code=" </span><span class="jsdoc-syntax">+ </span><span class="jsdoc-var">code</span><span class="jsdoc-syntax">);
137 </span><span class="jsdoc-keyword">var </span><span class="jsdoc-var">cfg </span><span class="jsdoc-syntax">={
138 </span><span class="jsdoc-var">cls </span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'panel panel-info'</span><span class="jsdoc-syntax">,
139 </span><span class="jsdoc-var">cn </span><span class="jsdoc-syntax">: [
141 </span><span class="jsdoc-var">cls </span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'panel-heading'</span><span class="jsdoc-syntax">,
142 </span><span class="jsdoc-var">html </span><span class="jsdoc-syntax">: </span><span class="jsdoc-var">this.title
143 </span><span class="jsdoc-syntax">},
145 </span><span class="jsdoc-var">cls </span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'panel-body'</span><span class="jsdoc-syntax">,
146 </span><span class="jsdoc-var">cn </span><span class="jsdoc-syntax">: [
148 </span><span class="jsdoc-var">tag</span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'pre'</span><span class="jsdoc-syntax">,
149 </span><span class="jsdoc-var">cls </span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'lang-' </span><span class="jsdoc-syntax">+ </span><span class="jsdoc-var">this.lang</span><span class="jsdoc-syntax">,
150 </span><span class="jsdoc-var">html </span><span class="jsdoc-syntax">: </span><span class="jsdoc-var">code
151 </span><span class="jsdoc-syntax">}
157 </span><span class="jsdoc-keyword">if </span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">this.output</span><span class="jsdoc-syntax">) {
159 </span><span class="jsdoc-keyword">var </span><span class="jsdoc-var">out </span><span class="jsdoc-syntax">= </span><span class="jsdoc-var">hljs </span><span class="jsdoc-syntax">? </span><span class="jsdoc-var">hljs.highlight</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">this.outputlang</span><span class="jsdoc-syntax">,</span><span class="jsdoc-var">this.output</span><span class="jsdoc-syntax">)</span><span class="jsdoc-var">.value </span><span class="jsdoc-syntax">:
160 </span><span class="jsdoc-var">String.format</span><span class="jsdoc-syntax">(</span><span class="jsdoc-string">'{0}'</span><span class="jsdoc-syntax">,</span><span class="jsdoc-var">this.output</span><span class="jsdoc-syntax">)</span><span class="jsdoc-var">.replace</span><span class="jsdoc-syntax">(/\n/g, </span><span class="jsdoc-string">'<br/>'</span><span class="jsdoc-syntax">);
161 </span><span class="jsdoc-var">cfg.cn.push</span><span class="jsdoc-syntax">(
164 </span><span class="jsdoc-var">cls </span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'panel-footer'</span><span class="jsdoc-syntax">,
165 </span><span class="jsdoc-var">cn </span><span class="jsdoc-syntax">: {
166 </span><span class="jsdoc-var">tag</span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'pre'</span><span class="jsdoc-syntax">,
167 </span><span class="jsdoc-var">html </span><span class="jsdoc-syntax">: </span><span class="jsdoc-var">out
168 </span><span class="jsdoc-syntax">}
177 </span><span class="jsdoc-keyword">return </span><span class="jsdoc-var">cfg</span><span class="jsdoc-syntax">;
187 </span><span class="jsdoc-comment">/*
193 * @class Roo.doc.Para
194 * @extends Roo.bootstrap.Component
195 * Param Element class
199 * Create a new Paragraph
200 * @param {Object} config The config object
203 </span><span class="jsdoc-var">Roo.doc.Para </span><span class="jsdoc-syntax">= </span><span class="jsdoc-keyword">function</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">config</span><span class="jsdoc-syntax">){
204 </span><span class="jsdoc-var">Roo.doc.Para.superclass.constructor.call</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">this</span><span class="jsdoc-syntax">, </span><span class="jsdoc-var">config</span><span class="jsdoc-syntax">);
207 </span><span class="jsdoc-var">Roo.extend</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">Roo.doc.Para</span><span class="jsdoc-syntax">, </span><span class="jsdoc-var">Roo.bootstrap.Component</span><span class="jsdoc-syntax">, {
209 </span><span class="jsdoc-var">html </span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">''</span><span class="jsdoc-syntax">,
210 </span><span class="jsdoc-var">getAutoCreate </span><span class="jsdoc-syntax">: </span><span class="jsdoc-keyword">function</span><span class="jsdoc-syntax">(){
212 </span><span class="jsdoc-comment">//?? this is the synopsis type....
214 // this is not very fancy...
216 </span><span class="jsdoc-keyword">var </span><span class="jsdoc-var">cfg </span><span class="jsdoc-syntax">={
217 </span><span class="jsdoc-var">tag</span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'p'</span><span class="jsdoc-syntax">,
218 </span><span class="jsdoc-var">cls</span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'para'</span><span class="jsdoc-syntax">,
219 </span><span class="jsdoc-var">html </span><span class="jsdoc-syntax">: </span><span class="jsdoc-var">Roo.Markdown.toHtml</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">this.html</span><span class="jsdoc-syntax">)
222 </span><span class="jsdoc-keyword">if </span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">this.parent</span><span class="jsdoc-syntax">()</span><span class="jsdoc-var">.is_list</span><span class="jsdoc-syntax">) {
223 </span><span class="jsdoc-keyword">return </span><span class="jsdoc-syntax">{
224 </span><span class="jsdoc-var">tag</span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'li'</span><span class="jsdoc-syntax">,
225 </span><span class="jsdoc-var">cls </span><span class="jsdoc-syntax">: </span><span class="jsdoc-var">listitme</span><span class="jsdoc-syntax">,
226 </span><span class="jsdoc-var">cn </span><span class="jsdoc-syntax">: [ </span><span class="jsdoc-var">cfg </span><span class="jsdoc-syntax">]
231 </span><span class="jsdoc-keyword">return </span><span class="jsdoc-var">cfg</span><span class="jsdoc-syntax">;
243 </span><span class="jsdoc-comment">/*
249 * @class Roo.doc.Param
250 * @extends Roo.bootstrap.Component
251 * Param Element class
252 * @cfg {bool} is_optional is the argument optional
253 * @cfg {String} type argument type
254 * @cfg {String} name name of the parameter
255 * @cfg {String} desc short description
256 * @cfg {String} defaultvalue default value
260 * @param {Object} config The config object
263 </span><span class="jsdoc-var">Roo.doc.Param </span><span class="jsdoc-syntax">= </span><span class="jsdoc-keyword">function</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">config</span><span class="jsdoc-syntax">){
264 </span><span class="jsdoc-var">Roo.doc.Param.superclass.constructor.call</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">this</span><span class="jsdoc-syntax">, </span><span class="jsdoc-var">config</span><span class="jsdoc-syntax">);
267 </span><span class="jsdoc-var">Roo.extend</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">Roo.doc.Param</span><span class="jsdoc-syntax">, </span><span class="jsdoc-var">Roo.bootstrap.Component</span><span class="jsdoc-syntax">, {
269 </span><span class="jsdoc-var">is_optional </span><span class="jsdoc-syntax">: </span><span class="jsdoc-keyword">false</span><span class="jsdoc-syntax">,
270 </span><span class="jsdoc-var">type </span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">''</span><span class="jsdoc-syntax">,
271 </span><span class="jsdoc-var">name</span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">''</span><span class="jsdoc-syntax">,
272 </span><span class="jsdoc-var">defaultvalue</span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">''</span><span class="jsdoc-syntax">,
273 </span><span class="jsdoc-var">desc</span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">''</span><span class="jsdoc-syntax">,
275 </span><span class="jsdoc-var">getAutoCreate </span><span class="jsdoc-syntax">: </span><span class="jsdoc-keyword">function</span><span class="jsdoc-syntax">(){
277 </span><span class="jsdoc-comment">//?? this is the synopsis type....
279 </span><span class="jsdoc-keyword">var </span><span class="jsdoc-var">desc </span><span class="jsdoc-syntax">= </span><span class="jsdoc-var">Roo.Markdown.toHtml</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">this.desc</span><span class="jsdoc-syntax">);
281 </span><span class="jsdoc-keyword">if </span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">this.parent</span><span class="jsdoc-syntax">()</span><span class="jsdoc-var">.stype </span><span class="jsdoc-syntax">== </span><span class="jsdoc-string">'parameter'</span><span class="jsdoc-syntax">) {
283 </span><span class="jsdoc-keyword">return </span><span class="jsdoc-syntax">{
284 </span><span class="jsdoc-var">tag </span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'li'</span><span class="jsdoc-syntax">,
285 </span><span class="jsdoc-var">cn </span><span class="jsdoc-syntax">: [
287 </span><span class="jsdoc-var">tag </span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'p'</span><span class="jsdoc-syntax">,
288 </span><span class="jsdoc-var">cls</span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'para'</span><span class="jsdoc-syntax">,
289 </span><span class="jsdoc-var">cn </span><span class="jsdoc-syntax">: [
291 </span><span class="jsdoc-var">tag</span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'code'</span><span class="jsdoc-syntax">,
292 </span><span class="jsdoc-var">html </span><span class="jsdoc-syntax">: </span><span class="jsdoc-var">this.type </span><span class="jsdoc-syntax">+ </span><span class="jsdoc-string">' ' </span><span class="jsdoc-syntax">+ </span><span class="jsdoc-var">this.name
293 </span><span class="jsdoc-syntax">},
294 </span><span class="jsdoc-var">desc
295 </span><span class="jsdoc-syntax">]
301 </span><span class="jsdoc-keyword">if </span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">this.parent</span><span class="jsdoc-syntax">()</span><span class="jsdoc-var">.stype </span><span class="jsdoc-syntax">== </span><span class="jsdoc-string">'return'</span><span class="jsdoc-syntax">) {
302 </span><span class="jsdoc-keyword">return </span><span class="jsdoc-syntax">{
303 </span><span class="jsdoc-var">tag </span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'p'</span><span class="jsdoc-syntax">,
304 </span><span class="jsdoc-var">cls</span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'para'</span><span class="jsdoc-syntax">,
305 </span><span class="jsdoc-var">cn </span><span class="jsdoc-syntax">: [
307 </span><span class="jsdoc-var">tag</span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'code'</span><span class="jsdoc-syntax">,
308 </span><span class="jsdoc-var">html </span><span class="jsdoc-syntax">: </span><span class="jsdoc-var">this.type
309 </span><span class="jsdoc-syntax">},
310 </span><span class="jsdoc-var">desc
311 </span><span class="jsdoc-syntax">]
318 </span><span class="jsdoc-comment">// this is not very fancy...
320 </span><span class="jsdoc-keyword">var </span><span class="jsdoc-var">cfg </span><span class="jsdoc-syntax">={
321 </span><span class="jsdoc-var">tag</span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'span'</span><span class="jsdoc-syntax">,
322 </span><span class="jsdoc-var">cn </span><span class="jsdoc-syntax">: [
323 </span><span class="jsdoc-var">this.is_optional </span><span class="jsdoc-syntax">? </span><span class="jsdoc-string">'[' </span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">''</span><span class="jsdoc-syntax">,
324 </span><span class="jsdoc-var">this.type</span><span class="jsdoc-syntax">,
325 </span><span class="jsdoc-string">' '</span><span class="jsdoc-syntax">,
327 </span><span class="jsdoc-var">tag </span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'b'</span><span class="jsdoc-syntax">,
328 </span><span class="jsdoc-var">html </span><span class="jsdoc-syntax">: </span><span class="jsdoc-var">this.name
329 </span><span class="jsdoc-syntax">},
330 </span><span class="jsdoc-var">this.defaultvalue </span><span class="jsdoc-syntax">== </span><span class="jsdoc-string">'' </span><span class="jsdoc-syntax">? </span><span class="jsdoc-string">'' </span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">' = '</span><span class="jsdoc-syntax">,
331 </span><span class="jsdoc-var">this.defaultvalue</span><span class="jsdoc-syntax">,
332 </span><span class="jsdoc-var">this.is_optional </span><span class="jsdoc-syntax">? </span><span class="jsdoc-string">']' </span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">''</span><span class="jsdoc-syntax">,
333 </span><span class="jsdoc-string">',' </span><span class="jsdoc-comment">// not really.. but let's do it anyway...
334 </span><span class="jsdoc-syntax">]
340 </span><span class="jsdoc-keyword">return </span><span class="jsdoc-var">cfg</span><span class="jsdoc-syntax">;
342 </span><span class="jsdoc-var">getAutoCreateParamSection </span><span class="jsdoc-syntax">: </span><span class="jsdoc-keyword">function</span><span class="jsdoc-syntax">()
344 </span><span class="jsdoc-keyword">var </span><span class="jsdoc-var">desc </span><span class="jsdoc-syntax">= </span><span class="jsdoc-var">Roo.Markdown.toHtml</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">this.desc</span><span class="jsdoc-syntax">);
347 </span><span class="jsdoc-keyword">return </span><span class="jsdoc-syntax">{
348 </span><span class="jsdoc-var">tag </span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'li'</span><span class="jsdoc-syntax">,
349 </span><span class="jsdoc-var">cn </span><span class="jsdoc-syntax">: [
351 </span><span class="jsdoc-var">tag </span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'p'</span><span class="jsdoc-syntax">,
352 </span><span class="jsdoc-var">cls</span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'para'</span><span class="jsdoc-syntax">,
353 </span><span class="jsdoc-var">cn </span><span class="jsdoc-syntax">: [
355 </span><span class="jsdoc-var">tag</span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'code'</span><span class="jsdoc-syntax">,
356 </span><span class="jsdoc-var">html </span><span class="jsdoc-syntax">: </span><span class="jsdoc-var">this.type </span><span class="jsdoc-syntax">+ </span><span class="jsdoc-string">' ' </span><span class="jsdoc-syntax">+ </span><span class="jsdoc-var">this.name
357 </span><span class="jsdoc-syntax">},
358 </span><span class="jsdoc-var">desc
359 </span><span class="jsdoc-syntax">]
377 </span><span class="jsdoc-comment">/*
383 * @class Roo.doc.Section
384 * @extends Roo.bootstrap.Component
385 * SectionElement class
386 * @cfg {String} stype (desc|parameter|return|note|example) section type.
389 * Create a new Synopsis
390 * @param {Object} config The config object
393 </span><span class="jsdoc-var">Roo.doc.Section </span><span class="jsdoc-syntax">= </span><span class="jsdoc-keyword">function</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">config</span><span class="jsdoc-syntax">){
394 </span><span class="jsdoc-var">Roo.doc.Section.superclass.constructor.call</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">this</span><span class="jsdoc-syntax">, </span><span class="jsdoc-var">config</span><span class="jsdoc-syntax">);
397 </span><span class="jsdoc-var">Roo.extend</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">Roo.doc.Section</span><span class="jsdoc-syntax">, </span><span class="jsdoc-var">Roo.bootstrap.Component</span><span class="jsdoc-syntax">, {
400 </span><span class="jsdoc-var">stype</span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">''</span><span class="jsdoc-syntax">,
402 </span><span class="jsdoc-var">getAutoCreate </span><span class="jsdoc-syntax">: </span><span class="jsdoc-keyword">function</span><span class="jsdoc-syntax">(){
405 </span><span class="jsdoc-keyword">var </span><span class="jsdoc-var">syn </span><span class="jsdoc-syntax">= </span><span class="jsdoc-var">Roo.factory</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">this.parent</span><span class="jsdoc-syntax">()</span><span class="jsdoc-var">.items</span><span class="jsdoc-syntax">[0]);
407 </span><span class="jsdoc-keyword">var </span><span class="jsdoc-var">cfg </span><span class="jsdoc-syntax">={
409 </span><span class="jsdoc-var">cls </span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'refsection'</span><span class="jsdoc-syntax">,
410 </span><span class="jsdoc-comment">// id... ?
411 </span><span class="jsdoc-var">cn </span><span class="jsdoc-syntax">: [
413 </span><span class="jsdoc-var">tag</span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'h3'</span><span class="jsdoc-syntax">,
414 </span><span class="jsdoc-var">cls </span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'title'</span><span class="jsdoc-syntax">,
415 </span><span class="jsdoc-var">html </span><span class="jsdoc-syntax">: </span><span class="jsdoc-var">Roo.doc.Section.map</span><span class="jsdoc-syntax">[</span><span class="jsdoc-var">this.stype</span><span class="jsdoc-syntax">]
419 </span><span class="jsdoc-keyword">if </span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">this.stype </span><span class="jsdoc-syntax">== </span><span class="jsdoc-string">'parameter'</span><span class="jsdoc-syntax">) {
421 </span><span class="jsdoc-comment">// db package uses variable list here... - it results in dd/dl but the layout is messed up..
423 </span><span class="jsdoc-keyword">var </span><span class="jsdoc-var">ul </span><span class="jsdoc-syntax">= {
424 </span><span class="jsdoc-var">tag</span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'ul'</span><span class="jsdoc-syntax">,
425 </span><span class="jsdoc-var">cls</span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'itemizedlist roo-params'</span><span class="jsdoc-syntax">,
426 </span><span class="jsdoc-var">cn </span><span class="jsdoc-syntax">: []
428 </span><span class="jsdoc-comment">// might not have any..
429 </span><span class="jsdoc-keyword">var </span><span class="jsdoc-var">params </span><span class="jsdoc-syntax">= </span><span class="jsdoc-var">syn.items</span><span class="jsdoc-syntax">;
430 </span><span class="jsdoc-keyword">for </span><span class="jsdoc-syntax">(</span><span class="jsdoc-keyword">var </span><span class="jsdoc-var">i </span><span class="jsdoc-syntax">=0; </span><span class="jsdoc-var">i </span><span class="jsdoc-syntax">< </span><span class="jsdoc-var">params.length</span><span class="jsdoc-syntax">;</span><span class="jsdoc-var">i</span><span class="jsdoc-syntax">++) {
431 </span><span class="jsdoc-var">ul.cn.push</span><span class="jsdoc-syntax">( </span><span class="jsdoc-var">Roo.factory</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">params</span><span class="jsdoc-syntax">[</span><span class="jsdoc-var">i</span><span class="jsdoc-syntax">])</span><span class="jsdoc-var">.getAutoCreateParamSection</span><span class="jsdoc-syntax">() )
435 </span><span class="jsdoc-var">cfg.cn.push</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">ul</span><span class="jsdoc-syntax">);
437 </span><span class="jsdoc-keyword">if </span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">this.stype </span><span class="jsdoc-syntax">== </span><span class="jsdoc-string">'return' </span><span class="jsdoc-syntax">&& (</span><span class="jsdoc-var">syn.returndesc.length </span><span class="jsdoc-syntax">|| </span><span class="jsdoc-var">syn.returntype.length </span><span class="jsdoc-syntax">)) {
439 </span><span class="jsdoc-var">cfg.cn.push</span><span class="jsdoc-syntax">({
440 </span><span class="jsdoc-var">tag</span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'p'</span><span class="jsdoc-syntax">,
441 </span><span class="jsdoc-var">cls </span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'para'</span><span class="jsdoc-syntax">,
442 </span><span class="jsdoc-var">cn </span><span class="jsdoc-syntax">: [
445 </span><span class="jsdoc-var">tag</span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'code'</span><span class="jsdoc-syntax">,
446 </span><span class="jsdoc-var">cls</span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'parameter'</span><span class="jsdoc-syntax">,
447 </span><span class="jsdoc-var">html </span><span class="jsdoc-syntax">: </span><span class="jsdoc-var">syn.returntype
448 </span><span class="jsdoc-syntax">},
449 </span><span class="jsdoc-var">syn.returndesc
450 </span><span class="jsdoc-syntax">]
455 </span><span class="jsdoc-keyword">return </span><span class="jsdoc-var">cfg</span><span class="jsdoc-syntax">;
457 </span><span class="jsdoc-var">getChildContainer </span><span class="jsdoc-syntax">: </span><span class="jsdoc-keyword">function</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">build_call</span><span class="jsdoc-syntax">)
460 </span><span class="jsdoc-keyword">if </span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">this.stype </span><span class="jsdoc-syntax">== </span><span class="jsdoc-string">'parameter'</span><span class="jsdoc-syntax">) {
461 </span><span class="jsdoc-keyword">return </span><span class="jsdoc-var">this.el.select</span><span class="jsdoc-syntax">(</span><span class="jsdoc-string">'.roo-params'</span><span class="jsdoc-syntax">,</span><span class="jsdoc-keyword">true</span><span class="jsdoc-syntax">)</span><span class="jsdoc-var">.first</span><span class="jsdoc-syntax">();
464 </span><span class="jsdoc-keyword">return </span><span class="jsdoc-var">this.el</span><span class="jsdoc-syntax">;
472 </span><span class="jsdoc-var">Roo.doc.Section.map </span><span class="jsdoc-syntax">= {
473 </span><span class="jsdoc-string">'desc' </span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'Description'</span><span class="jsdoc-syntax">,
474 </span><span class="jsdoc-string">'parameter' </span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'Parameters'</span><span class="jsdoc-syntax">,
475 </span><span class="jsdoc-string">'return' </span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'Return Value'</span><span class="jsdoc-syntax">,
476 </span><span class="jsdoc-string">'note' </span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'Notes'</span><span class="jsdoc-syntax">,
477 </span><span class="jsdoc-string">'example' </span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'Examples'</span><span class="jsdoc-syntax">,
478 </span><span class="jsdoc-string">'throws' </span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'Throws Exception'
479 </span><span class="jsdoc-syntax">}
480 </span><span class="jsdoc-comment">/*
486 * @class Roo.doc.Synopsis
487 * @extends Roo.bootstrap.Component
488 * Synopsis Element class
489 * @cfg {String} returntype return value
490 * @cfg {String} returndesc description of return value. (used in the return section if set..)
491 * @cfg {String} name title really..
492 * @cfg {String} stype (function|constant)
493 * @cfg {String} memberof class name
494 * @cfg {bool} is_static is a static member
495 * @cfg {bool} is_constructor is a static member
498 * Create a new Synopsis
499 * @param {Object} config The config object
502 </span><span class="jsdoc-var">Roo.doc.Synopsis </span><span class="jsdoc-syntax">= </span><span class="jsdoc-keyword">function</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">config</span><span class="jsdoc-syntax">){
503 </span><span class="jsdoc-var">Roo.doc.Synopsis.superclass.constructor.call</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">this</span><span class="jsdoc-syntax">, </span><span class="jsdoc-var">config</span><span class="jsdoc-syntax">);
506 </span><span class="jsdoc-var">Roo.extend</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">Roo.doc.Synopsis</span><span class="jsdoc-syntax">, </span><span class="jsdoc-var">Roo.bootstrap.Component</span><span class="jsdoc-syntax">, {
508 </span><span class="jsdoc-var">memberof </span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">''</span><span class="jsdoc-syntax">,
509 </span><span class="jsdoc-var">is_static </span><span class="jsdoc-syntax">: </span><span class="jsdoc-keyword">false</span><span class="jsdoc-syntax">,
510 </span><span class="jsdoc-var">returntype </span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">''</span><span class="jsdoc-syntax">,
511 </span><span class="jsdoc-var">returndesc </span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">''</span><span class="jsdoc-syntax">,
512 </span><span class="jsdoc-var">name</span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">''</span><span class="jsdoc-syntax">,
513 </span><span class="jsdoc-var">stype</span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'function'</span><span class="jsdoc-syntax">,
514 </span><span class="jsdoc-var">is_constructor </span><span class="jsdoc-syntax">: </span><span class="jsdoc-keyword">false</span><span class="jsdoc-syntax">,
516 </span><span class="jsdoc-var">getAutoCreate </span><span class="jsdoc-syntax">: </span><span class="jsdoc-keyword">function</span><span class="jsdoc-syntax">(){
518 </span><span class="jsdoc-keyword">var </span><span class="jsdoc-var">syn </span><span class="jsdoc-syntax">= </span><span class="jsdoc-var">this.items</span><span class="jsdoc-syntax">[0]; </span><span class="jsdoc-comment">// hopefully...
522 </span><span class="jsdoc-keyword">var </span><span class="jsdoc-var">nmp </span><span class="jsdoc-syntax">= (</span><span class="jsdoc-var">this.is_static </span><span class="jsdoc-syntax">? </span><span class="jsdoc-string">'' </span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'$'</span><span class="jsdoc-syntax">) +
523 </span><span class="jsdoc-var">this.memberof </span><span class="jsdoc-syntax">+
524 (</span><span class="jsdoc-var">this.is_static </span><span class="jsdoc-syntax">? </span><span class="jsdoc-string">'::' </span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'->'</span><span class="jsdoc-syntax">);
526 </span><span class="jsdoc-keyword">var </span><span class="jsdoc-var">nm </span><span class="jsdoc-syntax">= </span><span class="jsdoc-var">this.name</span><span class="jsdoc-syntax">;
527 </span><span class="jsdoc-comment">// this should probably do the params....?? then we need to disable the rendering..
529 </span><span class="jsdoc-keyword">if </span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">this.is_constructor</span><span class="jsdoc-syntax">) {
531 </span><span class="jsdoc-var">nm </span><span class="jsdoc-syntax">= </span><span class="jsdoc-var">this.memberof</span><span class="jsdoc-syntax">;
532 </span><span class="jsdoc-var">nmp </span><span class="jsdoc-syntax">= </span><span class="jsdoc-string">'new '</span><span class="jsdoc-syntax">;
536 </span><span class="jsdoc-keyword">var </span><span class="jsdoc-var">cfg </span><span class="jsdoc-syntax">={
537 </span><span class="jsdoc-var">tag</span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'h5'</span><span class="jsdoc-syntax">,
538 </span><span class="jsdoc-var">cls </span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'refsynopsisdiv'</span><span class="jsdoc-syntax">,
539 </span><span class="jsdoc-var">cn </span><span class="jsdoc-syntax">: [
541 </span><span class="jsdoc-var">cls</span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'funcsynopsis'</span><span class="jsdoc-syntax">,
542 </span><span class="jsdoc-var">cn</span><span class="jsdoc-syntax">: [
544 </span><span class="jsdoc-var">tag</span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'p'</span><span class="jsdoc-syntax">,
545 </span><span class="jsdoc-var">cn</span><span class="jsdoc-syntax">: {
546 </span><span class="jsdoc-var">tag</span><span class="jsdoc-syntax">:</span><span class="jsdoc-string">'code'</span><span class="jsdoc-syntax">,
547 </span><span class="jsdoc-var">cls </span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'funcprototype'</span><span class="jsdoc-syntax">,
548 </span><span class="jsdoc-var">cn</span><span class="jsdoc-syntax">: [
549 </span><span class="jsdoc-var">this.returntype </span><span class="jsdoc-syntax">+ </span><span class="jsdoc-string">' ' </span><span class="jsdoc-syntax">+ </span><span class="jsdoc-var">nmp</span><span class="jsdoc-syntax">,
551 </span><span class="jsdoc-var">tag</span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'strong'</span><span class="jsdoc-syntax">,
552 </span><span class="jsdoc-var">cls </span><span class="jsdoc-syntax">: </span><span class="jsdoc-var">this.stype</span><span class="jsdoc-syntax">,
553 </span><span class="jsdoc-var">html </span><span class="jsdoc-syntax">: </span><span class="jsdoc-var">nm
554 </span><span class="jsdoc-syntax">},
555 </span><span class="jsdoc-string">'('</span><span class="jsdoc-syntax">,
557 </span><span class="jsdoc-var">tag</span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'span'</span><span class="jsdoc-syntax">,
558 </span><span class="jsdoc-var">cls </span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'roo-params'
559 </span><span class="jsdoc-syntax">},
560 </span><span class="jsdoc-string">')'
561 </span><span class="jsdoc-syntax">]
573 </span><span class="jsdoc-keyword">return </span><span class="jsdoc-var">cfg</span><span class="jsdoc-syntax">;
575 </span><span class="jsdoc-var">getChildContainer </span><span class="jsdoc-syntax">: </span><span class="jsdoc-keyword">function</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">build_call</span><span class="jsdoc-syntax">)
579 </span><span class="jsdoc-keyword">return </span><span class="jsdoc-var">this.el.select</span><span class="jsdoc-syntax">(</span><span class="jsdoc-string">'.roo-params'</span><span class="jsdoc-syntax">,</span><span class="jsdoc-keyword">true</span><span class="jsdoc-syntax">)</span><span class="jsdoc-var">.first</span><span class="jsdoc-syntax">();
590 </span><span class="jsdoc-comment">/*
596 * @class Roo.doc.NavCategory
597 * @extends Roo.bootstrap.Component
598 * Navigation Category class
599 * @cfg {string} title
602 * Represent's an category on the left menu.
603 * - phpdoc @category elements map the pages to the categories
604 * this should be on the left side of the menu, when the
605 * contents are loaded, then it can expand this out, and add links
606 * for each of the methods.
611 * Create a new Navigation Category
612 * @param {Object} config The config object
615 </span><span class="jsdoc-var">Roo.doc.NavCategory </span><span class="jsdoc-syntax">= </span><span class="jsdoc-keyword">function</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">config</span><span class="jsdoc-syntax">){
616 </span><span class="jsdoc-var">Roo.doc.Para.superclass.constructor.call</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">this</span><span class="jsdoc-syntax">, </span><span class="jsdoc-var">config</span><span class="jsdoc-syntax">);
617 </span><span class="jsdoc-var">Roo.doc.NavCategory.registry</span><span class="jsdoc-syntax">[</span><span class="jsdoc-var">this.name</span><span class="jsdoc-syntax">] = </span><span class="jsdoc-var">this</span><span class="jsdoc-syntax">;
619 </span><span class="jsdoc-var">Roo.doc.NavCategory.registry </span><span class="jsdoc-syntax">= {};
620 </span><span class="jsdoc-var">Roo.extend</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">Roo.doc.NavCategory</span><span class="jsdoc-syntax">, </span><span class="jsdoc-var">Roo.bootstrap.Component</span><span class="jsdoc-syntax">, {
622 </span><span class="jsdoc-var">title </span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">''</span><span class="jsdoc-syntax">,
623 </span><span class="jsdoc-var">name </span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">''</span><span class="jsdoc-syntax">,
624 </span><span class="jsdoc-var">getAutoCreate </span><span class="jsdoc-syntax">: </span><span class="jsdoc-keyword">function</span><span class="jsdoc-syntax">(){
626 </span><span class="jsdoc-comment">//?? this is the synopsis type....
628 // this is not very fancy...
630 </span><span class="jsdoc-keyword">var </span><span class="jsdoc-var">cfg </span><span class="jsdoc-syntax">={
632 </span><span class="jsdoc-var">cn </span><span class="jsdoc-syntax">: [
635 </span><span class="jsdoc-var">tag </span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'a'</span><span class="jsdoc-syntax">,
636 </span><span class="jsdoc-var">cls</span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'roo-nav-category'</span><span class="jsdoc-syntax">,
637 </span><span class="jsdoc-var">href </span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'#' </span><span class="jsdoc-syntax">+ </span><span class="jsdoc-var">this.name</span><span class="jsdoc-syntax">,
638 </span><span class="jsdoc-var">html </span><span class="jsdoc-syntax">: </span><span class="jsdoc-var">this.title
639 </span><span class="jsdoc-syntax">},
641 </span><span class="jsdoc-var">cls </span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'container roo-child-ctr'
642 </span><span class="jsdoc-syntax">}
646 </span><span class="jsdoc-keyword">return </span><span class="jsdoc-var">cfg</span><span class="jsdoc-syntax">;
648 </span><span class="jsdoc-var">getChildContainer </span><span class="jsdoc-syntax">: </span><span class="jsdoc-keyword">function</span><span class="jsdoc-syntax">()
650 </span><span class="jsdoc-keyword">return </span><span class="jsdoc-var">this.el.select</span><span class="jsdoc-syntax">(</span><span class="jsdoc-string">'.roo-child-ctr'</span><span class="jsdoc-syntax">,</span><span class="jsdoc-keyword">true</span><span class="jsdoc-syntax">)</span><span class="jsdoc-var">.first</span><span class="jsdoc-syntax">();
659 </span></code></body></html>