Parameters:

element_ref (required)

Returns:

Error:

Author:

Timo Hentschel <timo@timohentschel.de>

Created:

2004-10-17

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

Testcases:

No testcase defined.

Do the actual search of parties using the input value and return a list of lists consisting of (party_name, party_id). DRB: The blank string check should actually be in the validate procedure.

Parameters:

element_ref (required)

Reference variable to the form element.

Returns:

search result or error

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

Testcases:

No testcase defined.

Parameters:

element_ref (required)

Returns:

Error:

Author:

Timo Hentschel <timo@timohentschel.de>

Created:

2004-10-17

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

Testcases:

No testcase defined.

Process a submitted search widget's data.

Parameters:

element_ref (required)

Reference variable to the form element

Returns:

Transformed value

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

Testcases:

No testcase defined.

Parameters:

element_ref (required)

Returns:

Error:

Author:

Dave Bauer <dave@thedesignexperience.org>

Created:

2004-07-18

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

Testcases:

No testcase defined.

validate a checkbox_other datatype

Parameters:

value_ref (required)

message_ref (required)

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

Testcases:

validate_text

Validate the party search entry form.

Parameters:

value_ref (required)

A reference to the value input by the user.

message_ref (required)

A reference to the form element error field.

Returns:

true - all input for this datatype is valid.

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

Testcases:

validate_search

validate a radio_other datatype

Parameters:

value_ref (required)

message_ref (required)

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

Testcases:

validate_text

validate a select_text datatype

Parameters:

value_ref (required)

message_ref (required)

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

Testcases:

validate_text

Parameters:

what (required)

checkbox_list (required)

Returns:

Error:

Author:

Timo Hentschel <timo@timohentschel.de>

Created:

2004-10-17

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

Testcases:

No testcase defined.

Parameters:

what (required)

radio_list (required)

Returns:

Error:

Author:

Timo Hentschel <timo@timohentschel.de>

Created:

2004-10-17

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

Testcases:

No testcase defined.

Parameters:

what (required)

select_text_list (required)

Returns:

Error:

Author:

Dave Bauer <dave@thedesignexperience.org>

Created:

2004-07-18

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

Testcases:

No testcase defined.

The template::widget namespace contains the code for the various input widgets.

See Also:

• template::widget::ampmFragment
• template::widget::block
• template::widget::button
• template::widget::checkbox
• template::widget::checkbox_text
• template::widget::color
• template::widget::comment
• template::widget::currency
• template::widget::date
• template::widget::dateFragment
• template::widget::email
• template::widget::file
• template::widget::hidden
• template::widget::inform
• template::widget::input
• template::widget::menu
• template::widget::monthFragment
• template::widget::multiselect
• template::widget::number
• template::widget::numericRange
• template::widget::password
• template::widget::party_search
• template::widget::radio
• template::widget::radio_text
• template::widget::search
• template::widget::select
• template::widget::select_text
• template::widget::submit
• template::widget::tel
• template::widget::text
• template::widget::textarea
• template::widget::url
• template::element::create
• template::util::richtext

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

Testcases:

No testcase defined.

Render an attachment input widget.

Parameters:

element_reference (required)

Reference variable to the form element

tag_attributes (required)

HTML attributes to add to the tag

Returns:

Form HTML for widget

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

Testcases:

No testcase defined.

Widget for blocks of radio-buttoned questions

Parameters:

element_reference (required)

Reference variable to the form element

tag_attributes (required)

HTML attributes to add to the tag

Returns:

Form HTML for widget

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

Testcases:

No testcase defined.

Render a button input widget.

Parameters:

element_reference (required)

Reference variable to the form element

tag_attributes (required)

HTML attributes to add to the tag

Returns:

Form HTML for widget

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

Testcases:

No testcase defined.

Render a checkbox input widget.

Parameters:

element_reference (required)

Reference variable to the form element

tag_attributes (required)

HTML attributes to add to the tag

Returns:

Form HTML for widget

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

Testcases:

No testcase defined.

Implements the complex widget checkbox_other which combines a checkbox widget with a text widget

Parameters:

element_reference (required)

tag_attributes (required)

Returns:

Error:

Author:

Timo Hentschel <timo@timohentschel.de>

Created:

2004-10-17

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

Testcases:

No testcase defined.

Render a color input widget.

Parameters:

element_reference (required)

Reference variable to the form element

tag_attributes (required)

HTML attributes to add to the tag

Returns:

Form HTML for widget

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

Testcases:

No testcase defined.

Render a comment widget.

Parameters:

element_reference (required)

Reference variable to the form element

tag_attributes (required)

HTML attributes to add to the tag

Returns:

Form HTML for widget

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

Testcases:

No testcase defined.

Render a email input widget.

Parameters:

element_reference (required)

Reference variable to the form element

tag_attributes (required)

HTML attributes to add to the tag

Returns:

Form HTML for widget

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

Testcases:

No testcase defined.

Generate a file widget.

Parameters:

element_reference (required)

Reference variable to the form element

tag_attributes (required)

HTML attributes to add to the tag

Returns:

Form HTML for widget

See Also:

• template::util::file_transform

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

Testcases:

template_widget_file

Parameters:

element_reference (required)

Reference variable to the form element

tag_attributes (required)

HTML attributes to add to the tag

Returns:

Form HTML for widget

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

Testcases:

No testcase defined.

A static information widget that does not submit any data

Parameters:

element_reference (required)

tag_attributes (required)

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

Testcases:

