mirror of
https://github.com/Jermolene/TiddlyWiki5
synced 2024-12-26 01:50:28 +00:00
9b4b9d4d88
Using `$name` and `$value` attributes allows more flexibility in how parameter names are specified, allowing parameter names that are not valid attribute names.
89 lines
2.1 KiB
JavaScript
89 lines
2.1 KiB
JavaScript
/*\
|
|
title: $:/core/modules/widgets/action-sendmessage.js
|
|
type: application/javascript
|
|
module-type: widget
|
|
|
|
Action widget to send a message
|
|
|
|
\*/
|
|
(function(){
|
|
|
|
/*jslint node: true, browser: true */
|
|
/*global $tw: false */
|
|
"use strict";
|
|
|
|
var Widget = require("$:/core/modules/widgets/widget.js").widget;
|
|
|
|
var SendMessageWidget = function(parseTreeNode,options) {
|
|
this.initialise(parseTreeNode,options);
|
|
};
|
|
|
|
/*
|
|
Inherit from the base widget class
|
|
*/
|
|
SendMessageWidget.prototype = new Widget();
|
|
|
|
/*
|
|
Render this widget into the DOM
|
|
*/
|
|
SendMessageWidget.prototype.render = function(parent,nextSibling) {
|
|
this.computeAttributes();
|
|
this.execute();
|
|
};
|
|
|
|
/*
|
|
Compute the internal state of the widget
|
|
*/
|
|
SendMessageWidget.prototype.execute = function() {
|
|
this.actionMessage = this.getAttribute("$message");
|
|
this.actionParam = this.getAttribute("$param");
|
|
this.actionName = this.getAttribute("$name");
|
|
this.actionValue = this.getAttribute("$value","");
|
|
};
|
|
|
|
/*
|
|
Refresh the widget by ensuring our attributes are up to date
|
|
*/
|
|
SendMessageWidget.prototype.refresh = function(changedTiddlers) {
|
|
var changedAttributes = this.computeAttributes();
|
|
if(Object.keys(changedAttributes).length) {
|
|
this.refreshSelf();
|
|
return true;
|
|
}
|
|
return this.refreshChildren(changedTiddlers);
|
|
};
|
|
|
|
/*
|
|
Invoke the action associated with this widget
|
|
*/
|
|
SendMessageWidget.prototype.invokeAction = function(triggeringWidget,event) {
|
|
// Get the string parameter
|
|
var param = this.actionParam;
|
|
// Assemble the attributes as a hashmap
|
|
var paramObject = Object.create(null);
|
|
var count = 0;
|
|
$tw.utils.each(this.attributes,function(attribute,name) {
|
|
if(name.charAt(0) !== "$") {
|
|
paramObject[name] = attribute;
|
|
count++;
|
|
}
|
|
});
|
|
// Add name/value pair if present
|
|
if(this.actionName) {
|
|
paramObject[this.actionName] = this.actionValue;
|
|
}
|
|
// Dispatch the message
|
|
this.dispatchEvent({
|
|
type: this.actionMessage,
|
|
param: param,
|
|
paramObject: paramObject,
|
|
tiddlerTitle: this.getVariable("currentTiddler"),
|
|
navigateFromTitle: this.getVariable("storyTiddler")
|
|
});
|
|
return true; // Action was invoked
|
|
};
|
|
|
|
exports["action-sendmessage"] = SendMessageWidget;
|
|
|
|
})();
|