l.a.b.l.InlineEditPickerWidget(WidgetBase) : class documentation

Part of lp.app.browser.lazrjs View In Hierarchy

Known subclasses: lp.app.browser.lazrjs.InlinePersonEditPickerWidget

Wrapper for the lazr-js picker widget.

This widget is not for editing form values like the VocabularyPickerWidget.

Method __init__ Create a widget wrapper.
Method picker_type Undocumented
Method selected_value_metadata Undocumented
Method selected_value String representation of field value associated with the picker.
Method config Undocumented
Method getConfig Undocumented
Method json_config Undocumented
Method vocabulary Undocumented
Method vocabulary_filters Undocumented
Method show_search_box Undocumented

Inherited from WidgetBase:

Method resource_uri A local path to the context object.
Method json_resource_uri Undocumented
Method can_write Can the current user write to the attribute.
def __init__(self, context, exported_field, default_html, content_box_id=None, header='Select an item', step_title='Search', null_display_value='None', edit_view='+edit', edit_url=None, edit_title='', help_link=None):
Create a widget wrapper.
ParameterscontextThe object that is being edited.
exported_fieldThe attribute being edited. This should be a field from an interface of the form ISomeInterface['fieldname']
default_htmlDefault display of attribute.
content_box_idThe HTML id to use for this widget. Automatically generated if this is not provided.
headerThe large text at the top of the picker.
step_titleSmaller line of text below the header.
null_display_valueThis will be shown for a missing value
edit_viewThe view name to use to generate the edit_url if one is not specified.
edit_urlThe URL to use for editing when the user isn't logged in and when JS is off. Defaults to the edit_view on the context.
edit_titleUsed to set the title attribute of the anchor.
@property
def picker_type(self):
Undocumented
@property
def selected_value_metadata(self):
Undocumented
@property
def selected_value(self):
String representation of field value associated with the picker.

Default implementation is to return the 'name' attribute.

@property
def config(self):
Undocumented
def getConfig(self):
Undocumented
@property
def json_config(self):
Undocumented
@cachedproperty
def vocabulary(self):
Undocumented
@cachedproperty
def vocabulary_filters(self):
Undocumented
@property
def show_search_box(self):
Undocumented
API Documentation for Launchpad, generated by pydoctor at 2022-06-16 00:00:12.