dxlconsole.module module¶

class dxlconsole.module.Module(app, name, title, icon_path, root_content_name)¶

Bases: object

The base class for pluggable modules within the console. The "fabric module" is an example of a module.

Constructor parameters:

Parameters:	app -- The application that the module is a part of name -- The name of the module title -- The title for the module icon_path -- The path to the icon for the module root_content_name -- The name of the root content (in browser DOM) of the module

app¶

Returns the application that the module is a part of

Returns:	The application that the module is a part of

content¶

The content of the module (JS code)

Returns:	The content of the module (JS code)

enabled¶

Returns whether the module is enabled

Returns:	Whether the module is enabled

get_icon_path¶

Returns the path to the icon for the module

Returns:	The path to the icon for the module

handlers¶

Web (Tornado) handlers for the module

Returns:	The web (Tornado) handlers for the module

name¶

Returns the name of the module

Returns:	The name of the module

on_load(request)¶

Invoked when the module is loaded for initial display

Parameters:	request -- The HTTP request for the display

root_content_name¶: The name of the root content (in browser DOM) of the module :return: The name of the root content (in browser DOM) of the module

title¶

Returns the title of the module

Returns:	The title of the module