• Publicity: Public Only All

widget-procs.tcl

Form widgets for the ArsDigita Templating System

Location:
packages/acs-templating/tcl/widget-procs.tcl
Authors:
Karl Goldstein <karlg@arsdigita.com>
Stanislav Freidin <sfreidin@arsdigita.com>
CVS Identification:
$Id: widget-procs.tcl,v 1.63 2018/05/17 07:45:19 gustafn Exp $

Procedures in this file

Detailed information

template::data::transform::checkbox_text (public)

 template::data::transform::checkbox_text element_ref
Parameters:
element_ref
Returns:
Error:
Author:
Timo Hentschel <timo@timohentschel.de>
Created:
2004-10-17

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

Testcases:
No testcase defined.

template::data::transform::radio_text (public)

 template::data::transform::radio_text element_ref
Parameters:
element_ref
Returns:
Error:
Author:
Timo Hentschel <timo@timohentschel.de>
Created:
2004-10-17

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

Testcases:
No testcase defined.

template::data::transform::search (public)

 template::data::transform::search element_ref

Process a submitted search widget's data.

Parameters:
element_ref - Reference variable to the form element
Returns:
Transformed value

Partial Call Graph (max 5 caller/called nodes):
%3 db_list_of_lists db_list_of_lists (public) template::data::transform::search template::data::transform::search template::data::transform::search->db_list_of_lists

Testcases:
No testcase defined.

template::data::transform::select_text (public)

 template::data::transform::select_text element_ref
Parameters:
element_ref
Returns:
Error:
Author:
Dave Bauer <dave@thedesignexperience.org>
Created:
2004-07-18

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

Testcases:
No testcase defined.

template::data::validate::checkbox_text (public)

 template::data::validate::checkbox_text value_ref message_ref

validate a checkbox_other datatype

Parameters:
value_ref
message_ref

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

Testcases:
No testcase defined.

template::data::validate::party_search (public)

 template::data::validate::party_search value_ref message_ref

Validate the party search entry form.

Parameters:
value_ref - A reference to the value input by the user.
message_ref - 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):
%3

Testcases:
No testcase defined.

template::data::validate::radio_text (public)

 template::data::validate::radio_text value_ref message_ref

validate a radio_other datatype

Parameters:
value_ref
message_ref

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

Testcases:
No testcase defined.

template::data::validate::select_text (public)

 template::data::validate::select_text value_ref message_ref

validate a select_text datatype

Parameters:
value_ref
message_ref

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

Testcases:
No testcase defined.

template::util::checkbox_text::get_property (public)

 template::util::checkbox_text::get_property what checkbox_list
Parameters:
what
checkbox_list
Returns:
Error:
Author:
Timo Hentschel <timo@timohentschel.de>
Created:
2004-10-17

Partial Call Graph (max 5 caller/called nodes):
%3 template::widget::checkbox_text template::widget::checkbox_text (public) template::util::checkbox_text::get_property template::util::checkbox_text::get_property template::widget::checkbox_text->template::util::checkbox_text::get_property

Testcases:
No testcase defined.

template::util::radio_text::get_property (public)

 template::util::radio_text::get_property what radio_list
Parameters:
what
radio_list
Returns:
Error:
Author:
Timo Hentschel <timo@timohentschel.de>
Created:
2004-10-17

Partial Call Graph (max 5 caller/called nodes):
%3 template::widget::radio_text template::widget::radio_text (public) template::util::radio_text::get_property template::util::radio_text::get_property template::widget::radio_text->template::util::radio_text::get_property

Testcases:
No testcase defined.

template::util::select_text::get_property (public)

 template::util::select_text::get_property what select_text_list
Parameters:
what
select_text_list
Returns:
Error:
Author:
Dave Bauer <dave@thedesignexperience.org>
Created:
2004-07-18

Partial Call Graph (max 5 caller/called nodes):
%3 template::widget::select_text template::widget::select_text (public) template::util::select_text::get_property template::util::select_text::get_property template::widget::select_text->template::util::select_text::get_property

Testcases:
No testcase defined.

template::widget::attachment (public)

 template::widget::attachment element_reference tag_attributes

Render an attachment input widget.

Parameters:
element_reference - Reference variable to the form element
tag_attributes - HTML attributes to add to the tag
Returns:
Form HTML for widget

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

Testcases:
No testcase defined.

template::widget::block (public)

 template::widget::block element_reference tag_attributes

Widget for blocks of radio-buttoned questions

Parameters:
element_reference - Reference variable to the form element
tag_attributes - HTML attributes to add to the tag
Returns:
Form HTML for widget

