Package turbogears :: Package widgets :: Module big_widgets :: Class AutoCompleteField

Class AutoCompleteField

source code

       object --+                    
                |                    
      base.Widget --+                
                    |                
  base.CompoundWidget --+            
                        |            
       object --+       |            
                |       |            
      base.Widget --+   |            
                    |   |            
    forms.InputWidget --+            
                        |            
forms.CompoundInputWidget --+        
                            |        
    forms.FormFieldsContainer --+    
                                |    
           object --+           |    
                    |           |    
          base.Widget --+       |    
                        |       |    
        forms.InputWidget --+   |    
                            |   |    
              forms.FormField --+    
                                |    
          forms.CompoundFormField --+
                                    |
                   object --+       |
                            |       |
                  base.Widget --+   |
                                |   |
                     AutoComplete --+
                                    |
                                   AutoCompleteField

Text field with auto complete functionality and hidden key field.

Nested Classes
  template_c

Inherited from base.Widget: __metaclass__

Instance Methods

Inherited from forms.FormFieldsContainer: display_field_for, get_field_by_name, render_field_for, update_params

Inherited from forms.CompoundInputWidget: adjust_value, dictify_value, error_for, params_for, value_for

Inherited from base.CompoundWidget: __init__, display, iter_member_widgets, retrieve_css, retrieve_javascript

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

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#" id=...
hash(x)
  member_widgets = ['text_field', 'hidden_field', 'fields', 'hid...
  text_field = TextField(name='text', attrs={}, field_class='tex...
  hidden_field = HiddenField(name='hidden', attrs={}, field_clas...
  params = ['disabled_fields', 'convert', 'field_class', 'css_cl...
  params_doc = {'attrs': 'Extra attributes', 'complete_delay': '...

Inherited from forms.CompoundFormField: is_required

Inherited from forms.FormFieldsContainer: disabled_fields, fields, hidden_fields

Inherited from base.CompoundWidget: compound

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

Inherited from forms.InputWidget: convert, validator

Inherited from AutoComplete: attrs, 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.FormFieldsContainer: file_upload

Inherited from forms.FormField: field_id, 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#" id="${field_id}" class="$\
{field_class}">
    <script type="text/javascript">
        AutoCompleteManager${field_id} = new AutoCompleteManager(\'${f\
ield_id}\',
        \'${text_field.field_id}\', \'${hidden_field.field_id}\',
        \'${search_controller}\', \'${search_param}\', \'${result_name\
...

member_widgets

Value:
['text_field', 'hidden_field', 'fields', 'hidden_fields']

text_field

Value:
TextField(name='text', attrs={}, field_class='textfield', css_classes=\
[], convert=True)

hidden_field

Value:
HiddenField(name='hidden', attrs={}, field_class='hiddenfield', css_cl\
asses=[], convert=True)

params

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

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\
...