mirror of
https://github.com/google/blockly.git
synced 2026-01-09 18:10:08 +01:00
90b3f75d82
Our files are up to a decade old, and have churned so much, that the initial author of the file no longer has much meaning. Furthermore, this will encourage developers to post to the developer group, rather than emailing Googlers (usually me) directly.
131 lines
2.7 KiB
JavaScript
131 lines
2.7 KiB
JavaScript
/**
|
|
* @license
|
|
* Copyright 2019 Google LLC
|
|
* SPDX-License-Identifier: Apache-2.0
|
|
*/
|
|
|
|
/**
|
|
* @fileoverview The class representing a marker.
|
|
* Used primarily for keyboard navigation to show a marked location.
|
|
*/
|
|
'use strict';
|
|
|
|
/**
|
|
* The class representing a marker.
|
|
* Used primarily for keyboard navigation to show a marked location.
|
|
* @class
|
|
*/
|
|
goog.module('Blockly.Marker');
|
|
|
|
/* eslint-disable-next-line no-unused-vars */
|
|
const MarkerSvg = goog.requireType('Blockly.blockRendering.MarkerSvg');
|
|
/* eslint-disable-next-line no-unused-vars */
|
|
const {ASTNode} = goog.requireType('Blockly.ASTNode');
|
|
|
|
|
|
/**
|
|
* Class for a marker.
|
|
* This is used in keyboard navigation to save a location in the Blockly AST.
|
|
* @constructor
|
|
* @alias Blockly.Marker
|
|
*/
|
|
const Marker = function() {
|
|
/**
|
|
* The colour of the marker.
|
|
* @type {?string}
|
|
*/
|
|
this.colour = null;
|
|
|
|
/**
|
|
* The current location of the marker.
|
|
* @type {ASTNode}
|
|
* @private
|
|
*/
|
|
this.curNode_ = null;
|
|
|
|
/**
|
|
* The object in charge of drawing the visual representation of the current
|
|
* node.
|
|
* @type {MarkerSvg}
|
|
* @private
|
|
*/
|
|
this.drawer_ = null;
|
|
|
|
/**
|
|
* The type of the marker.
|
|
* @type {string}
|
|
*/
|
|
this.type = 'marker';
|
|
};
|
|
|
|
/**
|
|
* Sets the object in charge of drawing the marker.
|
|
* @param {MarkerSvg} drawer The object in charge of
|
|
* drawing the marker.
|
|
*/
|
|
Marker.prototype.setDrawer = function(drawer) {
|
|
this.drawer_ = drawer;
|
|
};
|
|
|
|
/**
|
|
* Get the current drawer for the marker.
|
|
* @return {MarkerSvg} The object in charge of drawing
|
|
* the marker.
|
|
*/
|
|
Marker.prototype.getDrawer = function() {
|
|
return this.drawer_;
|
|
};
|
|
|
|
/**
|
|
* Gets the current location of the marker.
|
|
* @return {ASTNode} The current field, connection, or block the marker
|
|
* is on.
|
|
*/
|
|
Marker.prototype.getCurNode = function() {
|
|
return this.curNode_;
|
|
};
|
|
|
|
/**
|
|
* Set the location of the marker and call the update method.
|
|
* Setting isStack to true will only work if the newLocation is the top most
|
|
* output or previous connection on a stack.
|
|
* @param {ASTNode} newNode The new location of the marker.
|
|
*/
|
|
Marker.prototype.setCurNode = function(newNode) {
|
|
const oldNode = this.curNode_;
|
|
this.curNode_ = newNode;
|
|
if (this.drawer_) {
|
|
this.drawer_.draw(oldNode, this.curNode_);
|
|
}
|
|
};
|
|
|
|
/**
|
|
* Redraw the current marker.
|
|
* @package
|
|
*/
|
|
Marker.prototype.draw = function() {
|
|
if (this.drawer_) {
|
|
this.drawer_.draw(this.curNode_, this.curNode_);
|
|
}
|
|
};
|
|
|
|
/**
|
|
* Hide the marker SVG.
|
|
*/
|
|
Marker.prototype.hide = function() {
|
|
if (this.drawer_) {
|
|
this.drawer_.hide();
|
|
}
|
|
};
|
|
|
|
/**
|
|
* Dispose of this marker.
|
|
*/
|
|
Marker.prototype.dispose = function() {
|
|
if (this.getDrawer()) {
|
|
this.getDrawer().dispose();
|
|
}
|
|
};
|
|
|
|
exports.Marker = Marker;
|