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
Line # | Kind | Name | Docs |
---|---|---|---|
63 | Method | __init__ | Undocumented |
109 | Method | plugin_status_changed_cb | Callback meant to be invoked (by the plugin registry) when the status |
119 | Method | add_controller | Add a new controller to the frontend. The controller is the one that |
132 | Method | remove_controller | Remove a controller from the frontend. |
143 | Method | create_controller | Create a controller for the given path. |
179 | Method | retrieve_controllers | Retrieve the list of controllers for a given path. |
196 | Method | add_decorator | Add a decorator function for controllers matching path_pattern. |
213 | Method | remove_decorator | Remove a decorator function from the frontend. |
69 | Method | _load_enabled_controller_and_decorator_mappings | Load the controller and decorator mappings from all the enabled |
83 | Method | _update_controller_mappings | Undocumented |
96 | Method | _update_decorator_mappings | Undocumented |
172 | Method | _store_controller | Undocumented |
224 | Method | _set_frontend | Undocumented |
229 | Method | _set_path | Undocumented |
234 | Method | _decorator_callback | Undocumented |
239 | Method | _decorator_errback | Undocumented |
245 | Method | _iterate_decorators_callback | Undocumented |
249 | Method | _iterate_decorators | Undocumented |
275 | Method | _decorate | Undocumented |
path_pattern
.Parameters | path_pattern | regular expression pattern
(type: str
) |
controller | controller class or component path
(type: elisa.core.components.controller.Controller
or component path string of a controller class
) |
path_pattern
.Parameters | path_pattern | a regular expression pattern
(type: str
) |
Parameters | path | path
(type: str
) |
config | configuration to set for the controller (type: configobj section ) | |
Returns | controller instance
(type: elisa.core.components.controller.Controller
) |
The list will contain all the controllers created for the path which haven't been garbage collected.
Parameters | path | the controllers' path (type: string ) |
Returns | list of controllers for the given path
(type: list of elisa.plugins.pigment.PigmentController
) |
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.
Parameters | path_pattern | path pattern
(type: str
) |
decorator | decorator callable or decorator path string
(type: callable or str
) |