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 |
---|---|---|---|
51 | Method | __init__ | Undocumented |
84 | Method | add_controller | Add a new controller to the frontend. The controller is the one that |
97 | Method | create_controller | Create a controller for the given path. |
133 | Method | retrieve_controllers | Retrieve the list of controllers for a given path. |
150 | Method | add_decorator | Add a decorator function for controllers matching path_pattern. |
62 | Method | _load_controller_mappings | Load the controller mappings from all plugins' metadata. |
73 | Method | _load_decorator_mappings | Load the controller mappings from all plugins' metadata. |
126 | Method | _store_controller | Undocumented |
167 | Method | _set_frontend | Undocumented |
172 | Method | _set_path | Undocumented |
177 | Method | _decorator_callback | Undocumented |
182 | Method | _decorator_errback | Undocumented |
188 | Method | _iterate_decorators_callback | Undocumented |
192 | Method | _iterate_decorators | Undocumented |
218 | 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
) |
Parameters | path | path
(type: str
) |
config | configuration to set for the controller (type: configobj section ) | |
Returns | controller instance
(type: elisa.core.components.controller.Controller
) |
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.Parameters | path | the controllers' path (type: string ) |
Returns | list of controllers for the given path
(type: list of elisa.plugins.pigment.PigmentController
) |
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.Parameters | path_pattern | path pattern
(type: str
) |
decorator | decorator callable or decorator path string
(type: callable or str
) |