git.roojs.org Git - roojs1/blob - docs/symbols/src/Roo_doc_Param.js.html

   1 <html><head><title>../roojs1/Roo/doc/Param.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">/*
   2  * - LGPL
   3  *
   4  */
   5
   6 /**
   7  * @class Roo.doc.Param
   8  * @extends Roo.bootstrap.Component
   9  * Param Element class
  10  * @cfg {bool} is_optional
  11  * @cfg {String} type  argument type
  12  * @cfg {String} name
  13  * @cfg {String} desc  short description
  14  * @cfg {String} defaultvalue default value
  15  *
  16  * @constructor
  17  * Create a new Param
  18  * @param {Object} config The config object
  19  */
  20
  21 </span><span class="jsdoc-var">Roo.mailer.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">){
  22     </span><span class="jsdoc-var">Roo.mailer.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">);
  23 };
  24
  25 </span><span class="jsdoc-var">Roo.extend</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">Roo.mailer.Param</span><span class="jsdoc-syntax">, </span><span class="jsdoc-var">Roo.bootstrap.Component</span><span class="jsdoc-syntax">,  {
  26
  27     </span><span class="jsdoc-var">is_optional </span><span class="jsdoc-syntax">: </span><span class="jsdoc-keyword">false</span><span class="jsdoc-syntax">,
  28     </span><span class="jsdoc-var">type </span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">''</span><span class="jsdoc-syntax">,
  29     </span><span class="jsdoc-var">name</span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">''</span><span class="jsdoc-syntax">,
  30     </span><span class="jsdoc-var">defaultvalue</span><span class="jsdoc-syntax">:   </span><span class="jsdoc-string">''</span><span class="jsdoc-syntax">,
  31     </span><span class="jsdoc-var">desc</span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">''</span><span class="jsdoc-syntax">,
  32
  33     </span><span class="jsdoc-var">getAutoCreate </span><span class="jsdoc-syntax">: </span><span class="jsdoc-keyword">function</span><span class="jsdoc-syntax">(){
  34
  35         </span><span class="jsdoc-comment">//?? this is the synopsis type....
  36
  37
  38         </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">) {
  39
  40             </span><span class="jsdoc-keyword">return </span><span class="jsdoc-syntax">{
  41                 </span><span class="jsdoc-var">tag </span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'li'</span><span class="jsdoc-syntax">,
  42                 </span><span class="jsdoc-var">cn </span><span class="jsdoc-syntax">: [
  43                     {
  44                         </span><span class="jsdoc-var">tag </span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'p'</span><span class="jsdoc-syntax">,
  45                         </span><span class="jsdoc-var">cls</span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'para'</span><span class="jsdoc-syntax">,
  46                         </span><span class="jsdoc-var">cn </span><span class="jsdoc-syntax">: [
  47                             {
  48                                 </span><span class="jsdoc-var">tag</span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'code'</span><span class="jsdoc-syntax">,
  49                                 </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
  50                             </span><span class="jsdoc-syntax">},
  51                             </span><span class="jsdoc-var">this.desc
  52                         </span><span class="jsdoc-syntax">]
  53                     }
  54                 ]
  55             };
  56
  57         }
  58          </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">) {
  59             </span><span class="jsdoc-keyword">return </span><span class="jsdoc-syntax">{
  60                     </span><span class="jsdoc-var">tag </span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'p'</span><span class="jsdoc-syntax">,
  61                     </span><span class="jsdoc-var">cls</span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'para'</span><span class="jsdoc-syntax">,
  62                     </span><span class="jsdoc-var">cn </span><span class="jsdoc-syntax">: [
  63                         {
  64                             </span><span class="jsdoc-var">tag</span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'code'</span><span class="jsdoc-syntax">,
  65                             </span><span class="jsdoc-var">html </span><span class="jsdoc-syntax">: </span><span class="jsdoc-var">this.type
  66                         </span><span class="jsdoc-syntax">},
  67                         </span><span class="jsdoc-var">this.desc
  68                     </span><span class="jsdoc-syntax">]
  69                 };
  70
  71          }
  72
  73
  74
  75         </span><span class="jsdoc-comment">// this is not very fancy...
  76
  77         </span><span class="jsdoc-keyword">var </span><span class="jsdoc-var">cfg </span><span class="jsdoc-syntax">={
  78             </span><span class="jsdoc-var">tag</span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'span'</span><span class="jsdoc-syntax">,
  79             </span><span class="jsdoc-var">cn </span><span class="jsdoc-syntax">: [
  80                 </span><span class="jsdoc-var">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">,
  81                 </span><span class="jsdoc-var">this.type</span><span class="jsdoc-syntax">,
  82                 </span><span class="jsdoc-string">' '</span><span class="jsdoc-syntax">,
  83                 </span><span class="jsdoc-var">this.name</span><span class="jsdoc-syntax">,
  84                 </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">,
  85                 </span><span class="jsdoc-var">this.defaultvalue</span><span class="jsdoc-syntax">,
  86                 </span><span class="jsdoc-string">',' </span><span class="jsdoc-comment">// not really.. but let's do it anyway...
  87             </span><span class="jsdoc-syntax">]
  88         };
  89
  90
  91
  92
  93         </span><span class="jsdoc-keyword">return </span><span class="jsdoc-var">cfg</span><span class="jsdoc-syntax">;
  94     }
  95
  96
  97
  98
  99
 100
 101 });
 102
 103
 104
 105  </span></code></body></html>