qm :: fields :: ChoiceField :: Class ChoiceField

Class ChoiceField

object --+        
         |        
     Field --+    
             |    
     TextField --+
                 |
                ChoiceField

Known Subclasses:

A 'ChoiceField' allows choosing one of several values.

The set of acceptable values can be determined when the field is created or dynamically. The empty string is used as the "no choice" value, and cannot therefore be one of the permitted values.

Instance Methods

[hide private]

GetItems(self)
Return the options from which to choose.

source code

FormatValueAsHtml(self, server, value, style, name=None)
Return an HTML rendering of a 'value' for this field.

source code

Validate(self, value)
Validate a field value.

source code

Inherited from TextField: FormatValueAsText, GetHelp, GetValueFromDomNode, MakeDomNodeForValue, ParseFormValue, ParseTextValue, __init__

Inherited from Field: GetBriefDescription, GetDefaultValue, GetDescription, GetHtmlFormFieldName, GetHtmlHelp, GetName, GetSubfields, GetTitle, IsComputed, IsHidden, IsReadOnly, SetName, __repr__

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

Class Variables

[hide private]

Inherited from Field: form_field_prefix

Properties

[hide private]

Inherited from object: __class__

Method Details

[hide private]

GetItems(self)

source code

Return the options from which to choose.

returns -- A sequence of strings, each of which will be presented as a choice for the user.

FormatValueAsHtml(self, server, value, style, name=None)

source code

Return an HTML rendering of a 'value' for this field.

'server' -- The 'WebServer' in which the HTML will be displayed.

'value' -- The value for this field. May be 'None', which renders a default value (useful for blank forms).

'style' -- The rendering style. Can be "full" or "brief" (both read-only), or "new" or "edit" or "hidden".

'name' -- The name to use for the primary HTML form element containing the value of this field, if 'style' specifies the generation of form elements. If 'name' is 'None', the value returned by 'GetHtmlFormFieldName()' should be used.

returns -- A string containing the HTML representation of 'value'.

Overrides: Field.FormatValueAsHtml: (inherited documentation)

Validate(self, value)

source code

Validate a field value.

For an acceptable type and value, return the representation of 'value' in the underlying field storage.

'value' -- A value to validate for this field.

returns -- If the 'value' is valid, returns 'value' or an equivalent "canonical" version of 'value'. (For example, this function may search a hash table and return an equivalent entry from the hash table.)

This function must raise an exception if the value is not valid. The string representation of the exception will be used as an error message in some situations.

Implementations of this method must be idempotent.

Overrides: Field.Validate: (inherited documentation)