• 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.52.2.8 2016/10/03 18:52:07 antoniop 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

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

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

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

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

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.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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 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

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

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

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

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

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

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

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

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

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:
[ show source ]