Class e.p.p.p.PigmentFrontendExtensionMixin(Loggable):

Part of elisa.plugins.pigment.pigment_frontend View In Hierarchy

Known subclasses: elisa.plugins.pigment.pigment_frontend.PigmentFrontend, elisa.plugins.pigment.tests.test_pigment_frontend.PigmentFrontendExtensionMixinStub

No class docstring
Line # Kind Name Docs
56 Method __init__ Undocumented
130 Method add_controller Add a new controller to the frontend. The controller is the one that
143 Method remove_controller Remove a controller from the frontend.
154 Method create_controller Create a controller for the given path.
190 Method retrieve_controllers Retrieve the list of controllers for a given path.
207 Method add_decorator Add a decorator function for controllers matching path_pattern.
224 Method remove_decorator Remove a decorator function from the frontend.
69 Method _update_controller_mappings Undocumented
82 Method _load_controller_mappings Load the controller mappings from all the enabled plugins' metadata.
93 Method _update_decorator_mappings Undocumented
106 Method _load_decorator_mappings Load the decorator mappings from all the enabled plugins' metadata.
117 Method _plugin_status_changed_cb Undocumented
183 Method _store_controller Undocumented
235 Method _set_frontend Undocumented
240 Method _set_path Undocumented
245 Method _decorator_callback Undocumented
250 Method _decorator_errback Undocumented
256 Method _iterate_decorators_callback Undocumented
260 Method _iterate_decorators Undocumented
286 Method _decorate Undocumented
def __init__(self):
Undocumented
def _update_controller_mappings(self, plugin, enabled):
Undocumented
def _load_controller_mappings(self):
Load the controller mappings from all the enabled plugins' metadata.
def _update_decorator_mappings(self, plugin, enabled):
Undocumented
def _load_decorator_mappings(self):
Load the decorator mappings from all the enabled plugins' metadata.
def _plugin_status_changed_cb(self, message, sender):
Undocumented
def add_controller(self, path_pattern, controller):
Add a new controller to the frontend. The controller is the one that will be loaded for paths matching path_pattern.
Parameterspath_patternregular expression pattern (type: str )
controllercontroller class or component path (type: elisa.core.components.controller.Controller or component path string of a controller class )
def remove_controller(self, path_pattern):
Remove a controller from the frontend. The controller is the one that would be loaded for paths matching path_pattern.
Parameterspath_patterna regular expression pattern (type: str )
def create_controller(self, path, config=None, wait_for_decorators=False, **kwargs):
Create a controller for the given path.
Parameterspathpath (type: str )
configconfiguration to set for the controller (type: configobj section )
Returnscontroller instance (type: elisa.core.components.controller.Controller )
def _store_controller(self, controller, path):
Undocumented
def retrieve_controllers(self, path):

Retrieve the list of controllers for a given path.

The list will contain all the controllers created for the path which haven't been garbage collected.
Parameterspaththe controllers' path (type: string )
Returnslist of controllers for the given path (type: list of elisa.plugins.pigment.PigmentController )
def add_decorator(self, path_pattern, decorator):

Add a decorator function for controllers matching path_pattern.

A controller decorator is a callable object that is called when a new controller is created. It can be used to alter the behaviour of a controller (say, the UI created by the controller). Controller decorators are called with a controller instance as their only argument and should return a deferred.
Parameterspath_patternpath pattern (type: str )
decoratordecorator callable or decorator path string (type: callable or str )
def remove_decorator(self, path_pattern):
Remove a decorator function from the frontend. The decorator is the one that would be called for controllers with a path matching path_pattern.
Parameterspath_patterna regular expression pattern (type: str )
def _set_frontend(self, controller):
Undocumented
def _set_path(self, controller, path):
Undocumented
def _decorator_callback(self, result, resultlist):
Undocumented
def _decorator_errback(self, failure, resultlist):
Undocumented
def _iterate_decorators_callback(self, iterator, results, controller, dfr):
Undocumented
def _iterate_decorators(self, controller, matches, resultlist):
Undocumented
def _decorate(self, controller, wait_for_decorators):
Undocumented
API Documentation for Elisa Media Center, generated by pydoctor at 2008-11-03 19:10:55.