Package muntjac :: Package ui :: Module form :: Class Form
[hide private]
[frames] | no frames]

Class Form

source code

                            object --+                    
                                     |                    
                   util.IEventListener --+                
                                         |                
             terminal.paintable.IPaintable --+            
                                             |            
                                object --+   |            
                                         |   |            
    terminal.variable_owner.IVariableOwner --+            
                                             |            
                                object --+   |            
                                         |   |            
               terminal.sizeable.ISizeable --+            
                                             |            
                          component.IComponent --+        
                                                 |        
                                    object --+   |        
                                             |   |        
  event.method_event_source.IMethodEventSource --+        
                                                 |        
              abstract_component.AbstractComponent --+    
                                                     |    
                                object --+           |    
                                         |           |    
                   data.buffered.IBuffered --+       |    
                                             |       |    
                                object --+   |       |    
                                         |   |       |    
             data.validatable.IValidatable --+       |    
                                             |       |    
            data.buffered.IBufferedValidatable --+   |    
                                                 |   |    
                                    object --+   |   |    
                                             |   |   |    
            data.property.IValueChangeNotifier --+   |    
                                                 |   |    
                                    object --+   |   |    
                                             |   |   |    
            data.property.IValueChangeListener --+   |    
                                                 |   |    
                                object --+       |   |    
                                         |       |   |    
                     data.property.IViewer --+   |   |    
                                             |   |   |    
                         data.property.IEditor --+   |    
                                                 |   |    
                        object --+               |   |    
                                 |               |   |    
               util.IEventListener --+           |   |    
                                     |           |   |    
         terminal.paintable.IPaintable --+       |   |    
                                         |       |   |    
                            object --+   |       |   |    
                                     |   |       |   |    
terminal.variable_owner.IVariableOwner --+       |   |    
                                         |       |   |    
                            object --+   |       |   |    
                                     |   |       |   |    
           terminal.sizeable.ISizeable --+       |   |    
                                         |       |   |    
                      component.IComponent --+   |   |    
                                             |   |   |    
                          component.IFocusable --+   |    
                                                 |   |    
                                      field.IField --+    
                                                     |    
                                        object --+   |    
                                                 |   |    
                    event.action.IShortcutNotifier --+    
                                                     |    
                                        object --+   |    
                                                 |   |    
       data.property.IReadOnlyStatusChangeNotifier --+    
                                                     |    
                                        object --+   |    
                                                 |   |    
       data.property.IReadOnlyStatusChangeListener --+    
                                                     |    
                          abstract_field.AbstractField --+
                                                         |
                                        object --+       |
                                                 |       |
                                 data.item.IViewer --+   |
                                                     |   |
                                     data.item.IEditor --+
                                                         |
                                            object --+   |
                                                     |   |
                               data.buffered.IBuffered --+
                                                         |
                                            object --+   |
                                                     |   |
                                       data.item.IItem --+
                                                         |
                                            object --+   |
                                                     |   |
                         data.validatable.IValidatable --+
                                                         |
                                        object --+       |
                                                 |       |
                           event.action.IContainer --+   |
                                                     |   |
                                event.action.INotifier --+
                                                         |
                                                        Form

Form component provides easy way of creating and managing sets fields.

Form is a container for fields implementing IField interface. It provides support for any layouts and provides buffering interface for easy connection of commit and discard buttons. All the form fields can be customized by adding validators, setting captions and icons, setting immediateness, etc. Also direct mechanism for replacing existing fields with selections is given.

Form provides customizable editor for classes implementing IItem interface. Also the form itself implements this interface for easier connectivity to other items. To use the form as editor for an item, just connect the item to form with Form.setItemDataSource. If only a part of the item needs to be edited, Form.setItemDataSource can be used instead. After the item has been connected to the form, the automatically created fields can be customized and new fields can be added. If you need to connect a class that does not implement IItem interface, most properties of any class following bean pattern, can be accessed trough muntjac.data.util.BeanItem.


Authors:
Vaadin Ltd., Richard Lincoln

Version: 1.1.2

Instance Methods [hide private]
 
__init__(self, formLayout=None, fieldFactory=None)
Constructs a new form with given Layout and FormFieldFactory.
source code
 
paintContent(self, target)
Paints any needed component-specific things to the given UIDL stream.
source code
 
changeVariables(self, source, variables)
Called when one or more variables handled by the implementing class are changed.
source code
 
