mirrors/TiddlyWiki5
1
0
Fork 0
mirror of https://github.com/Jermolene/TiddlyWiki5 synced 2024-12-27 02:20:28 +00:00
Code Issues Releases Wiki Activity
ed35d91be6
TiddlyWiki5/core/modules/widgets/link.js

204 lines
7.3 KiB
JavaScript
Raw Normal View History

Introduce refactored wiki parser and renderer This is a half-way through a big refactoring of the parsing and rendering infrastructure. The main change is to separate the parse and render trees, which makes the code a lot cleaner. The new parser isn't yet functional enough to replace the existing parser so for the moment you have to manually invoke it with `$tw.testNewParser()` in your browser console. I really ought to use branches for this kind of thing...
2012-12-13 21:34:31 +00:00
/*\
Update titles of certain widgets that were misspelled
2013-05-31 12:23:25 +00:00
title: $:/core/modules/widgets/link.js
Introduce refactored wiki parser and renderer This is a half-way through a big refactoring of the parsing and rendering infrastructure. The main change is to separate the parse and render trees, which makes the code a lot cleaner. The new parser isn't yet functional enough to replace the existing parser so for the moment you have to manually invoke it with `$tw.testNewParser()` in your browser console. I really ought to use branches for this kind of thing...
2012-12-13 21:34:31 +00:00
type: application/javascript
module-type: widget
Implements the link widget.
\*/
(function(){
/*jslint node: true, browser: true */
/*global $tw: false */
"use strict";
var isLinkExternal = function(to) {
var externalRegExp = /(?:file|http|https|mailto|ftp|irc|news|data):[^\s'"]+(?:\/|\b)/i;
return externalRegExp.test(to);
};
Refactored widgets not to use a base class
2013-01-01 17:51:02 +00:00
var LinkWidget = function(renderer) {
Introduce refactored wiki parser and renderer This is a half-way through a big refactoring of the parsing and rendering infrastructure. The main change is to separate the parse and render trees, which makes the code a lot cleaner. The new parser isn't yet functional enough to replace the existing parser so for the moment you have to manually invoke it with `$tw.testNewParser()` in your browser console. I really ought to use branches for this kind of thing...
2012-12-13 21:34:31 +00:00
// Save state
this.renderer = renderer;
// Generate child nodes
Refactored widget renderers to be hosted within HTML element renderers This arrangement takes better advantage of the similarities between the now deleted widget renderer and the element renderer. It also obviates the need for wrapper elements around every widget.
2013-01-03 16:27:55 +00:00
this.generate();
Introduce refactored wiki parser and renderer This is a half-way through a big refactoring of the parsing and rendering infrastructure. The main change is to separate the parse and render trees, which makes the code a lot cleaner. The new parser isn't yet functional enough to replace the existing parser so for the moment you have to manually invoke it with `$tw.testNewParser()` in your browser console. I really ought to use branches for this kind of thing...
2012-12-13 21:34:31 +00:00
};
Refactored widget renderers to be hosted within HTML element renderers This arrangement takes better advantage of the similarities between the now deleted widget renderer and the element renderer. It also obviates the need for wrapper elements around every widget.
2013-01-03 16:27:55 +00:00
LinkWidget.prototype.generate = function() {
Introduce refactored wiki parser and renderer This is a half-way through a big refactoring of the parsing and rendering infrastructure. The main change is to separate the parse and render trees, which makes the code a lot cleaner. The new parser isn't yet functional enough to replace the existing parser so for the moment you have to manually invoke it with `$tw.testNewParser()` in your browser console. I really ought to use branches for this kind of thing...
2012-12-13 21:34:31 +00:00
// Get the parameters from the attributes
Update link widget to use current tiddler as default target
2013-06-09 18:24:45 +00:00
this.to = this.renderer.getAttribute("to",this.renderer.tiddlerTitle);
Introduce refactored wiki parser and renderer This is a half-way through a big refactoring of the parsing and rendering infrastructure. The main change is to separate the parse and render trees, which makes the code a lot cleaner. The new parser isn't yet functional enough to replace the existing parser so for the moment you have to manually invoke it with `$tw.testNewParser()` in your browser console. I really ought to use branches for this kind of thing...
2012-12-13 21:34:31 +00:00
this.hover = this.renderer.getAttribute("hover");
Restore `qualifyHoverTitles` attribute to link widget
2013-03-05 11:55:25 +00:00
this.qualifyHoverTitles = this.renderer.getAttribute("qualifyHoverTitles");
// Qualify the hover tiddler title if needed
if(this.qualifyHoverTitles) {
Refactor rendertree to simplify context handling Get rid of the separate renderContext stack and instead have a parent pointer on renderer nodes. This lets us walk back up the render tree to resolve context references
2013-05-15 16:32:17 +00:00
this.hover = this.hover + "-" + this.renderer.renderTree.getContextScopeId(this.renderer.parentRenderer);
Restore `qualifyHoverTitles` attribute to link widget
2013-03-05 11:55:25 +00:00
}
Introduce refactored wiki parser and renderer This is a half-way through a big refactoring of the parsing and rendering infrastructure. The main change is to separate the parse and render trees, which makes the code a lot cleaner. The new parser isn't yet functional enough to replace the existing parser so for the moment you have to manually invoke it with `$tw.testNewParser()` in your browser console. I really ought to use branches for this kind of thing...
2012-12-13 21:34:31 +00:00
// Determine the default link characteristics
this.isExternal = isLinkExternal(this.to);
if(!this.isExternal) {
this.isMissing = !this.renderer.renderTree.wiki.tiddlerExists(this.to);
Add support for filtering shadow tiddlers
2013-04-03 13:29:12 +00:00
this.isShadow = this.renderer.renderTree.wiki.isShadowTiddler(this.to);
Introduce refactored wiki parser and renderer This is a half-way through a big refactoring of the parsing and rendering infrastructure. The main change is to separate the parse and render trees, which makes the code a lot cleaner. The new parser isn't yet functional enough to replace the existing parser so for the moment you have to manually invoke it with `$tw.testNewParser()` in your browser console. I really ought to use branches for this kind of thing...
2012-12-13 21:34:31 +00:00
}
// Compose the link
var classes = ["tw-tiddlylink"]
if(this.isExternal) {
$tw.utils.pushTop(classes,"tw-tiddlylink-external");
} else {
$tw.utils.pushTop(classes,"tw-tiddlylink-internal");
Add support for filtering shadow tiddlers
2013-04-03 13:29:12 +00:00
if(this.isShadow) {
$tw.utils.pushTop(classes,"tw-tiddlylink-shadow");
}
if(this.isMissing && !this.isShadow) {
Introduce refactored wiki parser and renderer This is a half-way through a big refactoring of the parsing and rendering infrastructure. The main change is to separate the parse and render trees, which makes the code a lot cleaner. The new parser isn't yet functional enough to replace the existing parser so for the moment you have to manually invoke it with `$tw.testNewParser()` in your browser console. I really ought to use branches for this kind of thing...
2012-12-13 21:34:31 +00:00
$tw.utils.pushTop(classes,"tw-tiddlylink-missing");
} else {
Add support for filtering shadow tiddlers
2013-04-03 13:29:12 +00:00
if(!this.isMissing) {
$tw.utils.pushTop(classes,"tw-tiddlylink-resolves");
}
Introduce refactored wiki parser and renderer This is a half-way through a big refactoring of the parsing and rendering infrastructure. The main change is to separate the parse and render trees, which makes the code a lot cleaner. The new parser isn't yet functional enough to replace the existing parser so for the moment you have to manually invoke it with `$tw.testNewParser()` in your browser console. I really ought to use branches for this kind of thing...
2012-12-13 21:34:31 +00:00
}
}
Added basic support for drag and drop of tiddlers Links are now draggable. Dragging outside the browser will drop the wiki text of the tiddler. Dragging to another TW5 browser window will drop the entire tiddler, including fields.
2013-04-08 17:47:46 +00:00
var events = [
{name: "click", handlerObject: this, handlerMethod: "handleClickEvent"},
{name: "dragstart", handlerObject: this, handlerMethod: "handleDragStartEvent"},
{name: "dragend", handlerObject: this, handlerMethod: "handleDragEndEvent"}
];
Introduce refactored wiki parser and renderer This is a half-way through a big refactoring of the parsing and rendering infrastructure. The main change is to separate the parse and render trees, which makes the code a lot cleaner. The new parser isn't yet functional enough to replace the existing parser so for the moment you have to manually invoke it with `$tw.testNewParser()` in your browser console. I really ought to use branches for this kind of thing...
2012-12-13 21:34:31 +00:00
if(this.hover) {
events.push({name: "mouseover", handlerObject: this, handlerMethod: "handleMouseOverOrOutEvent"});
events.push({name: "mouseout", handlerObject: this, handlerMethod: "handleMouseOverOrOutEvent"});
}
Quick fix to allow wikilinks to be disabled And using it to disable wikilinks in the readmes
2013-03-01 18:04:53 +00:00
// Get the value of the tw-wikilinks configuration macro
Refactor rendertree to simplify context handling Get rid of the separate renderContext stack and instead have a parent pointer on renderer nodes. This lets us walk back up the render tree to resolve context references
2013-05-15 16:32:17 +00:00
var wikiLinksMacro = this.renderer.renderTree.findMacroDefinition(this.renderer.parentRenderer,"tw-wikilinks"),
Quick fix to allow wikilinks to be disabled And using it to disable wikilinks in the readmes
2013-03-01 18:04:53 +00:00
useWikiLinks = wikiLinksMacro ? !(wikiLinksMacro.text.trim() === "no") : true;
Refactored widget renderers to be hosted within HTML element renderers This arrangement takes better advantage of the similarities between the now deleted widget renderer and the element renderer. It also obviates the need for wrapper elements around every widget.
2013-01-03 16:27:55 +00:00
// Set up the element
Quick fix to allow wikilinks to be disabled And using it to disable wikilinks in the readmes
2013-03-01 18:04:53 +00:00
if(useWikiLinks) {
this.tag = "a";
this.attributes = {
"class": classes.join(" ")
};
Allow templating with the link widget And add some documentation
2013-03-04 11:13:10 +00:00
if(this.isExternal) {
this.attributes.href = this.to;
} else {
Refactor rendertree to simplify context handling Get rid of the separate renderContext stack and instead have a parent pointer on renderer nodes. This lets us walk back up the render tree to resolve context references
2013-05-15 16:32:17 +00:00
var wikiLinkTemplateMacro = this.renderer.renderTree.findMacroDefinition(this.renderer.parentRenderer,"tw-wikilink-template"),
Always default to a href='#title' format for tiddler links The link format will be overridden when we're creating links within static HTML representations
2013-06-27 08:03:59 +00:00
wikiLinkTemplate = wikiLinkTemplateMacro ? wikiLinkTemplateMacro.text.trim() : "#$uri_encoded$";
Fix for the link macro to work around iPhone annoyance This prevents Mobile Safari from sliding the address bar into view whenever a tiddler link is clicked
2013-04-29 15:03:35 +00:00
this.wikiLinkText = wikiLinkTemplate.replace("$uri_encoded$",encodeURIComponent(this.to));
this.wikiLinkText = this.wikiLinkText.replace("$uri_doubleencoded$",encodeURIComponent(encodeURIComponent(this.to)));
this.attributes.href = this.wikiLinkText;
Allow templating with the link widget And add some documentation
2013-03-04 11:13:10 +00:00
}
Added basic support for drag and drop of tiddlers Links are now draggable. Dragging outside the browser will drop the wiki text of the tiddler. Dragging to another TW5 browser window will drop the entire tiddler, including fields.
2013-04-08 17:47:46 +00:00
this.events = events;
Quick fix to allow wikilinks to be disabled And using it to disable wikilinks in the readmes
2013-03-01 18:04:53 +00:00
} else {
this.tag = "span";
}
Refactor rendertree to simplify context handling Get rid of the separate renderContext stack and instead have a parent pointer on renderer nodes. This lets us walk back up the render tree to resolve context references
2013-05-15 16:32:17 +00:00
this.children = this.renderer.renderTree.createRenderers(this.renderer,this.renderer.parseTreeNode.children);
Introduce refactored wiki parser and renderer This is a half-way through a big refactoring of the parsing and rendering infrastructure. The main change is to separate the parse and render trees, which makes the code a lot cleaner. The new parser isn't yet functional enough to replace the existing parser so for the moment you have to manually invoke it with `$tw.testNewParser()` in your browser console. I really ought to use branches for this kind of thing...
2012-12-13 21:34:31 +00:00
};
Refactored widgets not to use a base class
2013-01-01 17:51:02 +00:00
LinkWidget.prototype.handleClickEvent = function(event) {
Introduce refactored wiki parser and renderer This is a half-way through a big refactoring of the parsing and rendering infrastructure. The main change is to separate the parse and render trees, which makes the code a lot cleaner. The new parser isn't yet functional enough to replace the existing parser so for the moment you have to manually invoke it with `$tw.testNewParser()` in your browser console. I really ought to use branches for this kind of thing...
2012-12-13 21:34:31 +00:00
if(isLinkExternal(this.to)) {
event.target.setAttribute("target","_blank");
return true;
} else {
Unpack the object returned by getBoundingClientRect() Embedding the return object directly doesn't survive the object being passed as an event parameter. Fixes #114
2013-07-25 15:58:42 +00:00
var bounds = this.renderer.domNode.getBoundingClientRect();
Introduce refactored wiki parser and renderer This is a half-way through a big refactoring of the parsing and rendering infrastructure. The main change is to separate the parse and render trees, which makes the code a lot cleaner. The new parser isn't yet functional enough to replace the existing parser so for the moment you have to manually invoke it with `$tw.testNewParser()` in your browser console. I really ought to use branches for this kind of thing...
2012-12-13 21:34:31 +00:00
$tw.utils.dispatchCustomEvent(event.target,"tw-navigate",{
navigateTo: this.to,
navigateFromNode: this,
Unpack the object returned by getBoundingClientRect() Embedding the return object directly doesn't survive the object being passed as an event parameter. Fixes #114
2013-07-25 15:58:42 +00:00
navigateFromClientRect: {
top: bounds.top,
left: bounds.left,
width: bounds.width,
right: bounds.right,
bottom: bounds.bottom,
height: bounds.height
}
Introduce refactored wiki parser and renderer This is a half-way through a big refactoring of the parsing and rendering infrastructure. The main change is to separate the parse and render trees, which makes the code a lot cleaner. The new parser isn't yet functional enough to replace the existing parser so for the moment you have to manually invoke it with `$tw.testNewParser()` in your browser console. I really ought to use branches for this kind of thing...
2012-12-13 21:34:31 +00:00
});
event.preventDefault();
Fix for the link macro to work around iPhone annoyance This prevents Mobile Safari from sliding the address bar into view whenever a tiddler link is clicked
2013-04-29 15:03:35 +00:00
event.stopPropagation();
Introduce refactored wiki parser and renderer This is a half-way through a big refactoring of the parsing and rendering infrastructure. The main change is to separate the parse and render trees, which makes the code a lot cleaner. The new parser isn't yet functional enough to replace the existing parser so for the moment you have to manually invoke it with `$tw.testNewParser()` in your browser console. I really ought to use branches for this kind of thing...
2012-12-13 21:34:31 +00:00
return false;
}
};
Refactored widgets not to use a base class
2013-01-01 17:51:02 +00:00
LinkWidget.prototype.handleMouseOverOrOutEvent = function(event) {
Introduce refactored wiki parser and renderer This is a half-way through a big refactoring of the parsing and rendering infrastructure. The main change is to separate the parse and render trees, which makes the code a lot cleaner. The new parser isn't yet functional enough to replace the existing parser so for the moment you have to manually invoke it with `$tw.testNewParser()` in your browser console. I really ought to use branches for this kind of thing...
2012-12-13 21:34:31 +00:00
if(this.hover) {
$tw.popup.triggerPopup({
Refactored widget renderers to be hosted within HTML element renderers This arrangement takes better advantage of the similarities between the now deleted widget renderer and the element renderer. It also obviates the need for wrapper elements around every widget.
2013-01-03 16:27:55 +00:00
title: this.hover,
domNode: this.renderer.domNode,
Introduce refactored wiki parser and renderer This is a half-way through a big refactoring of the parsing and rendering infrastructure. The main change is to separate the parse and render trees, which makes the code a lot cleaner. The new parser isn't yet functional enough to replace the existing parser so for the moment you have to manually invoke it with `$tw.testNewParser()` in your browser console. I really ought to use branches for this kind of thing...
2012-12-13 21:34:31 +00:00
wiki: this.renderer.renderTree.wiki
});
}
event.preventDefault();
return false;
};
Added basic support for drag and drop of tiddlers Links are now draggable. Dragging outside the browser will drop the wiki text of the tiddler. Dragging to another TW5 browser window will drop the entire tiddler, including fields.
2013-04-08 17:47:46 +00:00
LinkWidget.prototype.handleDragStartEvent = function(event) {
if(this.to) {
// Set the dragging class on the element being dragged
$tw.utils.addClass(event.target,"tw-tiddlylink-dragging");
Fix problem with stray drag image showing Changes to the main layout CSS a few weeks ago meant that the drag image element was visible at the top left corner of the window. Astoundingly, the fix is to cover it with another div with the same background colour as the page….
2013-08-08 20:46:38 +00:00
// Create the drag image elements
Fix typo
2013-06-05 14:38:06 +00:00
this.dragImage = this.renderer.renderTree.document.createElement("div");
Added basic support for drag and drop of tiddlers Links are now draggable. Dragging outside the browser will drop the wiki text of the tiddler. Dragging to another TW5 browser window will drop the entire tiddler, including fields.
2013-04-08 17:47:46 +00:00
this.dragImage.className = "tw-tiddler-dragger";
Fix problem with stray drag image showing Changes to the main layout CSS a few weeks ago meant that the drag image element was visible at the top left corner of the window. Astoundingly, the fix is to cover it with another div with the same background colour as the page….
2013-08-08 20:46:38 +00:00
var inner = this.renderer.renderTree.document.createElement("div");
inner.className = "tw-tiddler-dragger-inner";
inner.appendChild(this.renderer.renderTree.document.createTextNode(this.to));
this.dragImage.appendChild(inner);
Fix typo
2013-06-05 14:38:06 +00:00
this.renderer.renderTree.document.body.appendChild(this.dragImage);
Fix problem with stray drag image showing Changes to the main layout CSS a few weeks ago meant that the drag image element was visible at the top left corner of the window. Astoundingly, the fix is to cover it with another div with the same background colour as the page….
2013-08-08 20:46:38 +00:00
// Astoundingly, we need to cover the dragger up: http://www.kryogenix.org/code/browser/custom-drag-image.html
var bounds = this.dragImage.firstChild.getBoundingClientRect(),
cover = this.renderer.renderTree.document.createElement("div");
cover.className = "tw-tiddler-dragger-cover";
cover.style.left = (bounds.left - 8) + "px";
cover.style.top = (bounds.top - 8) + "px";
cover.style.width = (bounds.width + 16) + "px";
cover.style.height = (bounds.height + 16) + "px";
this.dragImage.appendChild(cover);
Added basic support for drag and drop of tiddlers Links are now draggable. Dragging outside the browser will drop the wiki text of the tiddler. Dragging to another TW5 browser window will drop the entire tiddler, including fields.
2013-04-08 17:47:46 +00:00
// Set the data transfer properties
var dataTransfer = event.dataTransfer;
dataTransfer.effectAllowed = "copy";
Fix problem with stray drag image showing Changes to the main layout CSS a few weeks ago meant that the drag image element was visible at the top left corner of the window. Astoundingly, the fix is to cover it with another div with the same background colour as the page….
2013-08-08 20:46:38 +00:00
dataTransfer.setDragImage(this.dragImage.firstChild,-16,-16);
Added basic support for drag and drop of tiddlers Links are now draggable. Dragging outside the browser will drop the wiki text of the tiddler. Dragging to another TW5 browser window will drop the entire tiddler, including fields.
2013-04-08 17:47:46 +00:00
dataTransfer.clearData();
dataTransfer.setData("text/vnd.tiddler",this.renderer.renderTree.wiki.getTiddlerAsJson(this.to));
dataTransfer.setData("text/plain",this.renderer.renderTree.wiki.getTiddlerText(this.to,""));
event.stopPropagation();
} else {
event.preventDefault();
}
};
LinkWidget.prototype.handleDragEndEvent = function(event) {
// Remove the dragging class on the element being dragged
$tw.utils.removeClass(event.target,"tw-tiddlylink-dragging");
// Delete the drag image element
if(this.dragImage) {
this.dragImage.parentNode.removeChild(this.dragImage);
}
};
LinkWidget.prototype.postRenderInDom = function() {
// Add the draggable attribute to links (we don't include it in the static HTML representation)
if(this.renderer.domNode.tagName === "A") {
this.renderer.domNode.setAttribute("draggable",true);
}
};
Refactored widgets not to use a base class
2013-01-01 17:51:02 +00:00
LinkWidget.prototype.refreshInDom = function(changedAttributes,changedTiddlers) {
Introduce refactored wiki parser and renderer This is a half-way through a big refactoring of the parsing and rendering infrastructure. The main change is to separate the parse and render trees, which makes the code a lot cleaner. The new parser isn't yet functional enough to replace the existing parser so for the moment you have to manually invoke it with `$tw.testNewParser()` in your browser console. I really ought to use branches for this kind of thing...
2012-12-13 21:34:31 +00:00
// Set the class for missing tiddlers
Cleaning up the widget refresh mechanism
2012-12-14 19:31:37 +00:00
if(this.targetTitle && changedTiddlers[this.targetTitle]) {
Refactored widget renderers to be hosted within HTML element renderers This arrangement takes better advantage of the similarities between the now deleted widget renderer and the element renderer. It also obviates the need for wrapper elements around every widget.
2013-01-03 16:27:55 +00:00
$tw.utils.toggleClass(this.renderer.domNode,"tw-tiddler-missing",!this.renderer.renderTree.wiki.tiddlerExists(this.targetTitle));
Introduce refactored wiki parser and renderer This is a half-way through a big refactoring of the parsing and rendering infrastructure. The main change is to separate the parse and render trees, which makes the code a lot cleaner. The new parser isn't yet functional enough to replace the existing parser so for the moment you have to manually invoke it with `$tw.testNewParser()` in your browser console. I really ought to use branches for this kind of thing...
2012-12-13 21:34:31 +00:00
}
// Check if any of our attributes have changed, or if a tiddler we're interested in has changed
if(changedAttributes.to || changedAttributes.hover || (this.to && changedTiddlers[this.to]) || (this.hover && changedTiddlers[this.hover])) {
Refactored widget renderers to be hosted within HTML element renderers This arrangement takes better advantage of the similarities between the now deleted widget renderer and the element renderer. It also obviates the need for wrapper elements around every widget.
2013-01-03 16:27:55 +00:00
// Regenerate and rerender the widget and replace the existing DOM node
this.generate();
var oldDomNode = this.renderer.domNode,
newDomNode = this.renderer.renderInDom();
oldDomNode.parentNode.replaceChild(newDomNode,oldDomNode);
Introduce refactored wiki parser and renderer This is a half-way through a big refactoring of the parsing and rendering infrastructure. The main change is to separate the parse and render trees, which makes the code a lot cleaner. The new parser isn't yet functional enough to replace the existing parser so for the moment you have to manually invoke it with `$tw.testNewParser()` in your browser console. I really ought to use branches for this kind of thing...
2012-12-13 21:34:31 +00:00
} else {
// We don't need to refresh ourselves, so just refresh any child nodes
$tw.utils.each(this.children,function(node) {
if(node.refreshInDom) {
node.refreshInDom(changedTiddlers);
}
});
}
};
Refactored widgets not to use a base class
2013-01-01 17:51:02 +00:00
exports.link = LinkWidget;
Introduce refactored wiki parser and renderer This is a half-way through a big refactoring of the parsing and rendering infrastructure. The main change is to separate the parse and render trees, which makes the code a lot cleaner. The new parser isn't yet functional enough to replace the existing parser so for the moment you have to manually invoke it with `$tw.testNewParser()` in your browser console. I really ought to use branches for this kind of thing...
2012-12-13 21:34:31 +00:00
})();
Reference in New Issue Copy Permalink