Javascript code documentation

Javascript client-side code. More...

Modules
	Javascript Common (uty.js)
	Javascript Widgets (utywidgets.js)
	Javascript filelist (utyfilelist.js)

---

Detailed Description

Javascript client-side code.

Code Conventions

• private object variables are named m_varname: this are visible only by privileged (closure, not propotype) members inside the scope of the javascript object
• variables named _varname: are intended for internal use only and should never be used by client code; usually a public varname(value) accessor function is provided that act as a setter if value!==undefined (NB:'!==') and always returns the last varname value; e.g.

            this.text=function(value){
              if(value!==undefined)_text=value;
              return this._text;
            }
  

Code compression/obfuscation (NOT USED)

Code is written in a 'self-compressed' style.
The adopted formatting allows to easily test and debug always (and everywhere) the ORIGINAL source (e.g.: with firebug)

• whilst keeping formatting, the only extra whitespaces (apart from those required by syntax) are line-breaks and indentation tabs
• *.js and *.css are saved in unix file format (LF) as it uses 1 byte line-breaks (windows CR+LF use 2 bytes)
• comments in the implementation are reduced at a very minimum as the code is thorougly revised on purpose
• the software documentation is kept in this separate doc.js file, also considering that generating doc for js is not a straightforward process (and it would produce a separate document, while this file is included and 'linked' together with the phps project files)

   Compression test: YUIcompressor, max compression level with obfuscation
   ------------------------------------------------------------- 
   file            original    compressed      delta       ratio  (sizes in bytes)
   ------------------------------------------------------------- 
   uty.js              6834          5127       1707      24.98%
   utywidgets.js      17412         15298       2114      12.14%
   utyfilelist.js     12275         10509       1766      14.39%
   default.css         6068          5438        630      10.38%
   -------------------------------------------------------------
   total              42589         36372       6217      14.60%
  
   performed on 20/02/2010