No testcase defined.

General proc used by a wide variety of widgets to output input HTML tags.

Parameters:

type (required)

The type of widget (checkbox, radio, text etc)

element_reference (required)

Reference variable to the form element

tag_attributes (required)

HTML attributes to hang on the input tag

Returns:

Form HTML for widget

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

Testcases:

No testcase defined.

Render a menu widget (a "select" dropdown menu by default).

Parameters:

widget_name (required)

Name of the widget

options_list (required)

List of option/value pairs (i.e. dropdown menu items)

values_list (required)

List of values (i.e. the selected default value)

attribute_reference (required)

Reference variable to the caller's tag_attributes param

mode (optional, defaults to "edit")

If "edit" the widget is rendered, otherwise values are passed along using hidden input HTML tags

widget_type (optional, defaults to "select")

Select, checkbox, etc

Returns:

Form HTML for widget

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

Testcases:

No testcase defined.

Consolidates the logics to compute the final tag attributes by merging those explicitly supplied and those in the element definition.

Parameters:

element_reference (required)

tag_attributes (required)

Returns:

dict

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

Testcases:

No testcase defined.

Render a select widget which allows any number of values to be selected.

Parameters:

element_reference (required)

Reference variable to the form element

tag_attributes (required)

HTML attributes to add to the tag

Returns:

Form HTML for widget

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

Testcases:

No testcase defined.

Render a number input widget.

Parameters:

element_reference (required)

Reference variable to the form element

tag_attributes (required)

HTML attributes to add to the tag

Returns:

Form HTML for widget

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

Testcases:

No testcase defined.

A widget that searches for parties (persons, groups and relational_segments) and lets the user select one from the search results.

It only searches in all parties from the system currently. It should probably be extended to allow one to restrict the search to a specific subsite, as well as searching only for groups or persons.

Parameters:

element_reference (required)

tag_attributes (required)

Author:

Tilmann Singer

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

Testcases:

No testcase defined.

Generate a password input widget.

Parameters:

element_reference (required)

Reference variable to the form element

tag_attributes (required)

HTML attributes to add to the tag

Returns:

Form HTML for widget

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

Testcases:

No testcase defined.

Render a radio input widget.

Parameters:

element_reference (required)

Reference variable to the form element

tag_attributes (required)

HTML attributes to add to the tag

Returns:

Form HTML for widget

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

Testcases:

No testcase defined.

Implements the complex widget radio_text which combines a radio widget with a text widget

Parameters:

element_reference (required)

tag_attributes (required)

Returns:

Error:

Author:

Timo Hentschel <timo@timohentschel.de>

Created:

2004-10-17

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

Testcases:

No testcase defined.

Return a widget consisting of either a search box or a search pull-down list. Here is an example of using the search widget with ad_form:

    ad_form -name test -form {
        {user:search,optional
            {result_datatype integer}
            {label "Email"}
            {help_text "Search for a user by email address"}
            {search_query {
                select email from cc_users where lower(email) like '%'||lower(:value)||'%'
            }}
        }
    }

Parameters:

element_reference (required)

Reference variable to the form element

tag_attributes (required)

If the "options" attribute is passed in, a select widget is created, otherwise a search box.

Returns:

Form HTML for widget

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

Testcases:

No testcase defined.

Render a select widget which allows only one value to be selected.

Parameters:

element_reference (required)

Reference variable to the form element

tag_attributes (required)

HTML attributes to add to the tag

Returns:

Form HTML for widget

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

Testcases:

No testcase defined.

Implements the complex widget select_text which combines a select widget with a text widget

Parameters:

element_reference (required)

tag_attributes (required)

Returns:

Error:

Author:

Dave Bauer <dave@thedesignexperience.org>

Created:

2004-07-18

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

Testcases:

No testcase defined.

Render a submit input widget.

Parameters:

element_reference (required)

Reference variable to the form element

tag_attributes (required)

HTML attributes to add to the tag

Returns:

Form HTML for widget

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

Testcases:

No testcase defined.

Render a tel input widget.

Parameters:

element_reference (required)

Reference variable to the form element

tag_attributes (required)

HTML attributes to add to the tag

Returns:

Form HTML for widget

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

Testcases:

No testcase defined.

Generate a text widget (not to be confused with textarea)

Parameters:

element_reference (required)

Reference variable to the form element

tag_attributes (required)

HTML attributes to add to the tag

Returns:

Form HTML for widget

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

Testcases:

No testcase defined.

A widget for the HTML form input textarea element. Includes spellchecker.

Parameters:

element_reference (required)

Reference to the form element.

tag_attributes (required)

Html attributes to set in the widget.

Returns:

Form HTML for widget

See Also:

• template::util::spellcheck::spellcheck_properties

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

Testcases:

No testcase defined.

Do the actual construction of a textarea widget, called by various user-callable widgets.

Parameters:

name (required)

Name of the widget.

attribute_reference (required)

Reference variable to the tag_attributes passed to the calling widget proc.

value (optional)

Optional value

mode (optional, defaults to "edit")

If edit, output the textarea HTML, otherwise pass along the value (if it exists) in a hidden HTML input tag

tag (optional, defaults to "textarea")

Returns:

Form HTML for widget

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

Testcases:

No testcase defined.

Render a URL input widget.

Parameters:

element_reference (required)

Reference variable to the form element

tag_attributes (required)

HTML attributes to add to the tag

Returns:

Form HTML for widget

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

Testcases:

No testcase defined.