Source code for fobi.contrib.plugins.form_elements.fields.slider.forms
from django import forms
from django.utils.translation import gettext_lazy as _
from fobi.base import BaseFormFieldPluginForm, get_theme
from fobi.helpers import get_select_field_choices
from fobi.widgets import NumberInput
from .constants import (
SLIDER_DEFAULT_HANDLE,
SLIDER_DEFAULT_SHOW_ENDPOINTS_AS,
SLIDER_DEFAULT_TOOLTIP,
SLIDER_HANDLE_CHOICES,
SLIDER_HANDLE_CUSTOM,
SLIDER_HANDLE_TRIANGLE,
SLIDER_SHOW_ENDPOINTS_AS_CHOICES,
SLIDER_SHOW_ENDPOINTS_AS_LABELED_TICKS,
SLIDER_SHOW_ENDPOINTS_AS_TICKS,
SLIDER_TOOLTIP_CHOICES,
)
from .settings import (
INITIAL,
INITIAL_MAX_VALUE,
INITIAL_MIN_VALUE,
MAX_VALUE,
MIN_VALUE,
STEP,
)
__title__ = "fobi.contrib.plugins.form_elements.fields.slider.forms"
__author__ = "Artur Barseghyan <artur.barseghyan@gmail.com>"
__copyright__ = "2014-2015 Artur Barseghyan"
__license__ = "GPL 2.0/LGPL 2.1"
__all__ = ("SliderInputForm",)
theme = get_theme(request=None, as_instance=True)
[docs]class SliderInputForm(forms.Form, BaseFormFieldPluginForm):
"""Form for ``SliderInputPlugin``."""
plugin_data_fields = [
("label", ""),
("name", ""),
("initial", INITIAL),
("min_value", INITIAL_MIN_VALUE),
("max_value", INITIAL_MAX_VALUE),
("step", STEP),
("tooltip", SLIDER_DEFAULT_TOOLTIP),
("handle", SLIDER_DEFAULT_HANDLE),
# ("disable_slider_background", False),
("show_endpoints_as", SLIDER_DEFAULT_SHOW_ENDPOINTS_AS),
("label_start", ""),
("label_end", ""),
("custom_ticks", ""),
("help_text", ""),
("required", False),
]
label = forms.CharField(
label=_("Label"),
required=True,
widget=forms.widgets.TextInput(
attrs={"class": theme.form_element_html_class}
),
)
name = forms.CharField(
label=_("Name"),
required=True,
widget=forms.widgets.TextInput(
attrs={"class": theme.form_element_html_class}
),
)
initial = forms.IntegerField(
label=_("Initial"),
required=False,
widget=NumberInput(attrs={"class": theme.form_element_html_class}),
min_value=MIN_VALUE,
max_value=MAX_VALUE,
initial=INITIAL,
)
min_value = forms.IntegerField(
label=_("Min value"),
required=True,
initial=INITIAL_MIN_VALUE,
widget=NumberInput(attrs={"class": theme.form_element_html_class}),
min_value=MIN_VALUE,
max_value=MAX_VALUE,
)
max_value = forms.IntegerField(
label=_("Max value"),
required=True,
initial=INITIAL_MAX_VALUE,
widget=NumberInput(attrs={"class": theme.form_element_html_class}),
min_value=MIN_VALUE,
max_value=MAX_VALUE,
)
step = forms.IntegerField(
label=_("Step"),
required=True,
help_text=_("Step size"),
widget=NumberInput(attrs={"class": theme.form_element_html_class}),
min_value=MIN_VALUE,
max_value=MAX_VALUE,
)
tooltip = forms.ChoiceField(
label=_("Tooltip"),
choices=SLIDER_TOOLTIP_CHOICES,
required=False,
widget=forms.widgets.Select(
attrs={"class": theme.form_element_html_class}
),
)
handle = forms.ChoiceField(
label=_("Handle"),
choices=SLIDER_HANDLE_CHOICES,
required=False,
widget=forms.widgets.Select(
attrs={"class": theme.form_element_html_class}
),
)
# disable_slider_background = forms.BooleanField(
# label=_("Disable slider background"),
# required=False,
# widget=forms.widgets.CheckboxInput(
# attrs={'class': theme.form_element_checkbox_html_class}
# )
# )
show_endpoints_as = forms.ChoiceField(
label=_("Show endpoints as"),
choices=SLIDER_SHOW_ENDPOINTS_AS_CHOICES,
required=False,
widget=forms.widgets.Select(
attrs={"class": theme.form_element_html_class}
),
)
label_start = forms.CharField(
label=_("Start label"),
help_text=_("Start endpoint label"),
required=False,
widget=forms.widgets.TextInput(
attrs={"class": theme.form_element_html_class}
),
)
label_end = forms.CharField(
label=_("End label"),
help_text=_("End endpoint label"),
required=False,
widget=forms.widgets.TextInput(
attrs={"class": theme.form_element_html_class}
),
)
custom_ticks = forms.CharField(
label=_("Custom ticks"),
required=False,
help_text=_(
"Enter single values/pairs per line. Example:<code><br/>"
" 1<br/>"
" 2<br/>"
" 3, Alpha<br/>"
" 4, Beta<br/>"
"</code><br/>"
"It finally transforms into the following HTML "
"code:<code><br/>"
" "
'data-slider-ticks="[1, 2, 3, 4]"<br/>'
" "
"data-slider-ticks-labels='"
'["1", "2", "Alpha", "Beta"]'
"'</code>"
),
widget=forms.widgets.Textarea(
attrs={"class": theme.form_element_html_class}
),
)
help_text = forms.CharField(
label=_("Help text"),
required=False,
widget=forms.widgets.TextInput(
attrs={"class": theme.form_element_html_class}
),
)
required = forms.BooleanField(
label=_("Required"),
required=False,
widget=forms.widgets.CheckboxInput(
attrs={"class": theme.form_element_checkbox_html_class}
),
)
[docs] def clean(self):
"""Validating the values."""
super(SliderInputForm, self).clean()
max_value = self.cleaned_data["max_value"]
min_value = self.cleaned_data["min_value"]
initial = self.cleaned_data["initial"]
step = self.cleaned_data["step"]
show_endpoints_as = self.cleaned_data["show_endpoints_as"]
handle = self.cleaned_data["handle"]
custom_ticks = self.cleaned_data["custom_ticks"]
if max_value < min_value:
self.add_error(
"max_value", _("`max_value` should be > than `min_value`.")
)
if step > max_value - min_value:
self.add_error(
"step", _("`step` should be > than `max_value` - `min_value`.")
)
if max_value < initial:
self.add_error(
"initial", _("`max_value` should be >= than `initial`.")
)
if min_value > initial:
self.add_error(
"min_value", _("`initial` should be >= than `min_value`.")
)
label_handles = (SLIDER_HANDLE_TRIANGLE, SLIDER_HANDLE_CUSTOM)
tick_endpoints = (
SLIDER_SHOW_ENDPOINTS_AS_LABELED_TICKS,
SLIDER_SHOW_ENDPOINTS_AS_TICKS,
)
if handle in label_handles and show_endpoints_as in tick_endpoints:
self.add_error(
"handle",
_(
"You are not allowed to use Triangle or Custom handles "
"with ticks enabled."
),
)
if custom_ticks:
ticks = get_select_field_choices(
custom_ticks, key_type=int, value_type=str, fail_silently=False
)
if ticks is None:
self.add_error(
"custom_ticks",
_(
"Invalid format. First value should be an integer, "
"second value should be a string."
),
)