Spaces:
Paused
Paused
File size: 4,137 Bytes
341f1e9 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 | /*
* Copyright (c) 2019 Convergence Labs, Inc.
*
* This file is part of the CodeMirror Collaborative Extensions, which is
* released under the terms of the MIT license. A copy of the MIT license
* is usually provided as part of this source code package in the LICENCE
* file. If it was not, please see <https://opensource.org/licenses/MIT>
*/
import {Position} from "codemirror";
import {IRemoteSelectionManagerOptions} from "./IRemoteSelectionManagerOptions";
import {RemoteSelection} from "./RemoteSelection";
import {Validation} from "./Validation";
/**
* The RemoteSelectionManager renders remote users selections into the
* editor using the editor's built-in TextMarker mechanism.
*/
export class RemoteSelectionManager {
/**
* A internal unique identifier for each selection.
*
* @internal
*/
private _nextClassId: number;
/**
* Tracks the current remote selections.
*
* @internal
*/
private readonly _remoteSelections: Map<string, RemoteSelection>;
/**
* The options configuring this instance.
*
* @internal
*/
private readonly _options: IRemoteSelectionManagerOptions;
/**
* Creates a new RemoteSelectionManager with the specified options.
*
* @param options
* Ths options that configure the RemoteSelectionManager.
*/
constructor(options: IRemoteSelectionManagerOptions) {
Validation.assertDefined(options, "options");
this._remoteSelections = new Map<string, RemoteSelection>();
this._options = options;
this._nextClassId = 0;
}
/**
* Adds a new remote selection with a unique id and the specified color.
*
* @param id
* The unique id of the selection.
* @param color
* The color to render the selection with.
*/
public addSelection(id: string, color: string): RemoteSelection {
const onDisposed = () => {
this.removeSelection(id);
};
const selection = new RemoteSelection(this._options.editor, id, this._nextClassId++, color, onDisposed);
this._remoteSelections.set(id, selection);
return selection;
}
/**
* Removes an existing remote selection from the editor.
*
* @param id
* The unique id of the selection.
*/
public removeSelection(id: string): void {
const remoteSelection = this._getSelection(id);
if (!remoteSelection.isDisposed()) {
remoteSelection.dispose();
}
}
/**
* Sets the selection using zero-based text indices.
*
* @param id
* The unique id of the selection.
* @param start
* The starting index of the selection.
* @param end
* The ending index of the selection.
*/
public setSelectionIndices(id: string, start: number, end: number): void {
const remoteSelection = this._getSelection(id);
remoteSelection.setIndices(start, end);
}
/**
* Sets the selection using the CodeMirror Editor's Position
* (line numbers and characters) location concept.
*
* @param id
* The unique id of the selection.
* @param start
* The starting position of the selection.
* @param end
* The ending position of the selection.
*/
public setSelectionPositions(id: string, start: Position, end: Position): void {
const remoteSelection = this._getSelection(id);
remoteSelection.setPositions(start, end);
}
/**
* Shows the specified selection, if it is currently hidden.
*
* @param id
* The unique id of the selection.
*/
public showSelection(id: string): void {
const remoteSelection = this._getSelection(id);
remoteSelection.show();
}
/**
* Hides the specified selection, if it is currently shown.
*
* @param id
* The unique id of the selection.
*/
public hideSelection(id: string): void {
const remoteSelection = this._getSelection(id);
remoteSelection.hide();
}
/**
* A helper method that gets a cursor by id, or throws an exception.
* @internal
*/
private _getSelection(id: string): RemoteSelection {
if (!this._remoteSelections.has(id)) {
throw new Error("No such selection: " + id);
}
return this._remoteSelections.get(id);
}
}
|