macrorefresh.js

/*\
title: $:/core/modules/widgets/macrorefresh.js
type: application/javascript
module-type: widget

Macrocall widget

\*/
(function(){

/*jslint node: true, browser: true */
/*global $tw: false */
"use strict";

var Widget = require("$:/core/modules/widgets/widget.js").widget;

var MacroCallWidget = function(parseTreeNode,options) {
	this.initialise(parseTreeNode,options);
};

/*
Inherit from the base widget class
*/
MacroCallWidget.prototype = new Widget();

/*
Render this widget into the DOM
*/
MacroCallWidget.prototype.render = function(parent,nextSibling) {
	this.parentDomNode = parent;
	this.computeAttributes();
	this.execute();
	this.renderChildren(parent,nextSibling);
};

/*
Compute the internal state of the widget
*/
MacroCallWidget.prototype.execute = function() {
	var self = this;
	// Get the parse type if specified
	this.parseType = this.getAttribute("$type","text/vnd.tiddlywiki");
	this.renderOutput = this.getAttribute("$output","text/html");
	// Merge together the parameters specified in the parse tree with the specified attributes
	this.params = this.parseTreeNode.params ? this.parseTreeNode.params.slice(0) : [];
	$tw.utils.each(this.attributes,function(attribute,name) {
		if(name.charAt(0) !== "$") {
			self.params.push({name: name, value: attribute});			
		}
	});
	// Get the macro value
	var text = this.getVariable(this.parseTreeNode.name || this.getAttribute("$name"),{params: this.params}),
		parseTreeNodes;
	// Are we rendering to HTML?
	if(this.renderOutput === "text/html") {
		// If so we'll return the parsed macro
		var parser = this.wiki.parseText(this.parseType,text,
							{parseAsInline: !this.parseTreeNode.isBlock});
		parseTreeNodes = parser ? parser.tree : [];
	} else {
		// Otherwise, we'll render the text
		var plainText = this.wiki.renderText("text/plain",this.parseType,text,{parentWidget: this});
		parseTreeNodes = [{type: "text", text: plainText}];
	}
	// Construct the child widgets
	this.makeChildWidgets(parseTreeNodes);
};

/*
Selectively refreshes the widget if needed. Returns true if the widget or any of its children needed re-rendering
*/
MacroCallWidget.prototype.refresh = function(changedTiddlers) {
	var changedAttributes = this.computeAttributes();
	if($tw.utils.count(changedAttributes) > 0) {
		// Rerender ourselves
		this.refreshSelf();
		return true;
	} 
	//else  
	if (this.getAttribute("$refresh")) {
		var params = this.params.slice(0);
		params.push({name: "changedTiddlers", value: changedTiddlers});
		if (this.getVariable(this.getAttribute("$refresh"),{params: params})) {
					// Rerender ourselves
			this.refreshSelf();
			return true;
		} 
	//else 
	}
	return this.refreshChildren(changedTiddlers);

};

exports.macrorefresh = MacroCallWidget;

})();