getErrorMessage(self)
The error message of a Form is the error of the first field with a non-empty error.
source code
 
setValidationVisibleOnCommit(self, makeVisible)
Controls the making validation visible implicitly on commit.
source code
 
isValidationVisibleOnCommit(self)
Is validation made automatically visible on commit?
source code
 
commit(self)
Updates all changes since the previous commit to the data source.
source code
 
discard(self)
Discards all changes since last commit.
source code
 
isModified(self)
Tests if the value stored in the object has been modified since it was last updated from the data source.
source code
 
isReadThrough(self)
Tests if the object is in read-through mode.
source code
 
isWriteThrough(self)
Tests if the object is in write-through mode.
source code
 
setReadThrough(self, readThrough)
Sets the object's read-through mode to the specified status.
source code
 
setWriteThrough(self, writeThrough)
Sets the object's write-through mode to the specified status.
source code
 
addItemProperty(self, idd, prop)
Adds a new property to form and create corresponding field.
source code
 
addField(self, propertyId, field)
Registers the field with the form and adds the field to the form layout.
source code
 
registerField(self, propertyId, field)
Register the field with the form.
source code
 
attachField(self, propertyId, field)
Adds the field to the form layout.
source code
 
getItemProperty(self, idd)
The property identified by the property id.
source code
 
getField(self, propertyId)
Gets the field identified by the propertyid.
source code
 
getItemPropertyIds(self)
Gets the collection of IDs of all Properties stored in the IItem.
source code
 
removeItemProperty(self, idd)
Removes the property and corresponding field from the form.
source code
 
detachField(self, field)
Called when a form field is detached from a Form.
source code
 
removeAllProperties(self)
Removes all properties and fields from the form.
source code
 
getItemDataSource(self)
Gets the IItem serving as the data source of the viewer.
source code
 
setItemDataSource(self, newDataSource, propertyIds=None)
Set the item datasource for the form, but limit the form contents to specified properties of the item.
source code
 
getLayout(self)
Gets the layout of the form.
source code
 
setLayout(self, newLayout)
Sets the layout of the form.
source code
 
replaceWithSelect(self, propertyId, values, descriptions)
Sets the form field to be selectable from static list of changes.
source code
 
attach(self)
Notifies the component that it is connected to an application
source code
 
detach(self)
Notifies the component that it is detached from the application.
source code
 
isValid(self)
Tests the current value of the object against all registered validators
source code
 
validate(self)
Checks the validity of the validatable.
source code
 
isInvalidAllowed(self)
Checks the validabtable object accept invalid values.
source code
 
setInvalidAllowed(self, invalidValueAllowed)
Should the validabtable object accept invalid values.
source code
 
setReadOnly(self, readOnly)
Sets the component's to read-only mode to the specified state.
source code
 
setFieldFactory(self, fieldFactory)
Sets the field factory of Form.
source code
 
setFormFieldFactory(self, fieldFactory)
Sets the field factory used by this Form to genarate Fields for properties.
source code
 
getFormFieldFactory(self)
Get the field factory of the form.
source code
 
getFieldFactory(self)
Get the field factory of the form.
source code
 
getType(self)
Gets the field type.
source code
 
setInternalValue(self, newValue)
Sets the internal value.
source code
 
getFirstFocusableField(self)
Gets the first focusable field in form.
source code
 
setFormDataSource(self, data, properties)
Updates the internal form datasource.
source code
 
getVisibleItemProperties(self)
Returns the visibleProperties.
source code
 
setVisibleItemProperties(self, visibleProperties)
Sets the visibleProperties.
source code
 
focus(self)
Focuses the first field in the form.
source code
 
setTabIndex(self, tabIndex)
Sets the Tabulator index of this Focusable component.
source code
 
setImmediate(self, immediate)
Setting the form to be immediate also sets all the fields of the form to the same state.
source code
 
isEmpty(self)
Form is empty if all of its fields are empty.
source code
 
addValidator(self, validator)
Adding validators directly to form is not supported.
source code
 
getFooter(self)
Returns a layout that is rendered below normal form contents.
source code
 
setFooter(self, newFormFooter)
Sets the layout that is rendered below normal form contents.
source code
 
setEnabled(self, enabled)
Enables or disables the component.
source code
 
getOwnActionManager(self)
Gets the ActionManager responsible for handling Actions added to this Form.
source code
 
