flask_velox.admin.mixins.forms

Mixin classes for forms specific to Flask-Admin and Flask-WTForms

Note

The following packages must be installed.

• Flask-WTF
• Flask-Admin

class flask_velox.admin.mixins.forms.AdminBaseFormMixin(*args, **kwargs)

Bases: flask_velox.mixins.context.ContextMixin, flask_velox.admin.mixins.template.AdminTemplateMixin

Base Admin Form Mixin.

Warning

Use this mixin inconjunction with other mixins, cannot be used on its own.

cancel_url_rule str, optional

Flask url rule for cancel link, defaults to .index

cancel_url(**kwargs)

Returns the url to a cancel endpoint, this is used to render a link in forms to exit:

<a href="{{ cancel_url() }}">Cancel</a>

The cancel_url_rule must be defined.

See also

• get_cancel_url_rule()

Parameters:**kwargs – Arbitrary keyword arguments passed to Flask.url_for Returns:Generated url Return type:str or None

delete_url(**kwargs)

Returns the url to a delete endpoint, this is used to render a link in forms to delete an object:

<a href="{{ delete_url(id=object.id) }}">Cancel</a>

If delete_url_rule is not defined this method will not be called.

See also

• get_delete_url_rule()

Parameters:**kwargs – Arbitrary keyword arguments passed to Flask.url_for Returns:Generated url Return type:str or None

get_cancel_url_rule()

Returns the cancel_url_rule or raises NotImplementedError if not defined.

Returns:Defined cancel_url_rule Return type:str

get_delete_url_rule()

Returns the delete_url_rule or None if not defined.

Returns:Defined delete_url_rule Return type:str or None

get_redirect_url_rule()

Returns raw redirect url rule to be used in url_for. If the redirect_url_rule is not defined then .index will be returned.

Returns:Raw flask url endpoint Return type:str

post(admin, *args, **kwargs)

Hadnle HTTP POST requests. Overrides default post behaviour allowing the view on POST reqeuests to be processed by Flask-Admin

See also

• flask_velox.views.forms.BaseModelView.post()

Returns:Rendered template Return type:str

set_context()

Adds extra context variables.

Note

Adds the following extra context variables:

• cancel_url_rule: str
• cancel_url: func

See also

• from flask_velox.mixins.context.ContextMixin.set_context()

class flask_velox.admin.mixins.forms.AdminFormMixin(*args, **kwargs)

Bases: flask_velox.admin.mixins.forms.AdminBaseFormMixin, flask_velox.mixins.forms.FormMixin

Admin form mixin class provides the ability to render forms within the Flask-Admin System for an SQLAlchemy model.

class flask_velox.admin.mixins.forms.AdminMultiFormMixin(*args, **kwargs)

Bases: flask_velox.admin.mixins.forms.AdminBaseFormMixin, flask_velox.mixins.forms.MultiFormMixin

Admin form mixin class provides the ability to render multiple forms within the Flask-Admin System for an SQLAlchemy model.