Tc.Module Class
Base class for the different modules.
Item Index
Properties
Methods
attachConnector
-
connector
Attaches a connector (observer).
Parameters:
-
connector
ConnectorThe connector to attach
detachConnector
-
connector
Detaches a connector (observer).
Parameters:
-
connector
ConnectorThe connector to detach
fire
-
state
-
data
-
channels
-
defaultAction
Notifies all attached connectors about changes.
Parameters:
-
state
StringThe new state
-
data
ObjectThe data to provide to your connected modules (optional)
-
channels
ArrayA list containing the channel ids to send the event to (optional)
-
defaultAction
FunctionThe default action to perform (optional)
getDecoratedModule
-
module
-
skin
Decorates itself with the given skin.
Parameters:
-
module
StringThe name of the module
-
skin
StringThe name of the skin
Returns:
The decorated module
init
-
$ctx
-
sandbox
-
id
Initializes the Module.
Parameters:
-
$ctx
JQueryThe jQuery context
-
sandbox
SandboxThe sandbox to get the resources from
-
id
StringThe Unique module ID
initAfter
()
protected
Initialization callback.
start
()
Template method to start (i.e. init) the module. This method provides hook functions which can be overridden by the individual instance.
stop
()
Template method to stop the module.
Properties
$ctx
JQuery
Contains the module context.
connectors
Object
Contains the attached connectors.
id
String
Contains the unique module ID.
sandbox
Sandbox
The sandbox to get the resources from.