Класс блока
Класс для одного блока. Обычно не вызывается напрямую, предпочтительнее использовать workspace.newBlock().
Подпись:
export declare class Block implements IASTNodeLocation
Реализует: IASTNodeLocation.
Конструкторы
Конструктор | Модификаторы | Описание |
---|---|---|
(конструктор) (рабочая область, имя прототипа, opt_id) | Создает новый экземпляр класса Block . |
Характеристики
Свойство | Модификаторы | Тип | Описание |
---|---|---|---|
childBlocks_ | protected | этот[] | |
рухнул_ | protected | логическое значение | |
COLLAPSED_FIELD_NAME | | нить | Независимый от языка идентификатор, присвоенный свернутому полю. |
COLLAPSED_INPUT_NAME | | нить | Независимый от языка идентификатор, присвоенный свернутому вводу. |
цвет_ | protected | нить | Цвет блока в формате #RRGGBB. |
сочинять? | (p1: Блокировать ) => пустота | (Необязательно) Дополнительная функция, которая перенастраивает блок на основе содержимого диалогового окна мутатора. | |
контекстное меню | логическое значение | ||
данные | строка | нулевой | Необязательные текстовые данные, которые передаются между блоками и XML. Не имеет никакого эффекта. Может использоваться третьими лицами для метаинформации. | |
разлагаться? | (p1: Рабочая область ) => Блокировать | (Необязательно) Дополнительная функция, которая заполняет диалог мутатора компонентами этого блока. | |
разрушать? | () => недействительно | (Необязательно) Необязательный метод, вызываемый во время удаления. | |
избавление | protected | логическое значение | Находится ли текущий блок в процессе удаления? |
domToMutation? | (p1: Элемент) => пустота | (Необязательно) Дополнительный метод десериализации, определяющий способ десериализации состояния мутации из XML. Это должно быть связано с mutationToDom . | |
getDeveloperVariables? | () => строка[] | (Необязательно) Необязательное свойство для объявления переменных разработчика. Возвращает список имен переменных для использования генераторами. Переменные разработчика никогда не отображаются пользователю, а объявляются как глобальные переменные в сгенерированном коде. | |
шапка? | нить | (Необязательно) Название типа шляпы. | |
URL-адрес справки | строка | Функция | нулевой | Строка для справки по блоку или функция, возвращающая URL-адрес. Нуль без помощи. | |
значки | IIконка [] | ||
идентификатор | нить | ||
в этом? | () => недействительно | (Необязательно) Необязательный метод, вызываемый во время инициализации. | |
входной список | Вход [] | ||
входыИнлайн? | логическое значение | (Необязательный) | |
inputsInlineDefault? | логическое значение | (Необязательный) | |
isInFlyout | логическое значение | ||
isInMutator | логическое значение | ||
isInsertionMarker_ | protected | логическое значение | Истинно, если этот блок является маркером вставки. |
загрузитьExtraState? | (p1: любой) => недействителен | (Необязательно) Дополнительный метод сериализации, определяющий, как десериализовать дополнительное состояние блока (например, состояние мутации) из чего-то совместимого с JSON. Это должно быть связано с определением saveExtraState . | |
мутацияToDom? | (...p1: любой[]) => Элемент | (Необязательно) Дополнительный метод сериализации, определяющий, как сериализовать состояние мутации в XML. Это должно быть связано с определением domToMutation . | |
следующее соединение | Подключение | нулевой | ||
по изменению? | ((p1: Аннотация ) => пустота) | нулевой | (Необязательно) Необязательный метод обратного вызова, который будет использоваться при изменении родительской рабочей области блока. Обычно это вызывается только из конструктора, функции инициализатора типа блока или функции инициализатора расширения. | |
выходное соединение | Подключение | нулевой | ||
выходная форма_ | protected | номер | нулевой | |
родительБлок_ | protected | это | нулевой | |
предыдущийСоединение | Подключение | нулевой | ||
оказанный | readonly | логическое значение | Является ли этот блок BlockSVG? |
РТЛ | логическое значение | ||
сохранитьExtraState? | (doFullSerialization?: логическое значение) => любой | (Необязательно) Дополнительный метод сериализации, определяющий, как сериализовать дополнительное состояние блока (например, состояние мутации) во что-то совместимое с JSON. Это должно быть связано с определением loadExtraState . | |
имя_стиля_ | protected | нить | Имя стиля блока. |
подавитьПрефиксСуффикс | логическое | нулевой | Необязательное свойство для подавления добавления STATEMENT_PREFIX и STATEMENT_SUFFIX в сгенерированный код. | |
подсказка | Tooltip.TipInfo | ||
тип | нить | ||
Рабочее пространство | Рабочая среда |
Методы
Метод | Модификаторы | Описание |
---|---|---|
addIcon(значок) | Добавляет указанный значок в блок. | |
allInputsFilled (opt_shadowBlocksAreFilled) | Рекурсивно проверяет, заполнены ли все входные операторы и значения блоками. Также проверяет все последующие блоки операторов в этом стеке. | |
appendDummyInput (имя) | Добавляет фиктивную входную строку. | |
AppendEndRowInput (имя) | Добавляет ввод, завершающий строку. | |
добавлениеInput (вход) | Добавляет данную входную строку. Позволяет добавлять к блоку пользовательские входные данные. | |
AppendStatementInput (имя) | Добавляет входную строку оператора. | |
AppendValueInput (имя) | Добавляет строку ввода значения. | |
ударСоседи() | Выталкивайте несвязанные блоки из выравнивания. Два блока, которые на самом деле не связаны, не должны случайно выстраиваться на экране. | |
удалить (исцелить стек) | Удалите этот блок. | |
располагатьВнутренний() | protected | Удаляет этот блок, не выполняя действий, требуемых верхним блоком. Например, не запускает события, не отключает блок и т. д. |
doInit_() | protected | Вызывает функцию init() и обрабатывает связанное с ней событие и т. д. |
getChildren (заказано) | Найдите все блоки, которые непосредственно вложены в этот. Включает входные значения и операторы, а также любой следующий оператор. Исключает любое соединение на вкладке вывода или любом предыдущем операторе. Блоки опционально сортируются по положению; сверху вниз. | |
getColor() | Получите цвет блока. | |
получитьКомментарийТекст() | Возвращает комментарий к этому блоку (или значение null, если комментария нет). | |
getDescendants (заказано) | Найдите все блоки, которые прямо или косвенно вложены в этот. Включает этот блок в список. Включает входные значения и операторы, а также любые последующие операторы. Исключает любое соединение на вкладке вывода или любые предыдущие операторы. Блоки опционально сортируются по положению; сверху вниз. | |
getDisabledReasons() | Получите набор причин, по которым блокировка в настоящее время отключена, если таковая имеется. Если блок включен, этот набор будет пустым. | |
getField (имя) | Возвращает именованное поле из блока. | |
getFieldValue (имя) | Возвращает независимое от языка значение данного поля. | |
getHue() | Получите значение оттенка HSV блока. Нуль, если оттенок не установлен. | |
getIcon (тип) | ||
getIcons() | ||
getInheritedDisabled() | Узнайте, отключена ли блокировка или нет по вине родителей. Собственное отключенное свойство блока не учитывается. | |
getInput (имя) | Извлекает именованный входной объект. | |
getInputsInline() | Узнайте, расположены ли входные значения по горизонтали или по вертикали. | |
getInputTargetBlock (имя) | Извлекает блок, прикрепленный к именованному входу. | |
getInputWithBlock (блок) | Возвратите вход, который соединяется с указанным блоком. | |
getNextBlock() | Верните следующий блок операторов, напрямую связанный с этим блоком. | |
getOutputShape() | Получите выходную форму блока. | |
getParent() | Верните родительский блок или ноль, если этот блок находится на верхнем уровне. Родительский блок — это либо блок, подключенный к предыдущему соединению (для блока операторов), либо блок, подключенный к выходному соединению (для блока значений). | |
получитьПредыдущийБлок() | Возвращает блок, подключенный к предыдущему соединению. | |
getRelativeToSurfaceXY() | Возвращает координаты верхнего левого угла этого блока относительно начала координат поверхности рисования (0,0) в единицах рабочей области. | |
getRootBlock() | Возвращает самый верхний блок в дереве этого блока. Это вернется само, если этот блок находится на верхнем уровне. | |
getStyleName() | Получите имя стиля блока. | |
getSurroundParent() | Возвращает родительский блок, окружающий текущий блок, или значение null, если у этого блока нет окружающего блока. Родительский блок может быть просто предыдущим оператором, тогда как окружающий блок — это оператор if, цикл while и т. д. | |
getTooltip() | Возвращает текст всплывающей подсказки для этого блока. | |
getVars() | Верните все переменные, на которые ссылается этот блок. | |
hasDisabledReason (причина) | Узнайте, отключен ли блок в данный момент по указанной причине. | |
имеетЗначок(тип) | ||
initModel() | Вызовите initModel для всех полей блока. Может быть вызван более одного раза. Либо initModel, либо initSvg необходимо вызывать после создания блока и перед первым взаимодействием с ним. Взаимодействия включают действия пользовательского интерфейса (например, нажатие и перетаскивание) и события запуска (например, создание, удаление и изменение). | |
isCollapsed() | Узнайте, свернут блок или нет. | |
isDeletable() | Узнайте, можно ли удалить этот блок или нет. | |
isDispose() | Возвращает, если этот блок был удален/удален. | |
isDuplicatable() | Узнайте, дублируется ли блок или нет. Если при дублировании этого блока и потомки этот блок будет превышать емкость рабочей области, этот блок не будет дублироваться. Если при дублировании этого блока потомки будут помещать любой тип поверх своих maxInstances, этот блок не будет дублироваться. | |
включен() | Узнайте, включен этот блок или нет. Блок считается включенным, если нет причин, по которым он может быть отключен. Блок может быть отключен по другим причинам, даже если пользователь попытается включить его вручную, например, когда блок находится в неправильном месте. | |
isInsertionMarker() | Узнайте, является ли этот блок блоком маркера вставки или нет. | |
isOwnDeletable() | Возвращает значение true или false собственного удаляемого свойства этого блока. | |
isOwnEditable() | Возвращает значение true или false собственного редактируемого свойства этого блока. | |
isShadow() | Узнайте, является ли этот блок теневым блоком или нет. | |
jsonInit(JSON) | Инициализируйте этот блок, используя кроссплатформенное, удобное для интернационализации описание JSON. | |
миксин (mixinObj, opt_disableCheck) | Добавьте ключ/значения из mixinObj в этот объект блока. По умолчанию этот метод проверяет, что ключи в mixinObj не перезаписывают существующие значения в блоке, включая значения прототипа. Это обеспечивает некоторую страховку от несовместимости миксинов/расширений с будущими функциями блока. Эту проверку можно отключить, передав true в качестве второго аргумента. | |
moveBy(dx, dy, причина) | Переместите блок на относительное смещение. | |
moveInputBefore (имя, refName) | Переместите именованный вход в другое место этого блока. | |
moveNumberedInputBefore (inputIndex, refIndex) | Переместите пронумерованный ввод в другое место этого блока. | |
удалитьIcon (тип) | Удаляет из блока значок, getType которого соответствует заданному типу iconType. | |
RemoveInput (имя, opt_quiet) | Удалите вход из этого блока. | |
renameVarById (oldId, newId) | Уведомление о переименовании переменной. Если идентификатор соответствует одной из переменных этого блока, переименуйте ее. | |
setCollapsed(свернут) | Установите, свернут ли блок или нет. | |
setColor(цвет) | Изменение цвета блока. | |
setCommentText(текст) | Установите текст комментария этого блока. | |
setDeletable (удаляемый) | Установите, можно ли удалить этот блок или нет. | |
setDisabledReason (отключено, причина) | Добавьте или удалите причину, по которой блокировка может быть отключена. Если у блока есть основания для отключения, то отключенным будет считаться сам блок. Блок может быть отключен одновременно по нескольким независимым причинам, например, когда пользователь отключает его вручную или блок недействителен. | |
setEditable (редактируемый) | Установите, доступен ли этот блок для редактирования или нет. | |
setEnabled (включено) | ||
setFieldValue (новое значение, имя) | Устанавливает значение данного поля для этого блока. | |
setHelpUrl (url) | Установите URL-адрес страницы справки этого блока. | |
setInputsInline (новое логическое значение) | Установите, будут ли вводы значений расположены горизонтально или вертикально. | |
setMovable (подвижный) | Установите, является ли этот блок подвижным или нет. | |
setMutator(_mutator) | Дайте этому блоку диалоговое окно мутатора. | |
setNextStatement (newBoolean, opt_check) | Установите, может ли другой блок цепляться за нижнюю часть этого блока. | |
setOnChange(onchangeFn) | Устанавливает функцию обратного вызова, которая будет использоваться при каждом изменении родительской рабочей области блока, заменяя любой предыдущий обработчик onchange. Обычно это вызывается только из конструктора, функции инициализатора типа блока или функции инициализатора расширения. | |
setOutput (newBoolean, opt_check) | Установите, возвращает ли этот блок значение. | |
setOutputShape (выходная форма) | Установите выходную форму блока. | |
setPreviousStatement (newBoolean, opt_check) | Установите, может ли этот блок цепляться за нижнюю часть другого блока. | |
setStyle (имя стиля блока) | Установите стиль и значения цвета блока. | |
setTooltip(новая подсказка) | Устанавливает всплывающую подсказку для этого блока. | |
setWarningText(_text, _opt_id) | Установите текст предупреждения для этого блока. | |
toDevString() | Этот метод возвращает строку, описывающую этот блок в терминах разработчика (имя типа и идентификатор; только на английском языке). Предназначен для использования в журналах консоли и ошибках. Если вам нужна строка, использующая родной язык пользователя (включая текст блока, значения полей и дочерние блоки), используйте [toString()] . | |
toString (opt_maxLength, opt_emptyToken) | Создайте удобочитаемое текстовое представление этого блока и всех дочерних элементов. | |
отключить (opt_healStack) | Отсоедините этот блок от вышестоящего блока. Если этот блок является оператором, при необходимости повторно соедините блок внизу с блоком сверху. |