Partial Call Graph (max 5 caller/called nodes):
%3 ad_decode ad_decode (public) template::widget::block template::widget::block template::widget::block->ad_decode

Testcases:
No testcase defined.

template::widget::button (public)

 template::widget::button element_reference tag_attributes

Render a button input widget.

Parameters:
element_reference - Reference variable to the form element
tag_attributes - HTML attributes to add to the tag
Returns:
Form HTML for widget

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

Testcases:
No testcase defined.

template::widget::checkbox (public)

 template::widget::checkbox element_reference tag_attributes

Render a checkbox input widget.

Parameters:
element_reference - Reference variable to the form element
tag_attributes - HTML attributes to add to the tag
Returns:
Form HTML for widget

Partial Call Graph (max 5 caller/called nodes):
%3 template::widget::menu template::widget::menu (public) template::widget::checkbox template::widget::checkbox template::widget::menu->template::widget::checkbox

Testcases:
No testcase defined.

template::widget::checkbox_text (public)

 template::widget::checkbox_text element_reference tag_attributes

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

Parameters:
element_reference
tag_attributes
Returns:
Error:
Author:
Timo Hentschel <timo@timohentschel.de>
Created:
2004-10-17

Partial Call Graph (max 5 caller/called nodes):
%3 _ _ (public) template::widget::checkbox_text template::widget::checkbox_text template::widget::checkbox_text->_

Testcases:
No testcase defined.

template::widget::comment (public)

 template::widget::comment element_reference tag_attributes

Render a comment widget.

Parameters:
element_reference - Reference variable to the form element
tag_attributes - HTML attributes to add to the tag
Returns:
Form HTML for widget

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

Testcases:
No testcase defined.

template::widget::file (public)

 template::widget::file element_reference tag_attributes

Generate a file widget.

Parameters:
element_reference - Reference variable to the form element
tag_attributes - HTML attributes to add to the tag
Returns:
Form HTML for widget

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

Testcases:
No testcase defined.

template::widget::hidden (public)

 template::widget::hidden element_reference tag_attributes
Parameters:
element_reference - Reference variable to the form element
tag_attributes - HTML attributes to add to the tag
Returns:
Form HTML for widget

Partial Call Graph (max 5 caller/called nodes):
%3 template::widget::input template::widget::input (public) template::widget::hidden template::widget::hidden template::widget::input->template::widget::hidden

Testcases:
No testcase defined.

template::widget::inform (public)

 template::widget::inform element_reference tag_attributes

A static information widget that does not submit any data

Parameters:
element_reference
tag_attributes

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

Testcases:
No testcase defined.

template::widget::input (public)

 template::widget::input type element_reference tag_attributes

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

Parameters:
type - The type of widget (checkbox, radio, text etc)
element_reference - Reference variable to the form element
tag_attributes - HTML attributes to hang on the input tag
Returns:
Form HTML for widget

Partial Call Graph (max 5 caller/called nodes):
%3 template::widget::attachment template::widget::attachment (public) template::widget::input template::widget::input template::widget::attachment->template::widget::input template::widget::button template::widget::button (public) template::widget::button->template::widget::input template::widget::checkbox template::widget::checkbox (public) template::widget::checkbox->template::widget::input template::widget::checkbox_text template::widget::checkbox_text (public) template::widget::checkbox_text->template::widget::input template::widget::file template::widget::file (public) template::widget::file->template::widget::input

Testcases:
No testcase defined.

template::widget::menu (public)

 template::widget::menu widget_name options_list values_list \
    attribute_reference [ mode ] [ widget_type ]

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

Parameters:
widget_name - Name of the widget
options_list - List of option/value pairs (i.e. dropdown menu items)
values_list - List of values (i.e. the selected default value)
attribute_reference - Reference variable to the caller's tag_attributes param
mode (defaults to "edit") - If "edit" the widget is rendered, otherwise values are passed along using hidden input HTML tags
widget_type (defaults to "select") - Select, checkbox, etc
Returns:
Form HTML for widget

Partial Call Graph (max 5 caller/called nodes):
%3 template::widget::ampmFragment template::widget::ampmFragment (public) template::widget::menu template::widget::menu template::widget::ampmFragment->template::widget::menu template::widget::category template::widget::category (public) template::widget::category->template::widget::menu template::widget::comment template::widget::comment (public) template::widget::comment->template::widget::menu template::widget::monthFragment template::widget::monthFragment (public) template::widget::monthFragment->template::widget::menu template::widget::multiselect template::widget::multiselect (public) template::widget::multiselect->template::widget::menu

