eGroupWare 1.2.106-2 : /phpgwapi/js/jsolait/doc/jsolait.xhtml source

[Sommaire] [Imprimer]
   1  <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
   2  <html xmlns="http://www.w3.org/1999/xhtml">
   3    <head>
   4      <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
   5      <title>.: jsolait :. | documentation | jsolait</title>
   6      <link rel="stylesheet" type="text/css" href="./html.css" />
   7      <meta name="author" content="Jan-Klaas Kollhof" />
   8      <meta name="keywords" content="jsolait.lang" />
   9    </head>
  10    <body>
  11      <a name="top" id="top"></a>
  12      <div class="navigationBar"><a href="./index.xhtml">documentation</a> | 
  13                      jsolait</div>
  14      <div class="menu">
  15        <ul></ul>
  16        <div class="copyright">copyright Â© 2004, Jan-Klaas Kollhof</div>
  17      </div>
  18      <div class="content">
  19           <h1>Module jsolait</h1>
  20              This is the main module.<br />
  21              It is used by all jsolait modules and provides the basic functionality.<br />
  22           <div class="contentItem"><h2>public members:<a class="bttop" href="#top">â–²</a></h2><div>
  23                
  24                 
  25                 <h3>baseURL</h3><div class="indent">
  26                      
  27                      The base URL to use when dynamically loading user modules.
  28                  </div>  
  29                 <h3>libURL</h3><div class="indent">
  30                      
  31                      The url of the jsolait installation, used for dynamically loading jsolait modules.
  32                  </div>  
  33                  
  34                 <br />
  35                  <h3>ModuleImportFailed()</h3><div class="indent">
  36                      
  37                      Exception thrown when a module could not be imported.
  38                  </div>  
  39                  <h3></h3><div class="indent">
  40                      
  41                  </div>  
  42                  
  43                 <br /> 
  44                 <h3>importModule(moduleName)</h3><div class="indent">
  45                      
  46                     Imports a module given its name(e.g. "someModule.someSubModule").<br />
  47                     For dynamic loading of modules:<br />
  48                     A module's file location is determined by treating each module name as a directory.<br />
  49                     Only the last one is assumed to point to a file.<br />
  50                     If the module's URL is not known to jsolait then it will be searched for in jsolait.baseURL which is "." by default.<br />
  51                  </div>  
  52                  
  53                 <h3>reportException(e)</h3><div class="indent">
  54                      
  55                      Displays an Exception <code>e</code> and it's trace.<br />
  56                      This is better than <code>alert(e)</code>.
  57                 </div>  
  58           </div></div>
  59           
  60           <div class="contentItem"><h2>globals:<a class="bttop" href="#top">â–²</a></h2><div>
  61              
  62              <h3>jsolait</h3><div class="indent">
  63                  
  64                  The jsolait module.
  65              </div>
  66              
  67              <h3>Class(className, superClass, classScope)</h3><div class="indent">
  68                  
  69                  A method for creating Classes.<br />
  70                  The <code>className</code> parameter is not needed if the Class is going to be a public member of a module.<br />
  71                  The <code>superClass</code> parameter must be specified if the new class is to be a subclass of the class specified by <code>superClass</code>.
  72                  The <code>classScope</code> is a <code>ClassScope</code> function and defines the scope of the class.<br />
  73                  <br />
  74                  Each class created by this method has the following properies and methods:<br />
  75                  <ul>
  76                      <li><b>className</b> The name of the class.</li>
  77                      <li><b>superClass</b> The super class of the class</li>
  78                  </ul>
  79                  <br />
  80              </div>
  81              
  82              <h3>Module(name, version, moduleScope)</h3><div class="indent">
  83                  
  84                  A method for creating modules.<br />
  85                  The <code>name</code> parameter defines the name of the module.<br />
  86                  The <code>version</code> parameter contains the version of the module.<br />
  87                  The <code>moduleScope</code> is a <code>ModuleScope</code> function and defines the scope of the module.<br />
  88                  <br />
  89                  Modules created with this function have the following properties:<br />
  90                  <ul>
  91                      <li><b>name</b> The name of the module.</li>
  92                      <li><b>version</b> The module's version.</li>
  93                      <li><b>Exception</b> The base class for all exception classes in the module.</li>
  94                  </ul>
  95              </div>
  96              
  97              <br />
  98              
  99              <h3>importModule(moduleName)</h3><div class="indent">
 100                  
 101                  The globalized jsolait.importModule method.
 102              </div>
 103              
 104              <h3>reportException(e)</h3><div class="indent">
 105                  
 106                  The globalized jsolait.reportException method.
 107              </div>
 108           </div></div>
 109           
 110           <div class="contentItem"><h2>interfaces:<a class="bttop" href="#top">â–²</a></h2><div>
 111              
 112              
 113              <h3>ClassScope(publ, supr)</h3><div class="indent">
 114                  
 115                  The ClassScope is a function which is called by the Class method when a new class is constructed.<br />
 116                  The <code>publ</code> parameter contains the new class' prototype object.<br />
 117                  All objects added to this object become public members of the new class.<br />
 118                  The <code>supr</code> parameter contains a wrapper function for easyly calling the super class' methods<br />
 119                  Everything declared with var inside the scope becomes "private" to the scope, i.e. is only visible within the scope.<br />
 120              </div>
 121              
 122              <h3>ModuleScope(mod)</h3><div class="indent">
 123                  
 124                  The ModuleScope is a function which is called by the Module function when a new module is created.<br />
 125                  All objects added to the <code>mod</code> parameter will become public members of the module.<br />
 126                  It will already contain the modules porperties like name, version and the Exception class.<br />
 127              </div>
 128           </div></div>
 129           
 130           <div class="contentItem"><h2>requirements:<a class="bttop" href="#top">â–²</a></h2><div>
 131              
 132              For dynamic loading of modules a synchronous HTTP connection must be available. Mozilla and IE both have it.
 133           </div></div>
 134           
 135           
 136           
 137       </div>
 138    </body>
 139  </html>
Code source de eGroupWare 1.2.106-2

/phpgwapi/js/jsolait/doc/ -> jsolait.xhtml (source)
