Actions

An Action may apply reversible modifications of a django Form.

It should always take a list of :py:cls:`~facond.conditions.Condition` as first argument, and then whatever it’s going to need to work.

Action

JavaScript

class Action(conditions)

Apply a reversible action on the DOM if conditions apply, unapply otherwise.

Arguments:

• conditions – List of :js:cls:`Condition` objects

Action.apply(form)

Modify the DOM, should save the state for unapply().

Arguments:

• form – Form() object to apply on.

Action.execute(form)

Call apply() if conditions validate, unapply() otherwise.

Arguments:

• form – Form() object to execute on.

Action.unapply(form)

Restore the DOM prior to apply() call.

Arguments:

• form – Form() object to unapply on.

Python

class facond.actions.Action(conditions)

An action to take on a list of fields.

The execute() will first execute validate() for every of its conditions against the :py:cls:`~facond.forms.Form` instance it is passed.

apply(form)

Actual application of the action on the form field.

execute(form)

Prevent the action from being applied if conditions don’t pass.

unapply(form)

Revert apply() action.

RemoveChoices

JavaScript

class RemoveChoices(conditions, field, choices)

Remove given choices from a field.

Arguments:

• conditions – List of Condition() objects

Python

class facond.actions.RemoveChoices(conditions, field, choices)

Remove choices from a choice field.

apply(form)

Raise a ValidationError if the field value is in self.values.

RemoveField

JavaScript

class RemoveField(conditions, field)

Remove a field from a form.

Arguments:

• conditions – List of Condition() objects

:param Field(): Subject Field instance.

Python

class facond.actions.RemoveField(conditions, field)

Remove fields from a form.

apply(form)

Remove the field and data from field.form.

unapply(form)

Restore the field and data in field.form.