Package elisa :: Package base_components :: Module transition :: Class Transition
[hide private]
[frames] | no frames]

Class Transition

source code


Embodies a visual transition between two states of a View.

Nested Classes [hide private]

Inherited from core.component.Component: __metaclass__

Instance Methods [hide private]
 
__init__(self)
Lazily set name from class name styled with underscores (class ComponentBar -> name component_bar.
source code
 
apply(self, view, end_callback='frontend')
Start the transition on view.
source code
 
stop(self)
Interrupt the transition where it is currently calling the end of transition callback if set.
source code

Inherited from core.component.Component: clean, initialize, load_config, save_config

Inherited from extern.log.log.Loggable: debug, doLog, error, info, log, logFunction, logObjectName, warning, warningFailure

Inherited from object: __delattr__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __str__

Static Methods [hide private]

Inherited from core.component.Component: __classinit__

Class Variables [hide private]
list of strings supported_views = ()
path of views that are supported by the transition read only
string name = 'transition'
Component's name

Inherited from core.component.Component: checked, config_doc, default_config, id, plugin

Inherited from extern.log.log.Loggable: logCategory

Instance Variables [hide private]
boolean in_progress
True if the transition is ongoing, False otherwise read only

Inherited from core.component.Component: config, path

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(self)
(Constructor)

source code 
Lazily set name from class name styled with underscores (class ComponentBar -> name component_bar. Also set log category based on component name, with a 'comp_' prefix.
Overrides: core.component.Component.__init__
(inherited documentation)

apply(self, view, end_callback='frontend')

source code 

Start the transition on view.

If end_callback is set, it will be called when the transition ends.
Parameters:
Raises: