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

   1 <html><head><title>../roojs1/Roo/doc/Book.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.Book
   8  * @extends Roo.bootstrap.Component
   9  * Book Element class - Represents the outer book
  10  * @cfg {String} title   Title of the book
  11  * @cfg {String} abstract Abstract (or just add para's to the book, and it will get added to the abstract)
  12  *
  13  *
  14  * @constructor
  15  * Create a new Book
  16  * @param {Object} config The config object
  17  */
  18
  19 </span><span class="jsdoc-var">Roo.doc.Book </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">){
  20     </span><span class="jsdoc-var">Roo.doc.Book.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">);
  21 };
  22
  23 </span><span class="jsdoc-var">Roo.extend</span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">Roo.doc.Book</span><span class="jsdoc-syntax">, </span><span class="jsdoc-var">Roo.bootstrap.Component</span><span class="jsdoc-syntax">,  {
  24
  25     </span><span class="jsdoc-var">title </span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">''</span><span class="jsdoc-syntax">,
  26     </span><span class="jsdoc-var">abstract </span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">''</span><span class="jsdoc-syntax">,
  27     </span><span class="jsdoc-var">getAutoCreate </span><span class="jsdoc-syntax">: </span><span class="jsdoc-keyword">function</span><span class="jsdoc-syntax">(){
  28
  29         </span><span class="jsdoc-comment">//?? this is the synopsis type....
  30
  31         // this is not very fancy...
  32
  33         </span><span class="jsdoc-keyword">var </span><span class="jsdoc-var">cfg </span><span class="jsdoc-syntax">={
  34             </span><span class="jsdoc-var">cls</span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'book'</span><span class="jsdoc-syntax">,
  35             </span><span class="jsdoc-var">cn </span><span class="jsdoc-syntax">: [
  36                 {
  37                     </span><span class="jsdoc-var">cls </span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'info'</span><span class="jsdoc-syntax">,
  38                     </span><span class="jsdoc-var">cn</span><span class="jsdoc-syntax">: [
  39                         {
  40                             </span><span class="jsdoc-var">tag</span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'h1'</span><span class="jsdoc-syntax">,
  41                             </span><span class="jsdoc-var">html </span><span class="jsdoc-syntax">: </span><span class="jsdoc-var">this.title
  42                         </span><span class="jsdoc-syntax">}
  43                     ]
  44                 }
  45             ]
  46         };
  47
  48         </span><span class="jsdoc-keyword">if </span><span class="jsdoc-syntax">(</span><span class="jsdoc-var">this.abstract.length</span><span class="jsdoc-syntax">) {
  49             </span><span class="jsdoc-var">cfg.cn</span><span class="jsdoc-syntax">[0]</span><span class="jsdoc-var">.cn.push</span><span class="jsdoc-syntax">({
  50                 </span><span class="jsdoc-var">cls </span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'abstract'</span><span class="jsdoc-syntax">,
  51                 </span><span class="jsdoc-var">cn </span><span class="jsdoc-syntax">: {
  52                     </span><span class="jsdoc-var">tag </span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'p'</span><span class="jsdoc-syntax">,
  53                     </span><span class="jsdoc-var">cls </span><span class="jsdoc-syntax">: </span><span class="jsdoc-string">'para'</span><span class="jsdoc-syntax">,
  54                     </span><span class="jsdoc-var">html </span><span class="jsdoc-syntax">: </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.abstract</span><span class="jsdoc-syntax">)
  55                 }
  56
  57             });
  58
  59         }
  60
  61         </span><span class="jsdoc-keyword">return </span><span class="jsdoc-var">cfg</span><span class="jsdoc-syntax">;
  62     }
  63
  64
  65
  66
  67
  68
  69 });
  70
  71
  72
  73  </span></code></body></html>