Package turbogears :: Package widgets :: Module big_widgets :: Class AutoCompleteTextField

Class AutoCompleteTextField

source code

   object --+                
            |                
  base.Widget --+            
                |            
forms.InputWidget --+        
                    |        
      forms.FormField --+    
                        |    
          forms.TextField --+
                            |
           object --+       |
                    |       |
          base.Widget --+   |
                        |   |
             AutoComplete --+
                            |
                           AutoCompleteTextField

Text field with auto complete functionality.

Nested Classes
  template_c

Inherited from base.Widget: __metaclass__

Instance Methods

Inherited from forms.FormField: __init__, update_params

Inherited from forms.InputWidget: adjust_value, display

Inherited from base.Widget: __call__, __repr__, __setattr__, render, retrieve_css, retrieve_javascript

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __sizeof__, __str__, __subclasshook__

Class Variables
  template = '\n <span xmlns:py="http://purl.org/kid/ns#" cla...
hash(x)
  params = ['attrs', 'field_class', 'css_classes', 'convert', 's...
  params_doc = {'attrs': 'Extra attributes', 'complete_delay': '...

Inherited from forms.TextField: attrs

Inherited from forms.FormField: css_classes, field_class, help_text, label

Inherited from forms.InputWidget: convert, validator

Inherited from AutoComplete: complete_delay, css, javascript, min_chars, only_suggest, result_name, search_controller, search_param, show_spinner, take_focus

Inherited from base.Widget: default

Properties

Inherited from forms.FormField: field_id, is_required, name

Inherited from forms.InputWidget: error, fq_name, is_validated, name_path, path

Inherited from base.Widget: is_named

Inherited from object: __class__

Class Variable Details

template

hash(x)

Value:
'''
    <span xmlns:py="http://purl.org/kid/ns#" class="${field_class}">
    <script type="text/javascript">
        AutoCompleteManager${field_id} = new AutoCompleteManager(\'${f\
ield_id}\', \'${field_id}\', null,
        \'${search_controller}\', \'${search_param}\', \'${result_name\
}\', ${str(only_suggest).lower()},
        \'${show_spinner and tg.url([tg.widgets, \'turbogears.widgets/\
...

params

Value:
['attrs',
 'field_class',
 'css_classes',
 'convert',
 'search_controller',
 'search_param',
 'result_name',
 'only_suggest',
...

params_doc

Value:
{'attrs': 'Extra attributes',
 'complete_delay': 'Delay (in seconds) before loading new auto complet\
ions',
 'convert': 'Should the value be coerced by the validator at display?'\
,
 'css_classes': 'List of extra CSS classes for the field',
 'field_class': 'CSS class for the field',
 'min_chars': 'Minimum number of characters to type before autocomplet\
...