Language Tree

Forms for creating and modifying language tree objects

Language Tree Node Form

class integreat_cms.cms.forms.language_tree.language_tree_node_form.LanguageTreeNodeForm(**kwargs: Any)

Bases: CustomModelForm, CustomTreeNodeForm

Form for creating and modifying language tree node objects

Form fields:

• language: Language (ModelChoiceField)

• visible: Visible (BooleanField)

• active: Active (BooleanField)

• parent: Source language (ModelChoiceField)

• machine_translation_enabled: Machine translatable (BooleanField)

• _position: Position (ChoiceField)

• _ref_node_id: Relative to (ChoiceField)

Parameters:

kwargs (Any)

__init__(**kwargs: Any) → None

Initialize language tree node form

Parameters:

**kwargs (Any) – The supplied keyword arguments

Return type:

None

add_error(field, error)

Update the content of self._errors.

The field argument is the name of the field to which the errors should be added. If it’s None, treat the errors as NON_FIELD_ERRORS.

The error argument can be a single error, a list of errors, or a dictionary that maps field names to lists of errors. An “error” can be either a simple string or an instance of ValidationError with its message attribute set and a “list or dictionary” can be an actual list or dict or an instance of ValidationError with its error_list or error_dict attribute set.

If error is a dictionary, the field argument must be None and errors will be added to the fields that correspond to the keys of the dictionary.

add_error_messages(request: HttpRequest) → None

This function accepts the current request and adds the form’s error messages to the message queue of django.contrib.messages.

Parameters:

request (HttpRequest) – The current request submitting the form

Return type:

None

add_initial_prefix(field_name)

Add an ‘initial’ prefix for checking dynamic initial values.

add_prefix(field_name)

Return the field name with a prefix appended, if this Form has a prefix set.

Subclasses may wish to override.

classmethod add_subtree(for_node, node, options)

Recursively build options tree.

as_div()

Render as <div> elements.

as_p()

Render as <p> elements.

as_table()

Render as <tr> elements excluding the surrounding <table> tag.

as_ul()

Render as <li> elements excluding the surrounding <ul> tag.

changed_data

clean() → dict[str, Any]

Validate form fields which depend on each other, see django.forms.Form.clean(): Don’t allow multiple root nodes for one region: If self is a root node and the region already has a default language, raise a ValidationError.

Returns:

The cleaned form data

Return type:

dict[str, Any]

default_renderer = None

property errors

Return an ErrorDict for the data provided for the form.

field_order = None

full_clean()

Clean all of self.data and populate self._errors and self.cleaned_data.

get_context()

get_error_messages() → list[dict[str, str]]

Return all error messages of this form and append labels to field-errors

Returns:

The errors of this form

Return type:

list[dict[str, str]]

get_initial_for_field(field, field_name)

Return initial data for field on form. Use initial data from the form or the field, in that order. Evaluate callable values.

has_changed()

Return True if data differs from initial.

has_error(field, code=None)

hidden_fields()

Return a list of all the BoundField objects that are hidden fields. Useful for manual form layout in templates.

static is_loop_safe(for_node, possible_parent)

is_multipart()

Return True if the form needs to be multipart-encoded, i.e. it has FileInput, or False otherwise.

is_valid()

Return True if the form has no errors, or False otherwise.

property media

Return all media required to render the widgets on this form.

classmethod mk_dropdown_tree(model: ModelBase, for_node: None | LanguageTreeNode | Page = None) → list

Creates a tree-like list of choices. Overwrites the parent method because the field is hidden anyway and additional queries to render the node titles should be avoided.

Parameters:

• model (ModelBase) – ~integreat_cms.cms.models.abstract_tree_node.AbstractTreeNode

• for_node (None | (LanguageTreeNode | Page)) – The instance of this form

Returns:

A list of select options

Return type:

list

static mk_indent(level)

non_field_errors()

Return an ErrorList of errors that aren’t associated with a particular field – i.e., from Form.clean(). Return an empty ErrorList if there are none.

order_fields(field_order)

Rearrange the fields according to field_order.

field_order is a list of field names specifying the order. Append fields not included in the list in the default order for backward compatibility with subclasses not overriding field_order. If field_order is None, keep all fields in the order defined in the class. Ignore unknown fields in field_order to allow disabling fields in form subclasses without redefining ordering.

prefix = None

render(template_name=None, context=None, renderer=None)

save(commit: bool = True) → LanguageTreeNode

This method extends the default save()-method of the base ModelForm to flush the cache after committing.

Parameters:

commit (bool) – Whether or not the changes should be written to the database

Returns:

The saved page translation object

Return type:

LanguageTreeNode

property template_name

template_name_div = 'django/forms/div.html'

template_name_label = 'django/forms/label.html'

template_name_p = 'django/forms/p.html'

template_name_table = 'django/forms/table.html'

template_name_ul = 'django/forms/ul.html'

use_required_attribute = True

validate_unique()

Call the instance’s validate_unique() method and update the form’s validation errors if any were raised.

visible_fields()

Return a list of BoundField objects that aren’t hidden fields. The opposite of the hidden_fields() method.