django.forms.widgets.Widget

class documentation

class Widget:

Known subclasses: django.contrib.gis.forms.widgets.BaseGeometryWidget, django.contrib.admin.widgets.RelatedFieldWidgetWrapper, django.contrib.auth.forms.ReadOnlyPasswordHashWidget, 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 ​_render 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 None 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
Instance Variable attrs Undocumented
Property is​_hidden Undocumented
def __deepcopy__(self, memo):
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):
overridden in django.contrib.gis.forms.widgets.BaseGeometryWidget, django.contrib.admin.widgets.RelatedFieldWidgetWrapper, 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 _render(self, template_name, context, renderer=None):

Undocumented

def build_attrs(self, base_attrs, extra_attrs=None):
Build an attribute dictionary.
def format_value(self, value):
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):
overridden in django.contrib.gis.forms.widgets.BaseGeometryWidget, django.contrib.admin.widgets.RelatedFieldWidgetWrapper, django.contrib.auth.forms.ReadOnlyPasswordHashWidget, django.contrib.gis.admin.OpenLayersWidget, 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_):
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 None 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):
Render the widget as an HTML string.
def subwidgets(self, name, value, attrs=None):
overridden in django.forms.widgets.ChoiceWidget

Undocumented

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

Undocumented

def value_from_datadict(self, data, files, name):
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):
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 =

Undocumented

is_required: bool =

Undocumented

needs_multipart_form: bool =
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 =
overridden in django.forms.widgets.DateTimeBaseInput, django.forms.widgets.SplitDateTimeWidget

Undocumented

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

Undocumented

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

Undocumented