addActionHandler(self, actionHandler)
Registers a new action handler for this container
source code
 
removeActionHandler(self, actionHandler)
Removes a previously registered action handler for the contents of this container.
source code
 
removeAllActionHandlers(self)
Removes all action handlers
source code
 
addAction(self, action) source code
 
removeAction(self, action) source code

Inherited from abstract_field.AbstractField: __str__, addCallback, addListener, addShortcutListener, fireReadOnlyStatusChange, fireValueChange, getActionManager, getPropertyDataSource, getRequiredError, getTabIndex, getValidators, getValue, isInvalidCommitted, isReadOnly, isRequired, isValidationVisible, readOnlyStatusChange, readValueFromProperty, removeCallback, removeListener, removeShortcutListener, removeValidator, setCurrentBufferedSourceException, setInvalidCommitted, setPropertyDataSource, setRequired, setRequiredError, setValidationVisible, setValue, shouldHideErrors, valueChange

Inherited from abstract_component.AbstractComponent: __getstate__, __setstate__, addStyleName, childRequestedRepaint, fireComponentErrorEvent, fireComponentEvent, fireEvent, fireRequestRepaintEvent, getApplication, getCSSHeight, getCSSWidth, getCaption, getComponentError, getData, getDebugId, getDescription, getErrorHandler, getHeight, getHeightUnits, getIcon, getListeners, getLocale, getParent, getStyle, getStyleName, getWidth, getWidthUnits, getWindow, handleError, hasListeners, isEnabled, isImmediate, isVisible, paint, parseStringSize, registerCallback, registerListener, removeStyleName, requestRepaint, requestRepaintRequests, setCaption, setComponentError, setData, setDebugId, setDescription, setErrorHandler, setHeight, setHeightUnits, setIcon, setLocale, setParent, setSizeFull, setSizeUndefined, setStyle, setStyleName, setVisible, setWidth, setWidthUnits, withdrawCallback, withdrawListener

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __subclasshook__

Class Methods [hide private]

Inherited from abstract_field.AbstractField: constructField

Class Variables [hide private]
  CLIENT_WIDGET = None
hash(x)

Inherited from abstract_component.AbstractComponent: SIZE_PATTERN

Inherited from terminal.sizeable.ISizeable: SIZE_UNDEFINED, UNITS_CM, UNITS_EM, UNITS_EX, UNITS_INCH, UNITS_MM, UNITS_PERCENTAGE, UNITS_PICAS, UNITS_PIXELS, UNITS_POINTS, UNIT_SYMBOLS

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(self, formLayout=None, fieldFactory=None)
(Constructor)

source code 

Constructs a new form with given Layout and FormFieldFactory.

By default the form uses FormLayout.

Parameters:
  • formLayout - the layout of the form.
  • fieldFactory - the IFieldFactory of the form.
Overrides: object.__init__

paintContent(self, target)

source code 

Paints any needed component-specific things to the given UIDL stream. The more general paint method handles all general attributes common to all components, and it calls this method to paint any component-specific attributes to the UIDL stream.

Parameters:
  • target - the target UIDL stream where the component should paint itself to
Raises:
Overrides: abstract_component.AbstractComponent.paintContent
(inherited documentation)

changeVariables(self, source, variables)

source code 

Called when one or more variables handled by the implementing class are changed.

Parameters:
  • source - the Source of the variable change. This is the origin of the event. For example in Web Adapter this is the request.
  • variables - the Mapping from variable names to new variable values.
Overrides: terminal.variable_owner.IVariableOwner.changeVariables
(inherited documentation)

getErrorMessage(self)

source code 

The error message of a Form is the error of the first field with a non-empty error.

Empty error messages of the contained fields are skipped, because an empty error indicator would be confusing to the user, especially if there are errors that have something to display. This is also the reason why the calculation of the error message is separate from validation, because validation fails also on empty errors.

Returns:
ErrorMessage containing the description of the error state of the component or null, if the component contains no errors. Extending classes should override this method if they support other error message types such as validation errors or buffering errors. The returned error message contains information about all the errors.
Overrides: abstract_component.AbstractComponent.getErrorMessage

setValidationVisibleOnCommit(self, makeVisible)

source code 

Controls the making validation visible implicitly on commit.

Having commit() call setValidationVisible(True) implicitly is the default behaviour. You can disable the implicit setting by setting this property as false.

