wiki:S3/S3GroupedOptionsWidget

Version 3 (modified by Dominic König, 9 years ago) ( diff )

--

S3GroupedOptionsWidget

Introduction

The S3GroupedOptionsWidget renders a SELECT element as table of radiobuttons/checkboxes:

MultipleOptionsWidgetS3GroupedOptionsWidget

The widget can also automatically group options lexicographically (by first letter):

MultipleOptionsWidgetS3GroupedOptionsWidget

The main use-case for S3GroupedOptionsWidget is filter forms where the user typically selects multiple options. However, the widget can also be used for single-option SELECTs - in this case the options would be rendered as radio buttons instead of checkboxes so the user can only select one option.

Python Widget Class

The S3GroupedOptionsWidget is implemented in /modules/s3/s3widgets.py.

The instance of this class receives the widget options:

from s3.s3widgets import S3GroupedOptionsWidget

instance = S3GroupedOptionsWidget(options=None, multiple=True, size=None, cols=None, help_field=None, none=None)

Parameters:

ParameterTypeExplanationDefault
optionslist of tuples [(value, label)], or as dict {value: label}the options, None to auto-detect the options from the Field during renderingNone
multiplebooleanmultiple options can be selected (False will render radio-buttons instead of checkboxes)True
sizeintegerthe maximum number of option in merged letter-groups (None to no group lexicographically)12
colsintegerthe number of options per row3
help_fieldstring or dict {value: tooltip-string}field in the referenced table to retrieve a tooltip text for each option (for foreign keys only), or a dict of tooltips, or a callable returning such a dictNone
nonebooleanRender "None" as regular optionFalse

To render the HTML for the widget and inject the necessary JavaScript, call the widget like:

widget = instance(field, value, **attributes)

Parameters:

ParameterTypeExplanationDefault
fieldFieldthe field to select options for (required)-
value the current value(s) selected (required)-
attributes HTML-attributes for the widget, e.g. "_class" or "_id"-

JQuery UI Widget

The S3GroupedOptionsWidget uses the groupedopts() widget in jquery.ui.groupedopts.js. This jQueryUI-widget-factory based widget renders a normal SELECT element as one or multiple groups of checkboxes:


Attachments (4)

Download all attachments as: .zip

Note: See TracWiki for help on using the wiki.