mirror of
https://github.com/google/blockly.git
synced 2026-01-28 11:10:10 +01:00
037eb59b89
* chore: add linting for tsdoc * chore: don't require types on return * chore: remove redundant fileoverview from ts * chore: change return to returns and add some newlines * chore: remove license tag * chore: don't require params/return docs * chore: remove spurious struct tags * Revert "chore: change return to returns and add some newlines" This reverts commitd6d8656a45. * chore: don't auto-add param names * chore: disable require-param bc it breaks on this * return to returns and add line breaks * chore: configure additional jsdoc rules * chore: run format * Revert "chore: remove license tag" This reverts commit173455588a. * chore: allow license tag format * chore: only require jsdoc on exported items * chore: add missing jsdoc or silence where needed * chore: run format * chore: lint fixes
118 lines
2.6 KiB
TypeScript
118 lines
2.6 KiB
TypeScript
/**
|
|
* @license
|
|
* Copyright 2019 Google LLC
|
|
* SPDX-License-Identifier: Apache-2.0
|
|
*/
|
|
|
|
/**
|
|
* The class representing a marker.
|
|
* Used primarily for keyboard navigation to show a marked location.
|
|
*
|
|
* @class
|
|
*/
|
|
import * as goog from '../../closure/goog/goog.js';
|
|
goog.declareModuleId('Blockly.Marker');
|
|
|
|
/* eslint-disable-next-line no-unused-vars */
|
|
import type {MarkerSvg} from '../renderers/common/marker_svg.js';
|
|
|
|
import type {ASTNode} from './ast_node.js';
|
|
|
|
|
|
/**
|
|
* Class for a marker.
|
|
* This is used in keyboard navigation to save a location in the Blockly AST.
|
|
*
|
|
* @alias Blockly.Marker
|
|
*/
|
|
export class Marker {
|
|
/** The colour of the marker. */
|
|
colour: string|null = null;
|
|
|
|
/** The current location of the marker. */
|
|
// AnyDuringMigration because: Type 'null' is not assignable to type
|
|
// 'ASTNode'.
|
|
private curNode_: ASTNode = null as AnyDuringMigration;
|
|
|
|
/**
|
|
* The object in charge of drawing the visual representation of the current
|
|
* node.
|
|
*/
|
|
// AnyDuringMigration because: Type 'null' is not assignable to type
|
|
// 'MarkerSvg'.
|
|
private drawer_: MarkerSvg = null as AnyDuringMigration;
|
|
|
|
/** The type of the marker. */
|
|
type = 'marker';
|
|
|
|
/** Constructs a new Marker instance. */
|
|
constructor() {}
|
|
|
|
/**
|
|
* Sets the object in charge of drawing the marker.
|
|
*
|
|
* @param drawer The object in charge of drawing the marker.
|
|
*/
|
|
setDrawer(drawer: MarkerSvg) {
|
|
this.drawer_ = drawer;
|
|
}
|
|
|
|
/**
|
|
* Get the current drawer for the marker.
|
|
*
|
|
* @returns The object in charge of drawing the marker.
|
|
*/
|
|
getDrawer(): MarkerSvg {
|
|
return this.drawer_;
|
|
}
|
|
|
|
/**
|
|
* Gets the current location of the marker.
|
|
*
|
|
* @returns The current field, connection, or block the marker is on.
|
|
*/
|
|
getCurNode(): ASTNode {
|
|
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 newNode The new location of the marker.
|
|
*/
|
|
setCurNode(newNode: ASTNode) {
|
|
const oldNode = this.curNode_;
|
|
this.curNode_ = newNode;
|
|
if (this.drawer_) {
|
|
this.drawer_.draw(oldNode, this.curNode_);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Redraw the current marker.
|
|
*
|
|
* @internal
|
|
*/
|
|
draw() {
|
|
if (this.drawer_) {
|
|
this.drawer_.draw(this.curNode_, this.curNode_);
|
|
}
|
|
}
|
|
|
|
/** Hide the marker SVG. */
|
|
hide() {
|
|
if (this.drawer_) {
|
|
this.drawer_.hide();
|
|
}
|
|
}
|
|
|
|
/** Dispose of this marker. */
|
|
dispose() {
|
|
if (this.getDrawer()) {
|
|
this.getDrawer().dispose();
|
|
}
|
|
}
|
|
}
|