| | |
- FormKit.BaseFieldClasses.ChooseField(FormKit.BaseFieldClasses.Field)
-
- CheckboxSet
- RadioSet
-
- RadioSetWithOther(FormKit.BaseFieldClasses.CompoundField, RadioSet)
- SelectField
-
- EditableSelectField(FormKit.BaseFieldClasses.CompoundField, SelectField)
- MultiSelectField
- FormKit.BaseFieldClasses.CompoundField(FormKit.BaseFieldClasses.Field)
-
- EditableSelectField(FormKit.BaseFieldClasses.CompoundField, SelectField)
- RadioSetWithOther(FormKit.BaseFieldClasses.CompoundField, RadioSet)
- FormKit.BaseFieldClasses.Field(FormKit.BaseTagClasses.HTMLElement)
-
- Button
- FileField
- HiddenField
- ImageButton
-
- WebKitImageButton
- PasswordField
- ResetButton
- SubmitButton
-
- WebKitSubmitButton
- TextAreaField
- TextField
- TextInputField
class Button(FormKit.BaseFieldClasses.Field) |
| | |
- Method resolution order:
- Button
- FormKit.BaseFieldClasses.Field
- FormKit.BaseTagClasses.HTMLElement
Methods defined here:
- tag(self)
Methods inherited from FormKit.BaseFieldClasses.Field:
- __init__(self, name, validators=[], label='', attributes={}, languageStandard='XHTML')
- The bulk of Field's functionality derives from the code in HTMLElement. In addition,
the Field constructor sets up a bunch of additional containers; validators is a list of
validator/converter instances; the label is a string that is used by some field classes, but not
others, mainly for things like button labels; attributes is a dictionary of parameters that will
be added to the field's HTML tag; languageStandard is whether you want HTML or XHTML tags returned
- addValidator(self, validator)
- Public method to add a validator instance to this field
- clearValidators(self)
- Public method to remove all validators from this field
- default(self)
- Public method to return the default value for this field (if any)
- dump(self)
- Public method for returning a generic lump of HTML to represent the field
- error(self)
- Public method to return any error message resulting from validation (returns None if no error)
- setDefault(self, value)
- Public method to directly set the default value of the field
- validators(self)
- Public method to return the list of validators assigned to this field (if any)
Methods inherited from FormKit.BaseTagClasses.HTMLElement:
- addAttributes(self, attributes)
- Public method for adding tag attributes; merges in a dictionary of tag attributes
- addClass(self, klass)
- Public method for appending a CSS class name to this tag; expects a string
- addStyle(self, dict)
- Public method for adding a style attribute to a tag; takes a dictionary;
the key is the directive, the value is the parameter.
Duplicate key names override their predecessor.
Input like this:
{ 'background-color': 'rgb(255,255,255)',
'font-size: 11px' }
( trailing semicolon can be used, or not )
set a key to None or empty string to remove it from the set
- attributes(self)
- Returns a dictionary of field element attributes
- clearClasses(self)
- removes all CSS classes from the tag
- id(self)
- returns the dom id attribute of this htmlElement
- label(self)
- Generic label parameter access method
- languageStandard(self)
- Generic parameter access method
- name(self)
- Generic name parameter access method
- setAccessKey(self, key)
- Public method for setting the tab index of a field... pass a single character string (a letter)
- setID(self, string)
- Public utility method to surgically override the id tag attribute
- setTabIndex(self, num)
- Public method for setting the tab index of a field... pass an integer
- value(self)
- Generic field value access method
|
class CheckboxSet(FormKit.BaseFieldClasses.ChooseField) |
| | |
- Method resolution order:
- CheckboxSet
- FormKit.BaseFieldClasses.ChooseField
- FormKit.BaseFieldClasses.Field
- FormKit.BaseTagClasses.HTMLElement
Methods defined here:
- __init__(self, name, validators=[], label='', attributes={}, languageStandard='XHTML')
- setChoices(self, choiceListObject)
- Pass a selectionList object to this field object to set its selection set
- tag(self)
- Public method to return the HTML tags for this field
Methods inherited from FormKit.BaseFieldClasses.ChooseField:
- addChoice(self, value, label)
- Pass in a value, and text label to add a selection to this ChoiceList
- choiceList(self)
- Public method to return the ChoiceList class instance (for access to its methods)
- choices(self)
- Public method to return the choice class instances that are in this select field
- clearChoices(self)
- setID(self, string)
- Public utility method to surgically override the id tag attribute
Methods inherited from FormKit.BaseFieldClasses.Field:
- addValidator(self, validator)
- Public method to add a validator instance to this field
- clearValidators(self)
- Public method to remove all validators from this field
- default(self)
- Public method to return the default value for this field (if any)
- dump(self)
- Public method for returning a generic lump of HTML to represent the field
- error(self)
- Public method to return any error message resulting from validation (returns None if no error)
- setDefault(self, value)
- Public method to directly set the default value of the field
- validators(self)
- Public method to return the list of validators assigned to this field (if any)
Methods inherited from FormKit.BaseTagClasses.HTMLElement:
- addAttributes(self, attributes)
- Public method for adding tag attributes; merges in a dictionary of tag attributes
- addClass(self, klass)
- Public method for appending a CSS class name to this tag; expects a string
- addStyle(self, dict)
- Public method for adding a style attribute to a tag; takes a dictionary;
the key is the directive, the value is the parameter.
Duplicate key names override their predecessor.
Input like this:
{ 'background-color': 'rgb(255,255,255)',
'font-size: 11px' }
( trailing semicolon can be used, or not )
set a key to None or empty string to remove it from the set
- attributes(self)
- Returns a dictionary of field element attributes
- clearClasses(self)
- removes all CSS classes from the tag
- id(self)
- returns the dom id attribute of this htmlElement
- label(self)
- Generic label parameter access method
- languageStandard(self)
- Generic parameter access method
- name(self)
- Generic name parameter access method
- setAccessKey(self, key)
- Public method for setting the tab index of a field... pass a single character string (a letter)
- setTabIndex(self, num)
- Public method for setting the tab index of a field... pass an integer
- value(self)
- Generic field value access method
|
class EditableSelectField(FormKit.BaseFieldClasses.CompoundField, SelectField) |
| |
This compound field class simulates and editable select box by using two fields:
a select box and a text field
|
| |
- Method resolution order:
- EditableSelectField
- FormKit.BaseFieldClasses.CompoundField
- FormKit.BaseFieldClasses.Field
- FormKit.BaseTagClasses.HTMLElement
- SelectField
- FormKit.BaseFieldClasses.ChooseField
Methods defined here:
- __init__(self, name, validators=[], label='', attributes={}, languageStandard='XHTML')
- tag(self)
- custom tag method
Methods inherited from FormKit.BaseFieldClasses.CompoundField:
- addSubField(self, field)
- adds a field class instance to subfields
- dump(self)
- This isn't terribly useful as-is; you may want to make it more so in the sub-class
- error(self)
- Returns validation errors, allowing for the errors of the CompoundField's sub-fields
- nativeValue(self)
- the same as .value() if this were a non-compound field class
- subFields(self)
- returns a list of the sub fields
- value(self)
- access method that returns the 'value' of the compound set, NOT
the value of the main form field. This value is usually derived from
some combination of the field and its' subFields, or some other logic
Methods inherited from FormKit.BaseFieldClasses.Field:
- addValidator(self, validator)
- Public method to add a validator instance to this field
- clearValidators(self)
- Public method to remove all validators from this field
- default(self)
- Public method to return the default value for this field (if any)
- setDefault(self, value)
- Public method to directly set the default value of the field
- validators(self)
- Public method to return the list of validators assigned to this field (if any)
Methods inherited from FormKit.BaseTagClasses.HTMLElement:
- addAttributes(self, attributes)
- Public method for adding tag attributes; merges in a dictionary of tag attributes
- addClass(self, klass)
- Public method for appending a CSS class name to this tag; expects a string
- addStyle(self, dict)
- Public method for adding a style attribute to a tag; takes a dictionary;
the key is the directive, the value is the parameter.
Duplicate key names override their predecessor.
Input like this:
{ 'background-color': 'rgb(255,255,255)',
'font-size: 11px' }
( trailing semicolon can be used, or not )
set a key to None or empty string to remove it from the set
- attributes(self)
- Returns a dictionary of field element attributes
- clearClasses(self)
- removes all CSS classes from the tag
- id(self)
- returns the dom id attribute of this htmlElement
- label(self)
- Generic label parameter access method
- languageStandard(self)
- Generic parameter access method
- name(self)
- Generic name parameter access method
- setAccessKey(self, key)
- Public method for setting the tab index of a field... pass a single character string (a letter)
- setID(self, string)
- Public utility method to surgically override the id tag attribute
- setTabIndex(self, num)
- Public method for setting the tab index of a field... pass an integer
Methods inherited from SelectField:
- setChoices(self, choiceListObject)
- Pass a selectionList object to this field object to set its selection set
Methods inherited from FormKit.BaseFieldClasses.ChooseField:
- addChoice(self, value, label)
- Pass in a value, and text label to add a selection to this ChoiceList
- choiceList(self)
- Public method to return the ChoiceList class instance (for access to its methods)
- choices(self)
- Public method to return the choice class instances that are in this select field
- clearChoices(self)
|
class FileField(FormKit.BaseFieldClasses.Field) |
| | |
- Method resolution order:
- FileField
- FormKit.BaseFieldClasses.Field
- FormKit.BaseTagClasses.HTMLElement
Methods defined here:
- tag(self)
Methods inherited from FormKit.BaseFieldClasses.Field:
- __init__(self, name, validators=[], label='', attributes={}, languageStandard='XHTML')
- The bulk of Field's functionality derives from the code in HTMLElement. In addition,
the Field constructor sets up a bunch of additional containers; validators is a list of
validator/converter instances; the label is a string that is used by some field classes, but not
others, mainly for things like button labels; attributes is a dictionary of parameters that will
be added to the field's HTML tag; languageStandard is whether you want HTML or XHTML tags returned
- addValidator(self, validator)
- Public method to add a validator instance to this field
- clearValidators(self)
- Public method to remove all validators from this field
- default(self)
- Public method to return the default value for this field (if any)
- dump(self)
- Public method for returning a generic lump of HTML to represent the field
- error(self)
- Public method to return any error message resulting from validation (returns None if no error)
- setDefault(self, value)
- Public method to directly set the default value of the field
- validators(self)
- Public method to return the list of validators assigned to this field (if any)
Methods inherited from FormKit.BaseTagClasses.HTMLElement:
- addAttributes(self, attributes)
- Public method for adding tag attributes; merges in a dictionary of tag attributes
- addClass(self, klass)
- Public method for appending a CSS class name to this tag; expects a string
- addStyle(self, dict)
- Public method for adding a style attribute to a tag; takes a dictionary;
the key is the directive, the value is the parameter.
Duplicate key names override their predecessor.
Input like this:
{ 'background-color': 'rgb(255,255,255)',
'font-size: 11px' }
( trailing semicolon can be used, or not )
set a key to None or empty string to remove it from the set
- attributes(self)
- Returns a dictionary of field element attributes
- clearClasses(self)
- removes all CSS classes from the tag
- id(self)
- returns the dom id attribute of this htmlElement
- label(self)
- Generic label parameter access method
- languageStandard(self)
- Generic parameter access method
- name(self)
- Generic name parameter access method
- setAccessKey(self, key)
- Public method for setting the tab index of a field... pass a single character string (a letter)
- setID(self, string)
- Public utility method to surgically override the id tag attribute
- setTabIndex(self, num)
- Public method for setting the tab index of a field... pass an integer
- value(self)
- Generic field value access method
|
class HiddenField(FormKit.BaseFieldClasses.Field) |
| | |
- Method resolution order:
- HiddenField
- FormKit.BaseFieldClasses.Field
- FormKit.BaseTagClasses.HTMLElement
Methods defined here:
- tag(self)
Methods inherited from FormKit.BaseFieldClasses.Field:
- __init__(self, name, validators=[], label='', attributes={}, languageStandard='XHTML')
- The bulk of Field's functionality derives from the code in HTMLElement. In addition,
the Field constructor sets up a bunch of additional containers; validators is a list of
validator/converter instances; the label is a string that is used by some field classes, but not
others, mainly for things like button labels; attributes is a dictionary of parameters that will
be added to the field's HTML tag; languageStandard is whether you want HTML or XHTML tags returned
- addValidator(self, validator)
- Public method to add a validator instance to this field
- clearValidators(self)
- Public method to remove all validators from this field
- default(self)
- Public method to return the default value for this field (if any)
- dump(self)
- Public method for returning a generic lump of HTML to represent the field
- error(self)
- Public method to return any error message resulting from validation (returns None if no error)
- setDefault(self, value)
- Public method to directly set the default value of the field
- validators(self)
- Public method to return the list of validators assigned to this field (if any)
Methods inherited from FormKit.BaseTagClasses.HTMLElement:
- addAttributes(self, attributes)
- Public method for adding tag attributes; merges in a dictionary of tag attributes
- addClass(self, klass)
- Public method for appending a CSS class name to this tag; expects a string
- addStyle(self, dict)
- Public method for adding a style attribute to a tag; takes a dictionary;
the key is the directive, the value is the parameter.
Duplicate key names override their predecessor.
Input like this:
{ 'background-color': 'rgb(255,255,255)',
'font-size: 11px' }
( trailing semicolon can be used, or not )
set a key to None or empty string to remove it from the set
- attributes(self)
- Returns a dictionary of field element attributes
- clearClasses(self)
- removes all CSS classes from the tag
- id(self)
- returns the dom id attribute of this htmlElement
- label(self)
- Generic label parameter access method
- languageStandard(self)
- Generic parameter access method
- name(self)
- Generic name parameter access method
- setAccessKey(self, key)
- Public method for setting the tab index of a field... pass a single character string (a letter)
- setID(self, string)
- Public utility method to surgically override the id tag attribute
- setTabIndex(self, num)
- Public method for setting the tab index of a field... pass an integer
- value(self)
- Generic field value access method
|
class ImageButton(FormKit.BaseFieldClasses.Field) |
| |
This is an Image Submit button. This is not for use with webkit: use WebKitImageButton() for that.
|
| |
- Method resolution order:
- ImageButton
- FormKit.BaseFieldClasses.Field
- FormKit.BaseTagClasses.HTMLElement
Methods defined here:
- setImage(self, url, width=None, height=None)
- # Image buttons work just like html buttons, but they pass in the coordinates that the user clicked on
- tag(self)
Methods inherited from FormKit.BaseFieldClasses.Field:
- __init__(self, name, validators=[], label='', attributes={}, languageStandard='XHTML')
- The bulk of Field's functionality derives from the code in HTMLElement. In addition,
the Field constructor sets up a bunch of additional containers; validators is a list of
validator/converter instances; the label is a string that is used by some field classes, but not
others, mainly for things like button labels; attributes is a dictionary of parameters that will
be added to the field's HTML tag; languageStandard is whether you want HTML or XHTML tags returned
- addValidator(self, validator)
- Public method to add a validator instance to this field
- clearValidators(self)
- Public method to remove all validators from this field
- default(self)
- Public method to return the default value for this field (if any)
- dump(self)
- Public method for returning a generic lump of HTML to represent the field
- error(self)
- Public method to return any error message resulting from validation (returns None if no error)
- setDefault(self, value)
- Public method to directly set the default value of the field
- validators(self)
- Public method to return the list of validators assigned to this field (if any)
Methods inherited from FormKit.BaseTagClasses.HTMLElement:
- addAttributes(self, attributes)
- Public method for adding tag attributes; merges in a dictionary of tag attributes
- addClass(self, klass)
- Public method for appending a CSS class name to this tag; expects a string
- addStyle(self, dict)
- Public method for adding a style attribute to a tag; takes a dictionary;
the key is the directive, the value is the parameter.
Duplicate key names override their predecessor.
Input like this:
{ 'background-color': 'rgb(255,255,255)',
'font-size: 11px' }
( trailing semicolon can be used, or not )
set a key to None or empty string to remove it from the set
- attributes(self)
- Returns a dictionary of field element attributes
- clearClasses(self)
- removes all CSS classes from the tag
- id(self)
- returns the dom id attribute of this htmlElement
- label(self)
- Generic label parameter access method
- languageStandard(self)
- Generic parameter access method
- name(self)
- Generic name parameter access method
- setAccessKey(self, key)
- Public method for setting the tab index of a field... pass a single character string (a letter)
- setID(self, string)
- Public utility method to surgically override the id tag attribute
- setTabIndex(self, num)
- Public method for setting the tab index of a field... pass an integer
- value(self)
- Generic field value access method
|
class MultiSelectField(SelectField) |
| | |
- Method resolution order:
- MultiSelectField
- SelectField
- FormKit.BaseFieldClasses.ChooseField
- FormKit.BaseFieldClasses.Field
- FormKit.BaseTagClasses.HTMLElement
Methods defined here:
- tag(self)
- Public method to return the HTML tags for this field
Methods inherited from SelectField:
- setChoices(self, choiceListObject)
- Pass a selectionList object to this field object to set its selection set
Methods inherited from FormKit.BaseFieldClasses.ChooseField:
- __init__(self, name, validators=[], label='', attributes={}, languageStandard='XHTML')
- addChoice(self, value, label)
- Pass in a value, and text label to add a selection to this ChoiceList
- choiceList(self)
- Public method to return the ChoiceList class instance (for access to its methods)
- choices(self)
- Public method to return the choice class instances that are in this select field
- clearChoices(self)
- setID(self, string)
- Public utility method to surgically override the id tag attribute
Methods inherited from FormKit.BaseFieldClasses.Field:
- addValidator(self, validator)
- Public method to add a validator instance to this field
- clearValidators(self)
- Public method to remove all validators from this field
- default(self)
- Public method to return the default value for this field (if any)
- dump(self)
- Public method for returning a generic lump of HTML to represent the field
- error(self)
- Public method to return any error message resulting from validation (returns None if no error)
- setDefault(self, value)
- Public method to directly set the default value of the field
- validators(self)
- Public method to return the list of validators assigned to this field (if any)
Methods inherited from FormKit.BaseTagClasses.HTMLElement:
- addAttributes(self, attributes)
- Public method for adding tag attributes; merges in a dictionary of tag attributes
- addClass(self, klass)
- Public method for appending a CSS class name to this tag; expects a string
- addStyle(self, dict)
- Public method for adding a style attribute to a tag; takes a dictionary;
the key is the directive, the value is the parameter.
Duplicate key names override their predecessor.
Input like this:
{ 'background-color': 'rgb(255,255,255)',
'font-size: 11px' }
( trailing semicolon can be used, or not )
set a key to None or empty string to remove it from the set
- attributes(self)
- Returns a dictionary of field element attributes
- clearClasses(self)
- removes all CSS classes from the tag
- id(self)
- returns the dom id attribute of this htmlElement
- label(self)
- Generic label parameter access method
- languageStandard(self)
- Generic parameter access method
- name(self)
- Generic name parameter access method
- setAccessKey(self, key)
- Public method for setting the tab index of a field... pass a single character string (a letter)
- setTabIndex(self, num)
- Public method for setting the tab index of a field... pass an integer
- value(self)
- Generic field value access method
|
class PasswordField(FormKit.BaseFieldClasses.Field) |
| | |
- Method resolution order:
- PasswordField
- FormKit.BaseFieldClasses.Field
- FormKit.BaseTagClasses.HTMLElement
Methods defined here:
- tag(self)
Methods inherited from FormKit.BaseFieldClasses.Field:
- __init__(self, name, validators=[], label='', attributes={}, languageStandard='XHTML')
- The bulk of Field's functionality derives from the code in HTMLElement. In addition,
the Field constructor sets up a bunch of additional containers; validators is a list of
validator/converter instances; the label is a string that is used by some field classes, but not
others, mainly for things like button labels; attributes is a dictionary of parameters that will
be added to the field's HTML tag; languageStandard is whether you want HTML or XHTML tags returned
- addValidator(self, validator)
- Public method to add a validator instance to this field
- clearValidators(self)
- Public method to remove all validators from this field
- default(self)
- Public method to return the default value for this field (if any)
- dump(self)
- Public method for returning a generic lump of HTML to represent the field
- error(self)
- Public method to return any error message resulting from validation (returns None if no error)
- setDefault(self, value)
- Public method to directly set the default value of the field
- validators(self)
- Public method to return the list of validators assigned to this field (if any)
Methods inherited from FormKit.BaseTagClasses.HTMLElement:
- addAttributes(self, attributes)
- Public method for adding tag attributes; merges in a dictionary of tag attributes
- addClass(self, klass)
- Public method for appending a CSS class name to this tag; expects a string
- addStyle(self, dict)
- Public method for adding a style attribute to a tag; takes a dictionary;
the key is the directive, the value is the parameter.
Duplicate key names override their predecessor.
Input like this:
{ 'background-color': 'rgb(255,255,255)',
'font-size: 11px' }
( trailing semicolon can be used, or not )
set a key to None or empty string to remove it from the set
- attributes(self)
- Returns a dictionary of field element attributes
- clearClasses(self)
- removes all CSS classes from the tag
- id(self)
- returns the dom id attribute of this htmlElement
- label(self)
- Generic label parameter access method
- languageStandard(self)
- Generic parameter access method
- name(self)
- Generic name parameter access method
- setAccessKey(self, key)
- Public method for setting the tab index of a field... pass a single character string (a letter)
- setID(self, string)
- Public utility method to surgically override the id tag attribute
- setTabIndex(self, num)
- Public method for setting the tab index of a field... pass an integer
- value(self)
- Generic field value access method
|
class RadioSet(FormKit.BaseFieldClasses.ChooseField) |
| | |
- Method resolution order:
- RadioSet
- FormKit.BaseFieldClasses.ChooseField
- FormKit.BaseFieldClasses.Field
- FormKit.BaseTagClasses.HTMLElement
Methods defined here:
- __init__(self, name, validators=[], label='', attributes={}, languageStandard='XHTML')
- setChoices(self, choiceListObject)
- Pass a selectionList object to this field object to set its selection set
- tag(self)
- Public method to return the HTML tags for this field
Methods inherited from FormKit.BaseFieldClasses.ChooseField:
- addChoice(self, value, label)
- Pass in a value, and text label to add a selection to this ChoiceList
- choiceList(self)
- Public method to return the ChoiceList class instance (for access to its methods)
- choices(self)
- Public method to return the choice class instances that are in this select field
- clearChoices(self)
- setID(self, string)
- Public utility method to surgically override the id tag attribute
Methods inherited from FormKit.BaseFieldClasses.Field:
- addValidator(self, validator)
- Public method to add a validator instance to this field
- clearValidators(self)
- Public method to remove all validators from this field
- default(self)
- Public method to return the default value for this field (if any)
- dump(self)
- Public method for returning a generic lump of HTML to represent the field
- error(self)
- Public method to return any error message resulting from validation (returns None if no error)
- setDefault(self, value)
- Public method to directly set the default value of the field
- validators(self)
- Public method to return the list of validators assigned to this field (if any)
Methods inherited from FormKit.BaseTagClasses.HTMLElement:
- addAttributes(self, attributes)
- Public method for adding tag attributes; merges in a dictionary of tag attributes
- addClass(self, klass)
- Public method for appending a CSS class name to this tag; expects a string
- addStyle(self, dict)
- Public method for adding a style attribute to a tag; takes a dictionary;
the key is the directive, the value is the parameter.
Duplicate key names override their predecessor.
Input like this:
{ 'background-color': 'rgb(255,255,255)',
'font-size: 11px' }
( trailing semicolon can be used, or not )
set a key to None or empty string to remove it from the set
- attributes(self)
- Returns a dictionary of field element attributes
- clearClasses(self)
- removes all CSS classes from the tag
- id(self)
- returns the dom id attribute of this htmlElement
- label(self)
- Generic label parameter access method
- languageStandard(self)
- Generic parameter access method
- name(self)
- Generic name parameter access method
- setAccessKey(self, key)
- Public method for setting the tab index of a field... pass a single character string (a letter)
- setTabIndex(self, num)
- Public method for setting the tab index of a field... pass an integer
- value(self)
- Generic field value access method
|
class RadioSetWithOther(FormKit.BaseFieldClasses.CompoundField, RadioSet) |
| | |
- Method resolution order:
- RadioSetWithOther
- FormKit.BaseFieldClasses.CompoundField
- FormKit.BaseFieldClasses.Field
- FormKit.BaseTagClasses.HTMLElement
- RadioSet
- FormKit.BaseFieldClasses.ChooseField
Methods defined here:
- __init__(self, name, validators=[], label='', attributes={}, languageStandard='XHTML')
- tag(self)
- cutsom tag method
Methods inherited from FormKit.BaseFieldClasses.CompoundField:
- addSubField(self, field)
- adds a field class instance to subfields
- dump(self)
- This isn't terribly useful as-is; you may want to make it more so in the sub-class
- error(self)
- Returns validation errors, allowing for the errors of the CompoundField's sub-fields
- nativeValue(self)
- the same as .value() if this were a non-compound field class
- subFields(self)
- returns a list of the sub fields
- value(self)
- access method that returns the 'value' of the compound set, NOT
the value of the main form field. This value is usually derived from
some combination of the field and its' subFields, or some other logic
Methods inherited from FormKit.BaseFieldClasses.Field:
- addValidator(self, validator)
- Public method to add a validator instance to this field
- clearValidators(self)
- Public method to remove all validators from this field
- default(self)
- Public method to return the default value for this field (if any)
- setDefault(self, value)
- Public method to directly set the default value of the field
- validators(self)
- Public method to return the list of validators assigned to this field (if any)
Methods inherited from FormKit.BaseTagClasses.HTMLElement:
- addAttributes(self, attributes)
- Public method for adding tag attributes; merges in a dictionary of tag attributes
- addClass(self, klass)
- Public method for appending a CSS class name to this tag; expects a string
- addStyle(self, dict)
- Public method for adding a style attribute to a tag; takes a dictionary;
the key is the directive, the value is the parameter.
Duplicate key names override their predecessor.
Input like this:
{ 'background-color': 'rgb(255,255,255)',
'font-size: 11px' }
( trailing semicolon can be used, or not )
set a key to None or empty string to remove it from the set
- attributes(self)
- Returns a dictionary of field element attributes
- clearClasses(self)
- removes all CSS classes from the tag
- id(self)
- returns the dom id attribute of this htmlElement
- label(self)
- Generic label parameter access method
- languageStandard(self)
- Generic parameter access method
- name(self)
- Generic name parameter access method
- setAccessKey(self, key)
- Public method for setting the tab index of a field... pass a single character string (a letter)
- setID(self, string)
- Public utility method to surgically override the id tag attribute
- setTabIndex(self, num)
- Public method for setting the tab index of a field... pass an integer
Methods inherited from RadioSet:
- setChoices(self, choiceListObject)
- Pass a selectionList object to this field object to set its selection set
Methods inherited from FormKit.BaseFieldClasses.ChooseField:
- addChoice(self, value, label)
- Pass in a value, and text label to add a selection to this ChoiceList
- choiceList(self)
- Public method to return the ChoiceList class instance (for access to its methods)
- choices(self)
- Public method to return the choice class instances that are in this select field
- clearChoices(self)
|
class ResetButton(FormKit.BaseFieldClasses.Field) |
| | |
- Method resolution order:
- ResetButton
- FormKit.BaseFieldClasses.Field
- FormKit.BaseTagClasses.HTMLElement
Methods defined here:
- tag(self)
Methods inherited from FormKit.BaseFieldClasses.Field:
- __init__(self, name, validators=[], label='', attributes={}, languageStandard='XHTML')
- The bulk of Field's functionality derives from the code in HTMLElement. In addition,
the Field constructor sets up a bunch of additional containers; validators is a list of
validator/converter instances; the label is a string that is used by some field classes, but not
others, mainly for things like button labels; attributes is a dictionary of parameters that will
be added to the field's HTML tag; languageStandard is whether you want HTML or XHTML tags returned
- addValidator(self, validator)
- Public method to add a validator instance to this field
- clearValidators(self)
- Public method to remove all validators from this field
- default(self)
- Public method to return the default value for this field (if any)
- dump(self)
- Public method for returning a generic lump of HTML to represent the field
- error(self)
- Public method to return any error message resulting from validation (returns None if no error)
- setDefault(self, value)
- Public method to directly set the default value of the field
- validators(self)
- Public method to return the list of validators assigned to this field (if any)
Methods inherited from FormKit.BaseTagClasses.HTMLElement:
- addAttributes(self, attributes)
- Public method for adding tag attributes; merges in a dictionary of tag attributes
- addClass(self, klass)
- Public method for appending a CSS class name to this tag; expects a string
- addStyle(self, dict)
- Public method for adding a style attribute to a tag; takes a dictionary;
the key is the directive, the value is the parameter.
Duplicate key names override their predecessor.
Input like this:
{ 'background-color': 'rgb(255,255,255)',
'font-size: 11px' }
( trailing semicolon can be used, or not )
set a key to None or empty string to remove it from the set
- attributes(self)
- Returns a dictionary of field element attributes
- clearClasses(self)
- removes all CSS classes from the tag
- id(self)
- returns the dom id attribute of this htmlElement
- label(self)
- Generic label parameter access method
- languageStandard(self)
- Generic parameter access method
- name(self)
- Generic name parameter access method
- setAccessKey(self, key)
- Public method for setting the tab index of a field... pass a single character string (a letter)
- setID(self, string)
- Public utility method to surgically override the id tag attribute
- setTabIndex(self, num)
- Public method for setting the tab index of a field... pass an integer
- value(self)
- Generic field value access method
|
class SelectField(FormKit.BaseFieldClasses.ChooseField) |
| |
Select box field
|
| |
- Method resolution order:
- SelectField
- FormKit.BaseFieldClasses.ChooseField
- FormKit.BaseFieldClasses.Field
- FormKit.BaseTagClasses.HTMLElement
Methods defined here:
- setChoices(self, choiceListObject)
- Pass a selectionList object to this field object to set its selection set
- tag(self)
- Public method to return the HTML tags for this field
Methods inherited from FormKit.BaseFieldClasses.ChooseField:
- __init__(self, name, validators=[], label='', attributes={}, languageStandard='XHTML')
- addChoice(self, value, label)
- Pass in a value, and text label to add a selection to this ChoiceList
- choiceList(self)
- Public method to return the ChoiceList class instance (for access to its methods)
- choices(self)
- Public method to return the choice class instances that are in this select field
- clearChoices(self)
- setID(self, string)
- Public utility method to surgically override the id tag attribute
Methods inherited from FormKit.BaseFieldClasses.Field:
- addValidator(self, validator)
- Public method to add a validator instance to this field
- clearValidators(self)
- Public method to remove all validators from this field
- default(self)
- Public method to return the default value for this field (if any)
- dump(self)
- Public method for returning a generic lump of HTML to represent the field
- error(self)
- Public method to return any error message resulting from validation (returns None if no error)
- setDefault(self, value)
- Public method to directly set the default value of the field
- validators(self)
- Public method to return the list of validators assigned to this field (if any)
Methods inherited from FormKit.BaseTagClasses.HTMLElement:
- addAttributes(self, attributes)
- Public method for adding tag attributes; merges in a dictionary of tag attributes
- addClass(self, klass)
- Public method for appending a CSS class name to this tag; expects a string
- addStyle(self, dict)
- Public method for adding a style attribute to a tag; takes a dictionary;
the key is the directive, the value is the parameter.
Duplicate key names override their predecessor.
Input like this:
{ 'background-color': 'rgb(255,255,255)',
'font-size: 11px' }
( trailing semicolon can be used, or not )
set a key to None or empty string to remove it from the set
- attributes(self)
- Returns a dictionary of field element attributes
- clearClasses(self)
- removes all CSS classes from the tag
- id(self)
- returns the dom id attribute of this htmlElement
- label(self)
- Generic label parameter access method
- languageStandard(self)
- Generic parameter access method
- name(self)
- Generic name parameter access method
- setAccessKey(self, key)
- Public method for setting the tab index of a field... pass a single character string (a letter)
- setTabIndex(self, num)
- Public method for setting the tab index of a field... pass an integer
- value(self)
- Generic field value access method
|
class SubmitButton(FormKit.BaseFieldClasses.Field) |
| | |
- Method resolution order:
- SubmitButton
- FormKit.BaseFieldClasses.Field
- FormKit.BaseTagClasses.HTMLElement
Methods defined here:
- tag(self)
Methods inherited from FormKit.BaseFieldClasses.Field:
- __init__(self, name, validators=[], label='', attributes={}, languageStandard='XHTML')
- The bulk of Field's functionality derives from the code in HTMLElement. In addition,
the Field constructor sets up a bunch of additional containers; validators is a list of
validator/converter instances; the label is a string that is used by some field classes, but not
others, mainly for things like button labels; attributes is a dictionary of parameters that will
be added to the field's HTML tag; languageStandard is whether you want HTML or XHTML tags returned
- addValidator(self, validator)
- Public method to add a validator instance to this field
- clearValidators(self)
- Public method to remove all validators from this field
- default(self)
- Public method to return the default value for this field (if any)
- dump(self)
- Public method for returning a generic lump of HTML to represent the field
- error(self)
- Public method to return any error message resulting from validation (returns None if no error)
- setDefault(self, value)
- Public method to directly set the default value of the field
- validators(self)
- Public method to return the list of validators assigned to this field (if any)
Methods inherited from FormKit.BaseTagClasses.HTMLElement:
- addAttributes(self, attributes)
- Public method for adding tag attributes; merges in a dictionary of tag attributes
- addClass(self, klass)
- Public method for appending a CSS class name to this tag; expects a string
- addStyle(self, dict)
- Public method for adding a style attribute to a tag; takes a dictionary;
the key is the directive, the value is the parameter.
Duplicate key names override their predecessor.
Input like this:
{ 'background-color': 'rgb(255,255,255)',
'font-size: 11px' }
( trailing semicolon can be used, or not )
set a key to None or empty string to remove it from the set
- attributes(self)
- Returns a dictionary of field element attributes
- clearClasses(self)
- removes all CSS classes from the tag
- id(self)
- returns the dom id attribute of this htmlElement
- label(self)
- Generic label parameter access method
- languageStandard(self)
- Generic parameter access method
- name(self)
- Generic name parameter access method
- setAccessKey(self, key)
- Public method for setting the tab index of a field... pass a single character string (a letter)
- setID(self, string)
- Public utility method to surgically override the id tag attribute
- setTabIndex(self, num)
- Public method for setting the tab index of a field... pass an integer
- value(self)
- Generic field value access method
|
class TextAreaField(FormKit.BaseFieldClasses.Field) |
| | |
- Method resolution order:
- TextAreaField
- FormKit.BaseFieldClasses.Field
- FormKit.BaseTagClasses.HTMLElement
Methods defined here:
- tag(self)
Methods inherited from FormKit.BaseFieldClasses.Field:
- __init__(self, name, validators=[], label='', attributes={}, languageStandard='XHTML')
- The bulk of Field's functionality derives from the code in HTMLElement. In addition,
the Field constructor sets up a bunch of additional containers; validators is a list of
validator/converter instances; the label is a string that is used by some field classes, but not
others, mainly for things like button labels; attributes is a dictionary of parameters that will
be added to the field's HTML tag; languageStandard is whether you want HTML or XHTML tags returned
- addValidator(self, validator)
- Public method to add a validator instance to this field
- clearValidators(self)
- Public method to remove all validators from this field
- default(self)
- Public method to return the default value for this field (if any)
- dump(self)
- Public method for returning a generic lump of HTML to represent the field
- error(self)
- Public method to return any error message resulting from validation (returns None if no error)
- setDefault(self, value)
- Public method to directly set the default value of the field
- validators(self)
- Public method to return the list of validators assigned to this field (if any)
Methods inherited from FormKit.BaseTagClasses.HTMLElement:
- addAttributes(self, attributes)
- Public method for adding tag attributes; merges in a dictionary of tag attributes
- addClass(self, klass)
- Public method for appending a CSS class name to this tag; expects a string
- addStyle(self, dict)
- Public method for adding a style attribute to a tag; takes a dictionary;
the key is the directive, the value is the parameter.
Duplicate key names override their predecessor.
Input like this:
{ 'background-color': 'rgb(255,255,255)',
'font-size: 11px' }
( trailing semicolon can be used, or not )
set a key to None or empty string to remove it from the set
- attributes(self)
- Returns a dictionary of field element attributes
- clearClasses(self)
- removes all CSS classes from the tag
- id(self)
- returns the dom id attribute of this htmlElement
- label(self)
- Generic label parameter access method
- languageStandard(self)
- Generic parameter access method
- name(self)
- Generic name parameter access method
- setAccessKey(self, key)
- Public method for setting the tab index of a field... pass a single character string (a letter)
- setID(self, string)
- Public utility method to surgically override the id tag attribute
- setTabIndex(self, num)
- Public method for setting the tab index of a field... pass an integer
- value(self)
- Generic field value access method
|
class TextField(FormKit.BaseFieldClasses.Field) |
| | |
- Method resolution order:
- TextField
- FormKit.BaseFieldClasses.Field
- FormKit.BaseTagClasses.HTMLElement
Methods defined here:
- tag(self)
Methods inherited from FormKit.BaseFieldClasses.Field:
- __init__(self, name, validators=[], label='', attributes={}, languageStandard='XHTML')
- The bulk of Field's functionality derives from the code in HTMLElement. In addition,
the Field constructor sets up a bunch of additional containers; validators is a list of
validator/converter instances; the label is a string that is used by some field classes, but not
others, mainly for things like button labels; attributes is a dictionary of parameters that will
be added to the field's HTML tag; languageStandard is whether you want HTML or XHTML tags returned
- addValidator(self, validator)
- Public method to add a validator instance to this field
- clearValidators(self)
- Public method to remove all validators from this field
- default(self)
- Public method to return the default value for this field (if any)
- dump(self)
- Public method for returning a generic lump of HTML to represent the field
- error(self)
- Public method to return any error message resulting from validation (returns None if no error)
- setDefault(self, value)
- Public method to directly set the default value of the field
- validators(self)
- Public method to return the list of validators assigned to this field (if any)
Methods inherited from FormKit.BaseTagClasses.HTMLElement:
- addAttributes(self, attributes)
- Public method for adding tag attributes; merges in a dictionary of tag attributes
- addClass(self, klass)
- Public method for appending a CSS class name to this tag; expects a string
- addStyle(self, dict)
- Public method for adding a style attribute to a tag; takes a dictionary;
the key is the directive, the value is the parameter.
Duplicate key names override their predecessor.
Input like this:
{ 'background-color': 'rgb(255,255,255)',
'font-size: 11px' }
( trailing semicolon can be used, or not )
set a key to None or empty string to remove it from the set
- attributes(self)
- Returns a dictionary of field element attributes
- clearClasses(self)
- removes all CSS classes from the tag
- id(self)
- returns the dom id attribute of this htmlElement
- label(self)
- Generic label parameter access method
- languageStandard(self)
- Generic parameter access method
- name(self)
- Generic name parameter access method
- setAccessKey(self, key)
- Public method for setting the tab index of a field... pass a single character string (a letter)
- setID(self, string)
- Public utility method to surgically override the id tag attribute
- setTabIndex(self, num)
- Public method for setting the tab index of a field... pass an integer
- value(self)
- Generic field value access method
|
class TextInputField(FormKit.BaseFieldClasses.Field) |
| |
This field class provides a generalized text input interface and manifests either as a
text field or a textarea field, depending on the maximum length string requested
|
| |
- Method resolution order:
- TextInputField
- FormKit.BaseFieldClasses.Field
- FormKit.BaseTagClasses.HTMLElement
Methods defined here:
- __init__(self, name, validators=[], label='', attributes={}, languageStandard='XHTML', maxLength=0, rows=None, cols=None)
- tag(self)
Methods inherited from FormKit.BaseFieldClasses.Field:
- addValidator(self, validator)
- Public method to add a validator instance to this field
- clearValidators(self)
- Public method to remove all validators from this field
- default(self)
- Public method to return the default value for this field (if any)
- dump(self)
- Public method for returning a generic lump of HTML to represent the field
- error(self)
- Public method to return any error message resulting from validation (returns None if no error)
- setDefault(self, value)
- Public method to directly set the default value of the field
- validators(self)
- Public method to return the list of validators assigned to this field (if any)
Methods inherited from FormKit.BaseTagClasses.HTMLElement:
- addAttributes(self, attributes)
- Public method for adding tag attributes; merges in a dictionary of tag attributes
- addClass(self, klass)
- Public method for appending a CSS class name to this tag; expects a string
- addStyle(self, dict)
- Public method for adding a style attribute to a tag; takes a dictionary;
the key is the directive, the value is the parameter.
Duplicate key names override their predecessor.
Input like this:
{ 'background-color': 'rgb(255,255,255)',
'font-size: 11px' }
( trailing semicolon can be used, or not )
set a key to None or empty string to remove it from the set
- attributes(self)
- Returns a dictionary of field element attributes
- clearClasses(self)
- removes all CSS classes from the tag
- id(self)
- returns the dom id attribute of this htmlElement
- label(self)
- Generic label parameter access method
- languageStandard(self)
- Generic parameter access method
- name(self)
- Generic name parameter access method
- setAccessKey(self, key)
- Public method for setting the tab index of a field... pass a single character string (a letter)
- setID(self, string)
- Public utility method to surgically override the id tag attribute
- setTabIndex(self, num)
- Public method for setting the tab index of a field... pass an integer
- value(self)
- Generic field value access method
|
class WebKitImageButton(ImageButton) |
| |
This is a special image submit button that is configured for use with Webware
|
| |
- Method resolution order:
- WebKitImageButton
- ImageButton
- FormKit.BaseFieldClasses.Field
- FormKit.BaseTagClasses.HTMLElement
Methods defined here:
- tag(self)
Methods inherited from ImageButton:
- setImage(self, url, width=None, height=None)
- # Image buttons work just like html buttons, but they pass in the coordinates that the user clicked on
Methods inherited from FormKit.BaseFieldClasses.Field:
- __init__(self, name, validators=[], label='', attributes={}, languageStandard='XHTML')
- The bulk of Field's functionality derives from the code in HTMLElement. In addition,
the Field constructor sets up a bunch of additional containers; validators is a list of
validator/converter instances; the label is a string that is used by some field classes, but not
others, mainly for things like button labels; attributes is a dictionary of parameters that will
be added to the field's HTML tag; languageStandard is whether you want HTML or XHTML tags returned
- addValidator(self, validator)
- Public method to add a validator instance to this field
- clearValidators(self)
- Public method to remove all validators from this field
- default(self)
- Public method to return the default value for this field (if any)
- dump(self)
- Public method for returning a generic lump of HTML to represent the field
- error(self)
- Public method to return any error message resulting from validation (returns None if no error)
- setDefault(self, value)
- Public method to directly set the default value of the field
- validators(self)
- Public method to return the list of validators assigned to this field (if any)
Methods inherited from FormKit.BaseTagClasses.HTMLElement:
- addAttributes(self, attributes)
- Public method for adding tag attributes; merges in a dictionary of tag attributes
- addClass(self, klass)
- Public method for appending a CSS class name to this tag; expects a string
- addStyle(self, dict)
- Public method for adding a style attribute to a tag; takes a dictionary;
the key is the directive, the value is the parameter.
Duplicate key names override their predecessor.
Input like this:
{ 'background-color': 'rgb(255,255,255)',
'font-size: 11px' }
( trailing semicolon can be used, or not )
set a key to None or empty string to remove it from the set
- attributes(self)
- Returns a dictionary of field element attributes
- clearClasses(self)
- removes all CSS classes from the tag
- id(self)
- returns the dom id attribute of this htmlElement
- label(self)
- Generic label parameter access method
- languageStandard(self)
- Generic parameter access method
- name(self)
- Generic name parameter access method
- setAccessKey(self, key)
- Public method for setting the tab index of a field... pass a single character string (a letter)
- setID(self, string)
- Public utility method to surgically override the id tag attribute
- setTabIndex(self, num)
- Public method for setting the tab index of a field... pass an integer
- value(self)
- Generic field value access method
|
class WebKitSubmitButton(SubmitButton) |
| |
This is a special submit button that is configured for use with Webware
|
| |
- Method resolution order:
- WebKitSubmitButton
- SubmitButton
- FormKit.BaseFieldClasses.Field
- FormKit.BaseTagClasses.HTMLElement
Methods defined here:
- tag(self)
Methods inherited from FormKit.BaseFieldClasses.Field:
- __init__(self, name, validators=[], label='', attributes={}, languageStandard='XHTML')
- The bulk of Field's functionality derives from the code in HTMLElement. In addition,
the Field constructor sets up a bunch of additional containers; validators is a list of
validator/converter instances; the label is a string that is used by some field classes, but not
others, mainly for things like button labels; attributes is a dictionary of parameters that will
be added to the field's HTML tag; languageStandard is whether you want HTML or XHTML tags returned
- addValidator(self, validator)
- Public method to add a validator instance to this field
- clearValidators(self)
- Public method to remove all validators from this field
- default(self)
- Public method to return the default value for this field (if any)
- dump(self)
- Public method for returning a generic lump of HTML to represent the field
- error(self)
- Public method to return any error message resulting from validation (returns None if no error)
- setDefault(self, value)
- Public method to directly set the default value of the field
- validators(self)
- Public method to return the list of validators assigned to this field (if any)
Methods inherited from FormKit.BaseTagClasses.HTMLElement:
- addAttributes(self, attributes)
- Public method for adding tag attributes; merges in a dictionary of tag attributes
- addClass(self, klass)
- Public method for appending a CSS class name to this tag; expects a string
- addStyle(self, dict)
- Public method for adding a style attribute to a tag; takes a dictionary;
the key is the directive, the value is the parameter.
Duplicate key names override their predecessor.
Input like this:
{ 'background-color': 'rgb(255,255,255)',
'font-size: 11px' }
( trailing semicolon can be used, or not )
set a key to None or empty string to remove it from the set
- attributes(self)
- Returns a dictionary of field element attributes
- clearClasses(self)
- removes all CSS classes from the tag
- id(self)
- returns the dom id attribute of this htmlElement
- label(self)
- Generic label parameter access method
- languageStandard(self)
- Generic parameter access method
- name(self)
- Generic name parameter access method
- setAccessKey(self, key)
- Public method for setting the tab index of a field... pass a single character string (a letter)
- setID(self, string)
- Public utility method to surgically override the id tag attribute
- setTabIndex(self, num)
- Public method for setting the tab index of a field... pass an integer
- value(self)
- Generic field value access method
| |