Package XSLForms :: Module Fields :: Class Form
[show private | hide private]
[frames | no frames]

Class Form

FieldProcessor --+
                 |
                Form


A collection of documents processed from form fields.

Method Summary
  __init__(self, *args, **kw)
Initialise the form data container with the general 'args' and 'kw' parameters.
  get_document(self, name)
Get the form data document with the given 'name' from the container, returning a DOM-style document object if such a document exists, or None if no such document can be found.
  get_documents(self)
Get the form data documents from the container, returning a dictionary mapping document names to DOM-style document objects.
  get_parameters(self)
Get the request parameters (or fields) from the container.
  get_selector(self, name, create)
Get the form data selectors for the given 'name', returning a collection of selected elements.
  get_selectors(self, create)
Get the form data selectors from the container, returning a dictionary mapping selector names to collections of selected elements.
  new_document(self, name)
Make a new document with the given 'name', storing it in the container and returning the document.
  new_instance(self, name)
Make a new document with the given 'name', storing it in the container and returning the document.
  set_document(self, name, doc)
Store in the container under the given 'name' the supplied document 'doc'.
  set_parameters(self, parameters)
Set the request 'parameters' (or fields) in the container.
    Inherited from FieldProcessor
  complete_documents(self, documents, fields)
Complete the given 'documents' using the 'fields' items list.
  complete_selectors(self, selectors, fields, documents, create)
Fill in the given 'selectors' dictionary using the given 'fields' so that it contains mappings from selector names to parts of the specified 'documents'.
  make_documents(self, fields)
Make a dictionary mapping model names to new documents prepared from the given 'fields' dictionary.

Method Details

__init__(self, *args, **kw)
(Constructor)

Initialise the form data container with the general 'args' and 'kw'
parameters.
Overrides:
XSLForms.Fields.FieldProcessor.__init__

get_document(self, name)

Get the form data document with the given 'name' from the container,
returning a DOM-style document object if such a document exists, or None
if no such document can be found.

get_documents(self)

Get the form data documents from the container, returning a dictionary
mapping document names to DOM-style document objects.

get_parameters(self)

Get the request parameters (or fields) from the container. Note that
these parameters comprise the raw form field values submitted in a
request rather than the structured form data.

Return a dictionary mapping parameter names to values.

get_selector(self, name, create=0)

Get the form data selectors for the given 'name', returning a collection
of selected elements. If 'create' is set to a true value (unlike the
default), the selected elements will be created in the form data
document if not already present.

get_selectors(self, create=0)

Get the form data selectors from the container, returning a dictionary
mapping selector names to collections of selected elements. If 'create'
is set to a true value (unlike the default), the selected elements will
be created in the form data document if not already present.
Overrides:
XSLForms.Fields.FieldProcessor.get_selectors

new_document(self, name)

Make a new document with the given 'name', storing it in the container
and returning the document.
Overrides:
XSLForms.Fields.FieldProcessor.new_instance

new_instance(self, name)

Make a new document with the given 'name', storing it in the container
and returning the document.
Overrides:
XSLForms.Fields.FieldProcessor.new_instance

set_document(self, name, doc)

Store in the container under the given 'name' the supplied document
'doc'.

set_parameters(self, parameters)

Set the request 'parameters' (or fields) in the container.

Generated by Epydoc 2.1 on Wed Jun 6 01:27:25 2007 http://epydoc.sf.net