Home | Trees | Index | Help |
---|
|
object --+ | Field --+ | TextField --+ | ChoiceField --+ | EnumerationField
A field that contains an enumeral value.
The enumeral value is selected from an enumerated set of values. An enumeral field uses the following properties:
enumeration -- A mapping from enumeral names to enumeral values. Names are converted to strings, and values are stored as integers.
ordered -- If non-zero, the enumerals are presented to the user ordered by value.
|
|||
GetHelp(self)
Generate help text about this field in structured text format. |
|||
GetItems(self)
Return a sequence of enumerals. |
|||
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. |
|||
__init__(self,
name="",
default_value=None,
enumerals=[],
**properties)
Create an enumeration field. |
|||
Inherited from Inherited from Inherited from Inherited from |
|
|||
Inherited from Inherited from |
|
|
Return a sequence of enumerals. returns -- A sequence consisting of string enumerals objects, in the appropriate order.
|
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.
|
Generate a DOM element node for a value of this field. 'value' -- The value to represent. 'document' -- The containing DOM document node.
|
Create an enumeration field. 'enumerals' -- A sequence of strings of available enumerals. 'default_value' -- The default value for this enumeration. If 'None', the first enumeral is used.
|
Home | Trees | Index | Help |
---|
Generated by Epydoc 3.0alpha2 on Fri Sep 28 00:57:31 2007 | http://epydoc.sf.net |