Home       Trees       Indices       Help   
qm :: fields :: TupleField :: Class TupleField
[hide private]
[frames] | no frames]

Class TupleField

source code

object --+    
         |    
     Field --+
             |
            TupleField

A 'TupleField' contains zero or more other 'Field' objects.

The contained 'Field' objects may have different types. The value of a 'TupleField' is a Python list; the values in the list correspond to the values of the contained 'Field' objects. For example, '["abc", 3]' would be a valid value for a 'TupleField' containing a 'TextField' and an 'IntegerField'.

Instance Methods [hide private]
 
__init__(self, name='', fields=None, **properties)
Construct a new 'TupleField'.		 source code
 
GetHelp(self)
Generate help text about this field in structured text format.		 source code
 
GetSubfields(self)
Returns the sequence of subfields contained in this field.		 source code
 
FormatValueAsHtml(self, server, value, style, name=None)
Return an HTML rendering of a 'value' for this field.		 source code
 
MakeDomNodeForValue(self, value, document)
Generate a DOM element node for a value of this field.		 source code
 
Validate(self, value)
Validate a field value.		 source code
 
ParseFormValue(self, request, name, attachment_stores)
Convert a value submitted from an HTML form.		 source code
 
GetValueFromDomNode(self, node, attachment_store)
Return a value for this field represented by DOM 'node'.		 source code

Inherited from Field: FormatValueAsText, GetBriefDescription, GetDefaultValue, GetDescription, GetHtmlFormFieldName, GetHtmlHelp, GetName, GetTitle, IsComputed, IsHidden, IsReadOnly, ParseTextValue, 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]

__init__(self, name='', fields=None, **properties)
(Constructor)

source code 

Construct a new 'TupleField'.

'name' -- The name of the field.

'fields' -- A sequence of 'Field' instances.

The new 'TupleField' stores a list whose elements correspond to the 'fields'.

Overrides: object.__init__

GetHelp(self)

source code 

Generate help text about this field in structured text format.

Overrides: Field.GetHelp
(inherited documentation)

GetSubfields(self)

source code 

Returns the sequence of subfields contained in this field.

returns -- The sequence of subfields contained in this field. If there are no subfields, an empty sequence is returned.

Overrides: Field.GetSubfields
(inherited documentation)

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)

MakeDomNodeForValue(self, value, document)

source code 

Generate a DOM element node for a value of this field.

'value' -- The value to represent.

'document' -- The containing DOM document node.

Overrides: Field.MakeDomNodeForValue
(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)

ParseFormValue(self, request, name, attachment_stores)

source code 

Convert a value submitted from an HTML form.

'request' -- The 'WebRequest' containing a value corresponding to this field.

'name' -- The name corresponding to this field in the 'request'.

'attachment_stores' -- A dictionary mapping 'AttachmentStore' ids (in the sense of Python's 'id' built-in) to the 'AttachmentStore's themselves.

returns -- A pair '(value, redisplay)'. 'value' is the value for this field, as indicated in 'request'. 'redisplay' is true if and only if the form should be redisplayed, rather than committed. If an error occurs, an exception is thrown.

Overrides: Field.ParseFormValue
(inherited documentation)

GetValueFromDomNode(self, node, attachment_store)

source code 

Return a value for this field represented by DOM 'node'.

This method does not validate the value for this particular instance; it only makes sure the node is well-formed, and returns a value of the correct Python type.

'node' -- The DOM node that is being evaluated.

'attachment_store' -- For attachments, the store that should be used.

If the 'node' is incorrectly formed, this method should raise an exception.

Overrides: Field.GetValueFromDomNode
(inherited documentation)

   Home       Trees       Indices       Help   
Generated by Epydoc 3.0.1 on Fri Dec 23 12:30:40 2011 http://epydoc.sourceforge.net