It is useful, because you usually want to start with the form free of errors and only display them after the user clicks Ok. You can disable the implicit setting by setting this property as false.

Parameters:
  • makeVisible - If true (default), validation is made visible when commit() is called. If false, the visibility is left as it is.

isValidationVisibleOnCommit(self)

source code 

Is validation made automatically visible on commit?

See setValidationVisibleOnCommit().

Returns:
true if validation is made automatically visible on commit.

commit(self)

source code 

Updates all changes since the previous commit to the data source. The value stored in the object will always be updated into the data source when commit is called.

Raises:
  • SourceException - if the operation fails because of an exception is thrown by the data source. The cause is included in the exception.
  • InvalidValueException - if the operation fails because validation is enabled and the values do not validate
Overrides: data.buffered.IBuffered.commit
(inherited documentation)

discard(self)

source code 

Discards all changes since last commit. The object updates its value from the data source.

Raises:
  • SourceException - if the operation fails because of an exception is thrown by the data source. The cause is included in the exception.
Overrides: data.buffered.IBuffered.discard
(inherited documentation)

isModified(self)

source code 

Tests if the value stored in the object has been modified since it was last updated from the data source.

Returns:
True if the value in the object has been modified since the last data source update, False if not.
Overrides: data.buffered.IBuffered.isModified
(inherited documentation)

isReadThrough(self)

source code 

Tests if the object is in read-through mode. If the object is in read-through mode, retrieving its value will result in the value being first updated from the data source to the object.

The only exception to this rule is that when the object is not in write-through mode and it's buffer contains a modified value, the value retrieved from the object will be the locally modified value in the buffer which may differ from the value in the data source.

Returns:
True if the object is in read-through mode, False if it's not.
Overrides: data.buffered.IBuffered.isReadThrough
(inherited documentation)

isWriteThrough(self)

source code 

Tests if the object is in write-through mode. If the object is in write-through mode, all modifications to it will result in commit being called after the modification.

Returns:
True if the object is in write-through mode, False if it's not.
Overrides: data.buffered.IBuffered.isWriteThrough
(inherited documentation)

setReadThrough(self, readThrough)

source code 

Sets the object's read-through mode to the specified status. When switching read-through mode on, the object's value is updated from the data source.

Parameters:
  • readThrough - Boolean value to indicate if the object should be in read-through mode after the call.
Raises:
  • SourceException - If the operation fails because of an exception is thrown by the data source. The cause is included in the exception.
Overrides: data.buffered.IBuffered.setReadThrough
(inherited documentation)

setWriteThrough(self, writeThrough)

source code 

Sets the object's write-through mode to the specified status. When switching the write-through mode on, the commit operation will be performed.

Parameters:
  • writeThrough - Boolean value to indicate if the object should be in write-through mode after the call.
Raises:
  • SourceException - If the operation fails because of an exception is thrown by the data source.
  • InvalidValueException - If the implicit commit operation fails because of a validation error.
Overrides: data.buffered.IBuffered.setWriteThrough
(inherited documentation)

addItemProperty(self, idd, prop)

source code 

Adds a new property to form and create corresponding field.

Parameters:
  • idd - ID of the new Property
  • prop - the Property to be added and associated with the id
Returns:
True if the operation succeeded, False if not
Raises:
  • NotImplementedError - if the operation is not supported.
Overrides: data.item.IItem.addItemProperty

addField(self, propertyId, field)

source code 

Registers the field with the form and adds the field to the form layout.

The property id must not be already used in the form.

This field is added to the layout using the attachField method.

Parameters:
  • propertyId - the Property id the the field.
  • field - the field which should be added to the form.

registerField(self, propertyId, field)

source code 

Register the field with the form. All registered fields are validated when the form is validated and also committed when the form is committed.

The property id must not be already used in the form.

Parameters:
  • propertyId - the Property id of the field.
  • field - the IField that should be registered

attachField(self, propertyId, field)

source code 

Adds the field to the form layout.