Testcases:
No testcase defined.

template::widget::multiselect (public)

 template::widget::multiselect element_reference tag_attributes

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

Parameters:
element_reference - Reference variable to the form element
tag_attributes - HTML attributes to add to the tag
Returns:
Form HTML for widget

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

Testcases:
No testcase defined.

template::widget::party_search (public)

 template::widget::party_search element_reference tag_attributes

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 propably 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
tag_attributes
Author:
Tilmann Singer

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

Testcases:
No testcase defined.

template::widget::password (public)

 template::widget::password element_reference tag_attributes

Generate a password input widget.

Parameters:
element_reference - Reference variable to the form element
tag_attributes - HTML attributes to add to the tag
Returns:
Form HTML for widget

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

Testcases:
No testcase defined.

template::widget::radio (public)

 template::widget::radio element_reference tag_attributes

Render a radio input widget.

Parameters:
element_reference - Reference variable to the form element
tag_attributes - HTML attributes to add to the tag
Returns:
Form HTML for widget

Partial Call Graph (max 5 caller/called nodes):
%3 template::widget::menu template::widget::menu (public) template::widget::radio template::widget::radio template::widget::menu->template::widget::radio

Testcases:
No testcase defined.

template::widget::radio_text (public)

 template::widget::radio_text element_reference tag_attributes

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

Parameters:
element_reference
tag_attributes
Returns:
Error:
Author:
Timo Hentschel <timo@timohentschel.de>
Created:
2004-10-17

Partial Call Graph (max 5 caller/called nodes):
%3 _ _ (public) template::widget::radio_text template::widget::radio_text template::widget::radio_text->_

Testcases:
No testcase defined.

template::widget::search (public)

 template::widget::search element_reference tag_attributes

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)||'%'
            }}
        }
    }
Can be either a select widget initially if options supplied or a text box which on submit changes to a select widget.

Parameters:
element_reference - Reference variable to the form element
tag_attributes - If the "options" attribute is passed in, a select widget is created, otherwise a search text box.
Returns:
Form HTML for widget

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

Testcases:
No testcase defined.

template::widget::select (public)

 template::widget::select element_reference tag_attributes

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

Parameters:
element_reference - Reference variable to the form element
tag_attributes - HTML attributes to add to the tag
Returns:
Form HTML for widget

Partial Call Graph (max 5 caller/called nodes):
%3 template::widget::menu template::widget::menu (public) template::widget::select template::widget::select template::widget::menu->template::widget::select template::widget::party_search template::widget::party_search (public) template::widget::party_search->template::widget::select template::widget::search template::widget::search (public) template::widget::search->template::widget::select

Testcases:
No testcase defined.

template::widget::select_text (public)

 template::widget::select_text element_reference tag_attributes

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

Parameters:
element_reference
tag_attributes
Returns:
Error:
Author:
Dave Bauer <dave@thedesignexperience.org>
Created:
2004-07-18

Partial Call Graph (max 5 caller/called nodes):
%3 _ _ (public) template::widget::select_text template::widget::select_text template::widget::select_text->_

Testcases:
No testcase defined.

template::widget::submit (public)

 template::widget::submit element_reference tag_attributes

Render a submit input widget.

Parameters:
element_reference - Reference variable to the form element
tag_attributes - HTML attributes to add to the tag
Returns:
Form HTML for widget

Partial Call Graph (max 5 caller/called nodes):
%3 template::widget::attachment template::widget::attachment (public) template::widget::submit template::widget::submit template::widget::attachment->template::widget::submit

Testcases:
No testcase defined.

template::widget::text (public)

 template::widget::text element_reference tag_attributes

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

Parameters:
element_reference - Reference variable to the form element
tag_attributes - HTML attributes to add to the tag
Returns:
Form HTML for widget

Partial Call Graph (max 5 caller/called nodes):
%3 template::widget::richtext_or_file template::widget::richtext_or_file (public) template::widget::text template::widget::text template::widget::richtext_or_file->template::widget::text _ _ (public) template::widget::text->_

Testcases:
No testcase defined.

template::widget::textarea (public)

 template::widget::textarea element_reference tag_attributes

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

Parameters:
element_reference - Reference to the form element.
tag_attributes - Html attributes to set in the widget.
Returns:
Form HTML for widget

See Also:

Partial Call Graph (max 5 caller/called nodes):
%3 template::widget::comment template::widget::comment (public) template::widget::textarea template::widget::textarea template::widget::comment->template::widget::textarea _ _ (public) template::widget::textarea->_

Testcases:
No testcase defined.
[ show source ]