NeverModules Autocomplete Documentaton (English)

by never-online - http://www.never-online.net - updated: 2007-3-23
/*
 * ------------------------------------------------------------------------
 *
 * NeverModules Autocomplete Document Description
 *
 * (Notice) 
 *   Permission given to use this script in ANY kind of applications if
 *   header lines are left unchanged.
 *
 * (Note) 
 * In the "[" and the "]" character, means the params are OPTIONAL.
 * In the "(" and the ")" character, means the params are NEED.
 *
 * module name : neverModules Autocomplete
 * constructor : neverModules.modules.autocomplete()
 * web         : http://www.never-online.net/
 * author      : never-online, BlueDestiny
 * version     : 0.12 beta
 * debug       : IE 6.0, Mozilla 1.5+, Opera 9.0
 *
 * ------------------------------------------------------------------------
 * 
 * namespace (neverModules.configuration.autocomplete) 
 * for the default complete configuration
 *
 * ------------------------------------------------------------------------
 * 
 *   neverModules.configuration.autocomplete = {
 *   
 *   defaultAnimateImage : {src:"images/animated_loading.gif", width:16, height: 16},
 *   defaultSliceRange   : {low: 0, high: 200},
 *   defaultIsUseContent : false,
 *   defaultAutoSlice    : true,
 *   defaultIgnoreSpeed  : false,
 *   defaultIgnoreCase   : true,
 *   defaultIgnoreWhere  : true,
 *   defaultCallbackHdle : function(){},
 *   defaultAjaxCallback : function(){},
 *   defaultDataSource   : [],
 *   defaultHeight       : 200,
 *   defaultMaxSlice     : 100,
 *   
 *   _defaultSelectedIdx : -1,
 *   _defaultStatus      : 0,
 *   _defaultInitObject  : null,
 *   _defaultStyleCss    : "neverModules-auto"
  
 *   }
 *
 * public property
 * 
 * All the public property in the constructor.

 * name         : NEED.     String.  instance name in the constructor object
 * textbox      : NEED.     Object.  listener textbox in the constructor object
 * returnBox    : NEED.     Object.  return textbox in the constructor object
 * ignoreCase   : OPTIONAL. Boolean. 
 * ignoreWhere  : OPTIONAL. Boolean. 
 * autoSlice    : OPTIONAL. Boolean.  
 * maxSlice     : OPTIONAL. Number.   
 * sliceRange   : OPTIONAL. Object.   format like {low:0, high:100}
 * ignoreSpeed  : OPTIONAL. Boolean.  
 * useContent   : OPTIONAL. Boolean.  style like the google suggest
 * animateImage : OPTIONAL. Object.   loading image format like {src:"image's path", width:20, height:20}
 * callback     : OPTIONAL. Function. callback handler
 * scrollHeight : OPTIONAL. Number.   autocomplete height
 *
 * ------------------------------------------------------------------------
 *
 * public method
 *
 * ------------------------------------------------------------------------
 *
 * create()           
 *   params: no params
 *   void function
 *
 * show()             
 *   params: no params
 *   void function
 *
 * close()            
 *   params: no params
 *   void function
 *
 * setAnimateImage()
 *   params: (imageSrc, width, height) 
 *   void function
 *
 * showAnimateImage() 
 *   params:[src, width, height] 
 *   void function
 *
 * closeAnimateImage()
 *   params: no params
 *   void function
 * 
 * hdleEvent()
 *   params: event
 *   void function
 * 
 * expandAllItem()
 *   params: no params
 *   void function
 *
 * setDataSource()
 *   params: (aDataSource)
 *   void function
 *
 * clearDataSource()
 *   params: no params
 *   void function
 *
 */
 
neverModules - autocomplete @ Power By never-online.net