Warning

This document is for an old release of Galaxy. You can alternatively view this page in the latest release if it exists or view the top of the latest release's documentation.

galaxy.forms package

Submodules

galaxy.forms.forms module

FormDefinition and field factories

class galaxy.forms.forms.FormDefinitionFactory(form_types, field_type_factories)

Bases: object

__init__(form_types, field_type_factories)

new(form_type, name, description=None, fields=None, layout=None, form_definition_current=None)

Return new FormDefinition.

from_elem(elem, form_definition_current=None)

Return FormDefinition created from an xml element.

class galaxy.forms.forms.FormDefinitionFieldFactory

Bases: object

type = None

new(name=None, label=None, required=False, helptext=None, default=None, visible=True, layout=None)

Return new FormDefinition field.

from_elem(elem, layout=None)

Return FormDefinition created from an xml element.

class galaxy.forms.forms.FormDefinitionTextFieldFactory

Bases: galaxy.forms.forms.FormDefinitionFieldFactory

type = 'text'

new(name=None, label=None, required=False, helptext=None, default=None, visible=True, layout=None, area=False)

Return new FormDefinition field.

from_elem(elem, layout=None)

Return FormDefinition field created from an xml element.

class galaxy.forms.forms.FormDefinitionPasswordFieldFactory

Bases: galaxy.forms.forms.FormDefinitionFieldFactory

type = 'password'

new(name=None, label=None, required=False, helptext=None, default=None, visible=True, layout=None, area=False)

Return new FormDefinition field.

from_elem(elem, layout=None)

Return FormDefinition field created from an xml element.

class galaxy.forms.forms.FormDefinitionAddressFieldFactory

Bases: galaxy.forms.forms.FormDefinitionFieldFactory

type = 'address'

new(name=None, label=None, required=False, helptext=None, default=None, visible=True, layout=None)

Return new FormDefinition field.

from_elem(elem, layout=None)

Return FormDefinition field created from an xml element.

class galaxy.forms.forms.FormDefinitionWorkflowFieldFactory

Bases: galaxy.forms.forms.FormDefinitionFieldFactory

type = 'workflow'

new(name=None, label=None, required=False, helptext=None, default=None, visible=True, layout=None)

Return new FormDefinition field.

from_elem(elem, layout=None)

Return FormDefinition field created from an xml element.

class galaxy.forms.forms.FormDefinitionWorkflowMappingFieldFactory

Bases: galaxy.forms.forms.FormDefinitionFieldFactory

type = 'workflowmapping'

new(name=None, label=None, required=False, helptext=None, default=None, visible=True, layout=None)

Return new FormDefinition field.

from_elem(elem, layout=None)

Return FormDefinition field created from an xml element.

class galaxy.forms.forms.FormDefinitionHistoryFieldFactory

Bases: galaxy.forms.forms.FormDefinitionFieldFactory

type = 'history'

new(name=None, label=None, required=False, helptext=None, default=None, visible=True, layout=None)

Return new FormDefinition field.

from_elem(elem, layout=None)

Return FormDefinition field created from an xml element.

class galaxy.forms.forms.FormDefinitionSelectFieldFactory

Bases: galaxy.forms.forms.FormDefinitionFieldFactory

type = 'select'

new(name=None, label=None, required=False, helptext=None, default=None, visible=True, layout=None, options=[], checkboxes=False)

Return new FormDefinition field.

from_elem(elem, layout=None)

Return FormDefinition field created from an xml element.

galaxy.forms.forms.field

alias of FormDefinitionHistoryFieldFactory