org.forms.widgets
=================

.. py:module:: org.forms.widgets


Classes
-------

.. autoapisummary::

   org.forms.widgets.UploadOrLinkExistingFileWidget
   org.forms.widgets.UploadOrSelectExistingFileWidget
   org.forms.widgets.UploadOrSelectExistingMultipleFilesWidget


Module Contents
---------------

.. py:class:: UploadOrLinkExistingFileWidget(multiple=False)

   Bases: :py:obj:`onegov.form.widgets.UploadWidget`


   An upload widget for the :class:`onegov.form.fields.UploadField` class,
   which supports keeping, removing and replacing already uploaded files.

   This is necessary as file inputs are read-only on the client and it's
   therefore rather easy for users to lose their input otherwise (e.g. a
   form with a file is rejected because of some mistake - the file disappears
   once the response is rendered on the client).



   .. py:attribute:: file_details_template


   .. py:attribute:: file_details_icon_template


   .. py:method:: template_data(field: org.forms.fields.UploadOrSelectExistingFileField, force_simple: bool, resend_upload: bool, wrapper_css_class: str, input_html: markupsafe.Markup, **kwargs: Any) -> tuple[bool, dict[str, Any]]


.. py:class:: UploadOrSelectExistingFileWidget(multiple=False)

   Bases: :py:obj:`UploadOrLinkExistingFileWidget`


   An upload widget for the :class:`onegov.form.fields.UploadField` class,
   which supports keeping, removing and replacing already uploaded files.

   This is necessary as file inputs are read-only on the client and it's
   therefore rather easy for users to lose their input otherwise (e.g. a
   form with a file is rejected because of some mistake - the file disappears
   once the response is rendered on the client).



   .. py:attribute:: simple_template


   .. py:attribute:: template


   .. py:method:: template_data(field: org.forms.fields.UploadOrSelectExistingFileField, force_simple: bool, resend_upload: bool, wrapper_css_class: str, input_html: markupsafe.Markup, **kwargs: Any) -> tuple[bool, dict[str, Any]]


.. py:class:: UploadOrSelectExistingMultipleFilesWidget

   Bases: :py:obj:`onegov.form.widgets.UploadMultipleWidget`


   A widget for the :class:`onegov.form.fields.UploadMultipleField` class,
   which supports keeping, removing and replacing already uploaded files.

   This is necessary as file inputs are read-only on the client and it's
   therefore rather easy for users to lose their input otherwise (e.g. a
   form with a file is rejected because of some mistake - the file disappears
   once the response is rendered on the client).

   We deviate slightly from the norm by rendering the errors ourselves
   since we're essentially a list of fields and not a single field most
   of the time.



   .. py:attribute:: additional_label


   .. py:method:: render_input(field: org.forms.fields.UploadOrSelectExistingMultipleFilesField, **kwargs: Any) -> markupsafe.Markup