Package s3 :: Module s3widgets
[frames] | no frames]

Module s3widgets

source code

Custom UI Widgets

@requires: U{B{I{gluon}} <http://web2py.com>}

@copyright: 2009-2019 (c) Sahana Software Foundation
@license: MIT

Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation
files (the "Software"), to deal in the Software without
restriction, including without limitation the rights to use,
copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following
conditions:

The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.

NB Widgets are processed upon form submission (before form validation)
   in addition to when generating new forms (so are often processed twice)

Classes
  S3ACLWidget
Widget class for ACLs
  S3AddObjectWidget
This widget displays an inline form loaded via AJAX on demand.
  S3AddPersonWidget
Widget for person_id (future also: human_resource_id) fields that allows to either select an existing person (autocomplete), or to create a new person record inline
  S3AgeWidget
Widget to accept and represent date of birth as age in years, mapping the age to a pseudo date-of-birth internally so that it progresses over time; contains both widget and representation method
  S3AutocompleteWidget
Renders a SELECT as an INPUT field with AJAX Autocomplete
  S3BooleanWidget
Standard Boolean widget, with an option to hide/reveal fields conditionally.
  S3ColorPickerWidget
Displays a widget to allow the user to pick a color, and falls back to using JSColor or a regular text input if necessary.
  S3CalendarWidget
Widget to select a date from a popup calendar, with optional time input
  S3DateWidget
Standard Date widget
  S3DateTimeWidget
Date and/or time picker widget based on jquery.ui.datepicker and jquery.ui.timepicker.addon.js.
  S3HoursWidget
Widget to enter a duration in hours (e.g.
  S3EmbeddedComponentWidget
Widget used by S3CRUD for link-table components with actuate="embed".
  S3GroupedOptionsWidget
Widget with checkboxes or radio buttons for S3OptionsFilter...
  S3HiddenWidget
Standard String widget, but with a class of hide...
  S3HumanResourceAutocompleteWidget
Renders an hrm_human_resource SELECT as an INPUT field with AJAX Autocomplete.
  S3ImageCropWidget
Allows the user to crop an image and uploads it.
  S3InvBinWidget
Widget used by S3CRUD to offer the user matching bins where stock items can be placed
  S3KeyValueWidget
Allows for input of key-value pairs and stores them as list:string
  S3LocationAutocompleteWidget
Renders a gis_location SELECT as an INPUT field with AJAX Autocomplete
  S3LocationDropdownWidget
Renders a dropdown for an Lx level of location hierarchy
  S3LocationLatLonWidget
Renders a Lat & Lon input for a Location
  S3Selector
Base class for JSON-based complex selectors (e.g.
  S3LocationSelector
Form widget to select a location_id that can also create/update the location
  S3SelectWidget
Standard OptionsWidget, but using the jQuery UI SelectMenu: http://jqueryui.com/selectmenu/
  S3MultiSelectWidget
Standard MultipleOptionsWidget, but using the jQuery UI:...
  S3CascadeSelectWidget
Cascade Selector for Hierarchies
  S3HierarchyWidget
Selector Widget for Hierarchies
  S3OrganisationAutocompleteWidget
Renders an org_organisation SELECT as an INPUT field with AJAX Autocomplete.
  S3OrganisationHierarchyWidget
Renders an organisation_id SELECT as a menu
  S3PersonAutocompleteWidget
Renders a pr_person SELECT as an INPUT field with AJAX Autocomplete.
  S3PentityAutocompleteWidget
Renders a pr_pentity SELECT as an INPUT field with AJAX Autocomplete.
  S3PriorityListWidget
Widget to broadcast facility needs
  S3SiteAutocompleteWidget
Renders an org_site SELECT as an INPUT field with AJAX Autocomplete.
  S3SliderWidget
Standard Slider Widget
  S3StringWidget
Extend the default Web2Py widget to include a Placeholder
  S3TimeIntervalWidget
Simple time interval widget for the scheduler task table
  S3FixedOptionsWidget
Non-introspective options widget
  CheckboxesWidgetS3
S3 version of gluon.sqlhtml.CheckboxesWidget: - configurable number of columns - supports also integer-type keys in option sets - has an identifiable class for styling
  S3PasswordWidget
Widget for password fields, allows unmasking of passwords
  S3PhoneWidget
Extend the default Web2Py widget to ensure that the + is at the beginning not the end in RTL.
  S3XMLContents
Renderer for db-stored XML contents (e.g.
  S3QuestionWidget
A Question widget which takes attributes of a typical question as input and converts it into a JSON
  S3TagCheckboxWidget
Simple widget to use a checkbox to toggle a string-type Field between two values (default "Y"|"N").
  ICON
Helper class to render <i> tags for icons, mapping abstract icon names to theme-specific CSS classes.
Functions
 
s3_comments_widget(field, value, **attr)
A smaller-than-normal textarea to be used by the s3.comments() & gis.desc_field Reusable fields
source code
 
s3_richtext_widget(field, value)
A Rich Text field to be used by the CMS Post Body, etc...
source code
 
search_ac(r, **attr)
JSON search method for S3AutocompleteWidget
source code
Function Details

s3_comments_widget(field, value, **attr)

source code 

A smaller-than-normal textarea to be used by the s3.comments() & gis.desc_field Reusable fields

s3_richtext_widget(field, value)

source code 

A Rich Text field to be used by the CMS Post Body, etc
- uses CKEditor
- requires doc module loaded to be able to upload/browse Images

search_ac(r, **attr)

source code 

JSON search method for S3AutocompleteWidget

Parameters:
  • r - the S3Request
  • attr - request attributes