django.forms.widgets.Widget

class documentation

class Widget: (source)

Known subclasses: django.contrib.admin.widgets.RelatedFieldWidgetWrapper, django.contrib.auth.forms.ReadOnlyPasswordHashWidget, django.contrib.gis.forms.widgets.BaseGeometryWidget, django.contrib.postgres.forms.array.SplitArrayWidget, django.forms.widgets.ChoiceWidget, django.forms.widgets.Input, django.forms.widgets.MultiWidget, django.forms.widgets.SelectDateWidget, django.forms.widgets.Textarea

View In Hierarchy

Undocumented

Method __deepcopy__ Undocumented
Method __init__ Undocumented
Method build_attrs Build an attribute dictionary.
Method format_value Return a value as it should appear when rendered in a template.
Method get_context Undocumented
Method id_for_label Return the HTML ID attribute of this Widget for use by a <label>, given the ID of the field. Return an empty string if no ID is available.
Method render Render the widget as an HTML string.
Method subwidgets Undocumented
Method use_required_attribute Undocumented
Method value_from_datadict Given a dictionary of data and this widget's name, return the value of this widget or None if it's not provided.
Method value_omitted_from_data Undocumented
Class Variable is_localized Undocumented
Class Variable is_required Undocumented
Class Variable needs_multipart_form Undocumented
Class Variable supports_microseconds Undocumented
Class Variable use_fieldset Undocumented
Instance Variable attrs Undocumented
Property is_hidden Undocumented
Method _render Undocumented
def __deepcopy__(self, memo): (source)
overridden in django.contrib.admin.widgets.RelatedFieldWidgetWrapper, django.contrib.postgres.forms.array.SplitArrayWidget, django.forms.widgets.ChoiceWidget, django.forms.widgets.MultiWidget

Undocumented

def __init__(self, attrs=None): (source)
overridden in django.contrib.admin.widgets.RelatedFieldWidgetWrapper, django.contrib.gis.forms.widgets.BaseGeometryWidget, django.contrib.postgres.forms.array.SplitArrayWidget, django.forms.widgets.ChoiceWidget, django.forms.widgets.Input, django.forms.widgets.MultiWidget, django.forms.widgets.SelectDateWidget, django.forms.widgets.Textarea

Undocumented

def build_attrs(self, base_attrs, extra_attrs=None): (source)

Build an attribute dictionary.

def format_value(self, value): (source)
overridden in django.contrib.admin.widgets.ManyToManyRawIdWidget, django.forms.widgets.CheckboxInput, django.forms.widgets.ChoiceWidget, django.forms.widgets.DateTimeBaseInput, django.forms.widgets.FileInput, django.forms.widgets.MultipleHiddenInput, django.forms.widgets.SelectDateWidget

Return a value as it should appear when rendered in a template.

def get_context(self, name, value, attrs): (source)
overridden in django.contrib.admin.widgets.RelatedFieldWidgetWrapper, django.contrib.auth.forms.ReadOnlyPasswordHashWidget, django.contrib.gis.admin.OpenLayersWidget, django.contrib.gis.forms.widgets.BaseGeometryWidget, django.contrib.postgres.forms.array.SplitArrayWidget, django.forms.widgets.ChoiceWidget, django.forms.widgets.Input, django.forms.widgets.MultiWidget, django.forms.widgets.SelectDateWidget

Undocumented

def id_for_label(self, id_): (source)
overridden in django.contrib.admin.widgets.RelatedFieldWidgetWrapper, django.contrib.auth.forms.ReadOnlyPasswordHashWidget, django.contrib.postgres.forms.array.SplitArrayWidget, django.forms.widgets.ChoiceWidget, django.forms.widgets.MultiWidget, django.forms.widgets.SelectDateWidget

Return the HTML ID attribute of this Widget for use by a <label>, given the ID of the field. Return an empty string if no ID is available. This hook is necessary because some widgets have multiple HTML elements and, thus, multiple IDs. In that case, this method should return an ID value that corresponds to the first ID in the widget's tags.

def render(self, name, value, attrs=None, renderer=None): (source)

Render the widget as an HTML string.

def subwidgets(self, name, value, attrs=None): (source)
overridden in django.forms.widgets.ChoiceWidget

Undocumented

def use_required_attribute(self, initial): (source)
overridden in django.forms.widgets.CheckboxSelectMultiple, django.forms.widgets.FileInput, django.forms.widgets.Select

Undocumented

def value_from_datadict(self, data, files, name): (source)
overridden in django.contrib.admin.widgets.ManyToManyRawIdWidget, django.contrib.admin.widgets.RelatedFieldWidgetWrapper, django.contrib.postgres.forms.array.SplitArrayWidget, django.forms.widgets.CheckboxInput, django.forms.widgets.ChoiceWidget, django.forms.widgets.FileInput, django.forms.widgets.MultipleHiddenInput, django.forms.widgets.MultiWidget, django.forms.widgets.SelectDateWidget

Given a dictionary of data and this widget's name, return the value of this widget or None if it's not provided.

def value_omitted_from_data(self, data, files, name): (source)
overridden in django.contrib.admin.widgets.RelatedFieldWidgetWrapper, django.contrib.postgres.forms.array.SplitArrayWidget, django.forms.widgets.CheckboxInput, django.forms.widgets.CheckboxSelectMultiple, django.forms.widgets.FileInput, django.forms.widgets.MultiWidget, django.forms.widgets.SelectDateWidget, django.forms.widgets.SelectMultiple

Undocumented

is_localized: bool = (source)

Undocumented

is_required: bool = (source)

Undocumented

needs_multipart_form: bool = (source)
overridden in django.contrib.admin.widgets.RelatedFieldWidgetWrapper, django.contrib.postgres.forms.array.SplitArrayWidget, django.forms.widgets.FileInput, django.forms.widgets.MultiWidget

Undocumented

supports_microseconds: bool = (source)
overridden in django.forms.widgets.DateTimeBaseInput, django.forms.widgets.SplitDateTimeWidget

Undocumented

use_fieldset: bool = (source)
overridden in django.forms.widgets.MultiWidget, django.forms.widgets.RadioSelect, django.forms.widgets.SelectDateWidget

Undocumented

attrs = (source)
overridden in django.contrib.admin.widgets.RelatedFieldWidgetWrapper, django.contrib.gis.forms.widgets.BaseGeometryWidget, django.forms.widgets.SelectDateWidget

Undocumented

@property
is_hidden = (source)
overridden in django.contrib.admin.widgets.RelatedFieldWidgetWrapper, django.contrib.postgres.forms.array.SplitArrayWidget, django.forms.widgets.MultiWidget

Undocumented

def _render(self, template_name, context, renderer=None): (source)

Undocumented