You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
116 lines
4.6 KiB
116 lines
4.6 KiB
/*
|
|
* Copyright (C) 1998-2019 by Northwoods Software Corporation. All Rights Reserved.
|
|
*/
|
|
|
|
import * as go from '../release/go';
|
|
|
|
/**
|
|
* This CommandHandler class uses localStorage as the repository for the clipboard,
|
|
* rather than an in-memory global variable.
|
|
* It requires that the {@link Diagram#model} be serializable and deserializable using {@link Model#toJson} and {@link Model.fromJson}.
|
|
*
|
|
* The {@link #copyToClipboard} and {@link #pasteFromClipboard} functions fall back to using the standard definitions
|
|
* if there are any errors calling `Storage.getItem` or `Storage.setItem`.
|
|
*
|
|
* Typical usage:
|
|
* ```js
|
|
* $(go.Diagram, "myDiagramDiv",
|
|
* {
|
|
* commandHandler: $(LocalStorageCommandHandler),
|
|
* ...
|
|
* }
|
|
* )
|
|
* ```
|
|
* or:
|
|
* ```js
|
|
* myDiagram.commandHandler = new LocalStorageCommandHandler();
|
|
* ```
|
|
*
|
|
* If you want to experiment with this extension, try the <a href="../../extensionsTS/LocalStorageCommandHandler.html">Local Storage Commands</a> sample.
|
|
* @category Extension
|
|
*/
|
|
export class LocalStorageCommandHandler extends go.CommandHandler {
|
|
private StorageKey: string = 'go._clipboard';
|
|
private FormatKey: string = 'go._clipboardFormat';
|
|
|
|
/**
|
|
* Makes a copy of the given collection of {@link Part}s
|
|
* and stores it as JSON in LocalStorage.
|
|
* @param {Iterable.<Part>} coll a collection of {@link Part}s.
|
|
*/
|
|
public copyToClipboard(coll: go.Iterable<go.Part>): void {
|
|
try {
|
|
if (coll === null) {
|
|
window.localStorage.setItem(this.StorageKey, '');
|
|
window.localStorage.setItem(this.FormatKey, '');
|
|
} else {
|
|
const clipdiag = new go.Diagram(); // create a temporary Diagram
|
|
// copy from this diagram to the temporary diagram some properties that affects copying:
|
|
clipdiag.isTreePathToChildren = this.diagram.isTreePathToChildren;
|
|
clipdiag.toolManager.draggingTool.dragsLink = this.diagram.toolManager.draggingTool.dragsLink;
|
|
// create a model like this one but with no data
|
|
clipdiag.model = this.diagram.model.copy();
|
|
// copy the given Parts into this temporary Diagram
|
|
this.diagram.copyParts(coll, clipdiag, false);
|
|
|
|
window.localStorage.setItem(this.StorageKey, clipdiag.model.toJson());
|
|
window.localStorage.setItem(this.FormatKey, clipdiag.model.dataFormat);
|
|
}
|
|
} catch (ex) {
|
|
// fallback implementation
|
|
super.copyToClipboard(coll);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* If LocalStorage holds JSON for a collection of {@link Part}s,
|
|
* and if the {@link Model#dataFormat} matches that stored in the clipboard,
|
|
* this makes a copy of the clipboard's parts and adds the copies to this {@link Diagram}.
|
|
* @return {Set.<Part>} a collection of newly pasted {@link Part}s
|
|
*/
|
|
public pasteFromClipboard(): go.Set<go.Part> {
|
|
const coll = new go.Set<go.Part>();
|
|
try {
|
|
const clipstr = window.localStorage.getItem(this.StorageKey);
|
|
const clipfrmt = window.localStorage.getItem(this.FormatKey);
|
|
if (clipstr === null || clipstr === '' || clipfrmt !== this.diagram.model.dataFormat) {
|
|
return coll;
|
|
} else {
|
|
const clipdiag = new go.Diagram(); // create a temporary Diagram
|
|
// recover the model from the clipboard rendering
|
|
clipdiag.model = go.Model.fromJson(clipstr);
|
|
// copy all the CLIPDIAG Parts into this Diagram
|
|
const allparts = new go.Set<go.Part>();
|
|
allparts.addAll(clipdiag.parts).addAll(clipdiag.nodes).addAll(clipdiag.links);
|
|
const copymap = this.diagram.copyParts(allparts, this.diagram, false);
|
|
// return a Set of the copied Parts
|
|
return new go.Set<go.Part>().addAll(copymap.iteratorValues);
|
|
}
|
|
} catch (ex) {
|
|
// fallback implementation
|
|
return super.pasteFromClipboard();
|
|
}
|
|
}
|
|
|
|
/**
|
|
* This predicate controls whether or not the user can invoke the {@link #pasteSelection} command.
|
|
*
|
|
* This works just like {@link CommandHandler#canPasteSelection}, but looks at LocalStorage instead of a static variable.
|
|
*/
|
|
public canPasteSelection(): boolean {
|
|
const diagram = this.diagram;
|
|
if (diagram.isReadOnly || diagram.isModelReadOnly) return false;
|
|
if (!diagram.allowInsert || !diagram.allowClipboard) return false;
|
|
try {
|
|
const clipstr = window.localStorage.getItem(this.StorageKey);
|
|
const clipfrmt = window.localStorage.getItem(this.FormatKey);
|
|
if (clipstr === null || clipstr === '') return false;
|
|
if (clipfrmt !== diagram.model.dataFormat) return false;
|
|
return true;
|
|
} catch (ex) {
|
|
// fallback implementation
|
|
return go.CommandHandler.prototype.canPasteSelection();
|
|
}
|
|
}
|
|
}
|