qm.fields.ChoiceField

Package qm :: Module fields :: Class ChoiceField

[show private | hide private]

Type ChoiceField

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

Known Subclasses:: EnumerationField, ResourceField, TestField

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.

Method Summary
	`FormatValueAsHtml(self, server, value, style, name)` Return an HTML rendering of a 'value' for this field.
	`GetItems(self)` Return the options from which to choose.
	`Validate(self, value)` Validate a field value.
Inherited from TextField
	`__init__(self, name, default_value, multiline, structured, verbatim, not_empty_text, **properties)` Construct a new 'TextField'.
	`FormatValueAsText(self, value, columns)` Return a plain text rendering of a 'value' for this field.
	`GetHelp(self)` Generate help text about this field in structured text format.
	`GetValueFromDomNode(self, node, attachment_store)` Return a value for this field represented by DOM 'node'.
	`MakeDomNodeForValue(self, value, document)` Generate a DOM element node for a value of this field.
	`ParseFormValue(self, request, name, attachment_stores)` Convert a value submitted from an HTML form.
	`ParseTextValue(self, value)` Parse a value represented as a string.
Inherited from Field
	`__repr__(self)`
	`GetBriefDescription(self)` Return a brief description of this field.
	`GetDefaultValue(self)` Return the default value for this field.
	`GetDescription(self)` Return a description of this field.
	`GetHtmlFormFieldName(self)` Return the form field name corresponding this field.
	`GetHtmlHelp(self, edit)` Generate help text about this field in HTML format.
	`GetName(self)` Return the name of the field.
	`GetSubfields(self)` Returns the sequence of subfields contained in this field.
	`GetTitle(self)` Return the user-friendly title of the field.
	`IsComputed(self)` Returns true if this field is computed automatically.
	`IsHidden(self)` Returns true if this 'Field' should be hidden from users.
	`IsReadOnly(self)` Returns true if this 'Field' cannot be modified by users.
	`SetName(self, name)` Set the name of the field.
Inherited from object
	`__delattr__(...)` x.__delattr__('name') <==> del x.name
	`__getattribute__(...)` x.__getattribute__('name') <==> x.name
	`__hash__(x)` x.__hash__() <==> hash(x)
	`__new__(T, S, ...)` T.__new__(S, ...) -> a new object with type S, a subtype of T
	`__reduce__(...)` helper for pickle
	`__reduce_ex__(...)` helper for pickle
	`__setattr__(...)` x.__setattr__('name', value) <==> x.name = value
	`__str__(x)` x.__str__() <==> str(x)

Class Variable Summary
Inherited from Field
`str`	`form_field_prefix` = `'_field_'`

Method Details

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

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:: qm.fields.TextField.FormatValueAsHtml (inherited documentation)

GetItems(self)

Return the options from which to choose.

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

Validate(self, value)

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:: qm.fields.TextField.Validate (inherited documentation)

Generated by Epydoc 2.1 on Thu Sep 27 15:49:05 2007

http://epydoc.sf.net