---

Class ::Generic::Form

::Generic::Form create ... \
           [ -action (default "[::xo::cc url]") ] \
           [ -add_page_title add_page_title ] \
           [ -data data ] \
           [ -edit_page_title edit_page_title ] \
           [ -fields fields ] \
           [ -folder_id (default "-100") ] \
           [ -html (default "") ] \
           [ -name (default "[namespace tail [self]]") ] \
           [ -package_id (default "") ] \
           [ -submit_link (default ".") ] \
           [ -validate (default "") ] \
           [ -with_categories (default "false") ]

This class was designed together with the content repository class ::xo::db::CrClass for the generation of HTML forms, but it can be used also with different classes. The only hard requirement is the presence of an 'item_id' form field. For generic acs_objects, 'item_id' will correspond to 'object_id' column in 'acs_objects' table. For content repository items, 'item_id' will be the column by the same name in cr_revisions/cr_items.

Documented Parameters:

add_page_title

page title when adding content items

edit_page_title

page title when editing content items

data

data object (e.g. instance if CrItem)

folder_id

associated folder id. Will default to data's 'parent_id' variable. If 'parent_id' is missing too, package's 'folder_id' will be used.

name

name of the form, used for naming the template, defaults to the object name

package_id

package_id of the object. Will default to data's 'package_id' variable

submit_link

link for page after submit

with_categories

display form with categories (default false)

Defined in packages/xotcl-core/tcl/generic-procs.tcl

Class Relations

• class: ::xotcl::Class
• superclass: ::xotcl::Object
• subclass: ::xowiki::WikiForm

Methods (to be applied on instances)

• action (setter)

• add_page_title (setter)

• after_submit (scripted)

• data (setter)

• edit_data (scripted)

• edit_page_title (setter)

• edit_request (scripted)

• fields (setter)

• folder_id (setter)

• form_vars (scripted)

• generate (scripted, public)

   <instance of Generic::Form> generate [ -template template ] \
      [ -mode mode ] [ -export export ]

  The method generate is used to actually generate the form template from the specifications and to set up page_title and context when appropriate.

  Switches:

  -template

  (defaults to "formTemplate") (optional)

  is the name of the Tcl variable to contain the filled in template

  -mode

  (defaults to "edit") (optional)

  -export

  (optional)

  list of attribute value pairs to be exported to the form (nested list)

  Partial Call Graph (max 5 caller/called nodes):

  Testcases:

  xowiki_test_cases

• get_id_field (scripted)

• html (setter)

• init (scripted)

• name (setter)

• new_data (scripted)

• new_request (scripted)

• on_submit (scripted)

• on_validation_error (scripted)

• package_id (setter)

• request (scripted)

• set_form_data (scripted)

• submit_link (setter)

• validate (setter)

• with_categories (setter)

---