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
62 Method __init__ Undocumented
108 Method plugin_status_changed_cb Callback meant to be invoked (by the plugin registry) when the status
118 Method add_controller Add a new controller to the frontend. The controller is the one that
131 Method remove_controller Remove a controller from the frontend.
142 Method create_controller Create a controller for the given path.
178 Method retrieve_controllers Retrieve the list of controllers for a given path.
195 Method add_decorator Add a decorator function for controllers matching path_pattern.
212 Method remove_decorator Remove a decorator function from the frontend.
68 Method _load_enabled_controller_and_decorator_mappings Load the controller and decorator mappings from all the enabled
82 Method _update_controller_mappings Undocumented
95 Method _update_decorator_mappings Undocumented
171 Method _store_controller Undocumented
223 Method _set_frontend Undocumented
228 Method _set_path Undocumented
233 Method _decorator_callback Undocumented
238 Method _decorator_errback Undocumented
244 Method _iterate_decorators_callback Undocumented
248 Method _iterate_decorators Undocumented
274 Method _decorate Undocumented
def __init__(self):
Undocumented
def _load_enabled_controller_and_decorator_mappings(self):
Load the controller and decorator mappings from all the enabled plugins' metadata.
def _update_controller_mappings(self, plugin, enabled):
Undocumented
def _update_decorator_mappings(self, plugin, enabled):
Undocumented
def plugin_status_changed_cb(self, plugin, status):
Callback meant to be invoked (by the plugin registry) when the status of a plugin has changed. Update the controller and decorator mappings accordingly.
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 2009-02-16 19:15:05.