Package muntjac :: Package terminal :: Module variable_owner :: Class IVariableOwner
[hide private]
[frames] | no frames]

Class IVariableOwner

source code

object --+
         |
        IVariableOwner

Listener interface for UI variable changes. The user communicates with the application using the so-called variables. When the user makes a change using the UI the terminal trasmits the changed variables to the application, and the components owning those variables may then process those changes.


Authors:
Vaadin Ltd., Richard Lincoln

Version: 1.1.2

Instance Methods [hide private]
 
changeVariables(self, source, variables)
Called when one or more variables handled by the implementing class are changed.
source code
 
isEnabled(self)
Tests if the variable owner is enabled or not.
source code
 
isImmediate(self)
Tests if the variable owner is in immediate mode or not.
source code

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

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

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.

isEnabled(self)

source code 

Tests if the variable owner is enabled or not. The terminal should not send any variable changes to disabled variable owners.

Returns:
True if the variable owner is enabled, False if not

isImmediate(self)

source code 

Tests if the variable owner is in immediate mode or not. Being in immediate mode means that all variable changes are required to be sent back from the terminal immediately when they occur.

Note: IVariableOwner does not include a set-method for the immediateness property. This is because not all VariableOwners wish to offer the functionality. Such VariableOwners are never in the immediate mode, thus they always return False in isImmediate.

Returns:
True if the component is in immediate mode, False if not