The field is added to the form layout in the default position (the position used by Layout.addComponent. If the underlying layout is a CustomLayout the field is added to the CustomLayout location given by the string representation of the property id using CustomLayout.addComponent.

Override this method to control how the fields are added to the layout.

getItemProperty(self, idd)

source code 

The property identified by the property id.

The property data source of the field specified with property id is returned. If there is a (with specified property id) having no data source, the field is returned instead of the data source.

Parameters:
  • idd - identifier of the Property to get
Returns:
the Property with the given ID or None
Overrides: data.item.IItem.getItemProperty

getField(self, propertyId)

source code 

Gets the field identified by the propertyid.

Parameters:
  • propertyId - the id of the property.

getItemPropertyIds(self)

source code 

Gets the collection of IDs of all Properties stored in the IItem.

Returns:
iterable containing IDs of the Properties stored the IItem
Overrides: data.item.IItem.getItemPropertyIds
(inherited documentation)

removeItemProperty(self, idd)

source code 

Removes the property and corresponding field from the form.

Parameters:
  • idd - ID of the Property to be removed
Returns:
True if the operation succeeded False if not
Raises:
  • NotImplementedError - if the operation is not supported.
Overrides: data.item.IItem.removeItemProperty

detachField(self, field)

source code 

Called when a form field is detached from a Form. Typically when a new IItem is assigned to Form via setItemDataSource.

Override this method to control how the fields are removed from the layout.

Parameters:
  • field - the field to be detached from the forms layout.

removeAllProperties(self)

source code 

Removes all properties and fields from the form.

Returns:
the Success of the operation. Removal of all fields succeeded if (and only if) the return value is True.

getItemDataSource(self)

source code 

Gets the IItem serving as the data source of the viewer.

Returns:
data source IItem
Overrides: data.item.IViewer.getItemDataSource
(inherited documentation)

setItemDataSource(self, newDataSource, propertyIds=None)

source code 

Set the item datasource for the form, but limit the form contents to specified properties of the item.

Setting item datasource clears any fields, the form might contain and adds the specified the properties as fields to the form, in the specified order.

Parameters:
  • newDataSource - The new data source IItem
Overrides: data.item.IViewer.setItemDataSource

See Also: Viewer.setItemDataSource

getLayout(self)

source code 

Gets the layout of the form.

By default form uses OrderedLayout with form-style.

Returns:
the Layout of the form.

setLayout(self, newLayout)

source code 

Sets the layout of the form.

By default form uses OrderedLayout with form-style.

Parameters:
  • newLayout - the Layout of the form.

replaceWithSelect(self, propertyId, values, descriptions)

source code 

Sets the form field to be selectable from static list of changes.

The list values and descriptions are given as array. The value-array must contain the current value of the field and the lengths of the arrays must match. Null values are not supported.

Parameters:
  • propertyId - the id of the property.
  • values
  • descriptions
Returns:
the select property generated

attach(self)

source code 

Notifies the component that it is connected to an application

Overrides: component.IComponent.attach

See Also: IComponent.attach

detach(self)

source code 

Notifies the component that it is detached from the application.

Overrides: component.IComponent.detach

See Also: IComponent.detach

isValid(self)

source code 

Tests the current value of the object against all registered validators

Returns:
True if all registered validators claim that the current value is valid or if the field is empty and not required, False otherwise.
Overrides: data.validatable.IValidatable.isValid

validate(self)

source code 

Checks the validity of the validatable.

Raises:
Overrides: data.validatable.IValidatable.validate

isInvalidAllowed(self)

source code 

Checks the validabtable object accept invalid values.

Returns:
true iff the invalid values are allowed.
Overrides: data.validatable.IValidatable.isInvalidAllowed

setInvalidAllowed(self, invalidValueAllowed)

source code 

Should the validabtable object accept invalid values.

Raises:
  • NotImplementedError - if the setInvalidAllowed is not supported.
Overrides: data.validatable.IValidatable.setInvalidAllowed

setReadOnly(self, readOnly)

source code 

Sets the component's to read-only mode to the specified state.

Parameters:
  • readOnly - a boolean value specifying whether the component is put read-only mode or not
Overrides: component.IComponent.setReadOnly

setFieldFactory(self, fieldFactory)

source code 

Sets the field factory of Form.

IFieldFactory is used to create fields for form properties. By default the form uses BaseFieldFactory to create IField instances.

Parameters:
  • fieldFactory - the New factory used to create the fields.
See Also:
IField, FormFieldFactory

Deprecated: use setFormFieldFactory instead

setFormFieldFactory(self, fieldFactory)

source code 

Sets the field factory used by this Form to genarate Fields for properties.

FormFieldFactory is used to create fields for form properties. DefaultFieldFactory is used by default.

Parameters:
  • fieldFactory - the new factory used to create the fields.
See Also:
IField, FormFieldFactory

getFormFieldFactory(self)

source code 

Get the field factory of the form.

Returns:
the FormFieldFactory Factory used to create the fields.

getFieldFactory(self)

source code 

Get the field factory of the form.

Returns:
the IFieldFactory Factory used to create the fields.

Deprecated: Use getFormFieldFactory instead. Set the FormFieldFactory using setFormFieldFactory.

getType(self)

source code 

Gets the field type.

Overrides: abstract_field.AbstractField.getType

setInternalValue(self, newValue)

source code 

Sets the internal value.

This is relevant when the Form is used as IField.

Parameters:
  • newValue - the new value to be set.
Overrides: abstract_field.AbstractField.setInternalValue

getFirstFocusableField(self)

source code 

Gets the first focusable field in form. If there are enabled, non-read-only fields, the first one of them is returned. Otherwise, the field for the first property (or null if none) is returned.

Returns:
the IField.

setFormDataSource(self, data, properties)

source code 

Updates the internal form datasource.

Method setFormDataSource.

getVisibleItemProperties(self)

source code 

Returns the visibleProperties.

Returns:
the collection of visible IItem properites.

setVisibleItemProperties(self, visibleProperties)

source code 

Sets the visibleProperties.

Parameters:
  • visibleProperties - the visibleProperties to set.

focus(self)

source code 

Focuses the first field in the form.

Overrides: component.IFocusable.focus

See Also: IFocusable.focus

setTabIndex(self, tabIndex)

source code 

Sets the Tabulator index of this Focusable component.

Parameters:
  • tabIndex - the tab order of this component. Indexes usually start from 1. Zero means that default tab order should be used. A negative value means that the field should not be included in the tabbing sequence.
Overrides: component.IFocusable.setTabIndex

setImmediate(self, immediate)

source code 

Setting the form to be immediate also sets all the fields of the form to the same state.

Parameters:
  • immediate - the boolean value specifying if the component should be in the immediate mode after the call.
Overrides: abstract_component.AbstractComponent.setImmediate

isEmpty(self)

source code 

Form is empty if all of its fields are empty.

Overrides: abstract_field.AbstractField.isEmpty

addValidator(self, validator)

source code 

Adding validators directly to form is not supported.

Add the validators to form fields instead.

Parameters:
  • validator - the new validator to be added.
Overrides: data.validatable.IValidatable.addValidator

getFooter(self)

source code 

Returns a layout that is rendered below normal form contents. This area can be used for example to include buttons related to form contents.

Returns:
layout rendered below normal form contents.

setFooter(self, newFormFooter)

source code 

Sets the layout that is rendered below normal form contents.

Parameters:
  • newFormFooter - the new Layout

setEnabled(self, enabled)

source code 

Enables or disables the component. The user can not interact disabled components, which are shown with a style that indicates the status, usually shaded in light gray color. Components are enabled by default. Children of a disabled component are automatically disabled; if a child component is explicitly set as disabled, changes in the disabled status of its parents do not change its status:

 enabled = new Button("Enabled")
 enabled.setEnabled(True)  # the default
 layout.addComponent(enabled)

 disabled = Button("Disabled")
 disabled.setEnabled(False)
 layout.addComponent(disabled)

This method will trigger a RepaintRequestEvent for the component and, if it is a ComponentContainer, for all its children recursively.

Parameters:
  • enabled - a boolean value specifying if the component should be enabled or not
Overrides: component.IComponent.setEnabled
(inherited documentation)

getOwnActionManager(self)

source code 

Gets the ActionManager responsible for handling Actions added to this Form.

Note that Form has another ActionManager inherited from AbstractField. The ownActionManager handles Actions attached to this Form specifically, while the ActionManager in AbstractField delegates to the containing Window (i.e global Actions).

addActionHandler(self, actionHandler)

source code 

Registers a new action handler for this container

Parameters:
  • actionHandler - the new handler to be added.
Overrides: event.action.IContainer.addActionHandler
(inherited documentation)

removeActionHandler(self, actionHandler)

source code 

Removes a previously registered action handler for the contents of this container.

Parameters:
  • actionHandler - the handler to be removed.
Overrides: event.action.IContainer.removeActionHandler
(inherited documentation)

addAction(self, action)

source code 
Overrides: event.action.INotifier.addAction

removeAction(self, action)

source code 
Overrides: event.action.INotifier.removeAction