| Home | Trees | Indices | Help |
|
|---|
|
|
object --+
|
S3SQLFormElement --+
|
S3SQLSubForm --+
|
S3SQLInlineComponent --+
|
S3SQLInlineLink
Subform to edit link table entries for the master record
Constructor options:
** Common options:
readonly..........True|False......render read-only always
multiple..........True|False......allow selection of multiple
options (default True)
widget............string..........which widget to use, one of:
- multiselect (default)
- groupedopts (default when cols is specified)
- hierarchy (requires hierarchical lookup-table)
- cascade (requires hierarchical lookup-table)
render_list.......True|False......in read-only mode, render HTML
list rather than comma-separated
strings (default False)
** Options for groupedopts widget:
cols..............integer.........number of columns for grouped
options (default: None)
orientation.......string..........orientation for grouped options
order, one of:
- cols
- rows
size..............integer.........maximum number of items per group
in grouped options, None to disable
grouping
sort..............True|False......sort grouped options (always True
when grouping, i.e. size!=None)
help_field........string..........additional field in the look-up
table to render as tooltip for
grouped options
table.............True|False......render grouped options as HTML
TABLE rather than nested DIVs
(default True)
** Options for multi-select widget:
header............True|False......multi-select to show a header with
bulk-select options and optional
search-field
search............True|False......show the search-field in the header
selectedList......integer.........how many items to show on multi-select
button before collapsing into number
noneSelectedText..string..........placeholder text on multi-select button
columns...........integer.........Foundation column-width for the
widget (for custom forms)
** Options-filtering:
- multiselect and groupedopts only
- for hierarchy and cascade widgets, use the "filter" option
requires..........Validator.......validator to determine the
selectable options (defaults to
field validator)
filterby..........field selector..filter look-up options by this field
(can be a field in the look-up table
itself or in another table linked to it)
options...........value|list......filter for these values, or:
match.............field selector..lookup the filter value from this
field (can be a field in the master
table, or in linked table)
** Options for hierarchy and cascade widgets:
levels............list............ordered list of labels for hierarchy
levels (top-down order), to override
the lookup-table's "hierarchy_levels"
setting, cascade-widget only
represent.........callback........representation method for hierarchy
nodes (defaults to field represent)
leafonly..........True|False......only leaf nodes can be selected
cascade...........True|False......automatically select the entire branch
when a parent node is newly selected;
with multiple=False, this will
auto-select single child options
(default True when leafonly=True)
filter............resource query..filter expression to filter the
selectable options
| Instance Methods | |||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
Inherited from Inherited from Inherited from |
|||
| Class Variables | |
prefix = "link"
|
|
| Properties | |
|
Inherited from |
| Method Details |
Get all existing links for record_id.
|
Widget renderer, currently supports multiselect (default), hierarchy and groupedopts widgets.
|
Validate this link, currently only checking whether it has a value when required=True
|
Post-processes this subform element against the POST data, and create/update/delete any related records.
To Do: implement audit |
Read-only representation of this subform.
|
Get the options for the widget
|
Find the target component and its linktable
|
| Class Variable Details |
prefix
|
| Home | Trees | Indices | Help |
|
|---|
| Generated by Epydoc 3.0.1 on Fri Mar 15 08:51:49 2019 | http://epydoc.sourceforge.net |