mirror of
https://github.com/google/blockly.git
synced 2026-01-19 14:57:12 +01:00
75 lines
1.9 KiB
JavaScript
75 lines
1.9 KiB
JavaScript
/**
|
|
* @license
|
|
* Copyright 2020 Google LLC
|
|
* SPDX-License-Identifier: Apache-2.0
|
|
*/
|
|
|
|
/**
|
|
* @fileoverview The interface for a selectable toolbox item.
|
|
* @author aschmiedt@google.com (Abby Schmiedt)
|
|
*/
|
|
|
|
'use strict';
|
|
|
|
/**
|
|
* The interface for a selectable toolbox item.
|
|
* @namespace Blockly.ISelectableToolboxItem
|
|
*/
|
|
goog.module('Blockly.ISelectableToolboxItem');
|
|
|
|
/* eslint-disable-next-line no-unused-vars */
|
|
const IToolboxItem = goog.require('Blockly.IToolboxItem');
|
|
/* eslint-disable-next-line no-unused-vars */
|
|
const toolbox = goog.requireType('Blockly.utils.toolbox');
|
|
|
|
|
|
/**
|
|
* Interface for an item in the toolbox that can be selected.
|
|
* @extends {IToolboxItem}
|
|
* @interface
|
|
* @alias Blockly.ISelectableToolboxItem
|
|
*/
|
|
const ISelectableToolboxItem = function() {};
|
|
|
|
/**
|
|
* Gets the name of the toolbox item. Used for emitting events.
|
|
* @return {string} The name of the toolbox item.
|
|
* @public
|
|
*/
|
|
ISelectableToolboxItem.prototype.getName;
|
|
|
|
/**
|
|
* Gets the contents of the toolbox item. These are items that are meant to be
|
|
* displayed in the flyout.
|
|
* @return {!toolbox.FlyoutItemInfoArray|string} The definition
|
|
* of items to be displayed in the flyout.
|
|
* @public
|
|
*/
|
|
ISelectableToolboxItem.prototype.getContents;
|
|
|
|
/**
|
|
* Sets the current toolbox item as selected.
|
|
* @param {boolean} _isSelected True if this category is selected, false
|
|
* otherwise.
|
|
* @public
|
|
*/
|
|
ISelectableToolboxItem.prototype.setSelected;
|
|
|
|
/**
|
|
* Gets the HTML element that is clickable.
|
|
* The parent toolbox element receives clicks. The parent toolbox will add an ID
|
|
* to this element so it can pass the onClick event to the correct toolboxItem.
|
|
* @return {!Element} The HTML element that receives clicks.
|
|
* @public
|
|
*/
|
|
ISelectableToolboxItem.prototype.getClickTarget;
|
|
|
|
/**
|
|
* Handles when the toolbox item is clicked.
|
|
* @param {!Event} _e Click event to handle.
|
|
* @public
|
|
*/
|
|
ISelectableToolboxItem.prototype.onClick;
|
|
|
|
exports = ISelectableToolboxItem;
|