blockly > Bloquer

Bloquer le cours

Classe pour un bloc. Elle n'est normalement pas appelée directement, il est préférable d'utiliser workspace.newBlock().

Signature :

export declare class Block implements IASTNodeLocation 

Implémentation:IASTNodeLocation

Constructeurs

Constructeur Modificateurs Description
(constructeur)(workspace, prototypeName, opt_id) Construit une nouvelle instance de la classe Block.

Propriétés

Propriété Modificateurs Type Description
childBlocks_ protected cette[]
collapsed_ protected booléen
COLLAPSED_FIELD_NAME

static

readonly

chaîne ID indépendant de la langue attribué au champ réduit.
COLLAPSED_INPUT_NAME

static

readonly

chaîne ID neutre de la langue attribué à l'entrée réduite.
colour_ protected chaîne Couleur du bloc dans '#RRGGBB' .
Compose ? (p1: Bloquer) => vide (Facultatif) Fonction facultative qui reconfigure le bloc en fonction du contenu de la boîte de dialogue du mutateur.
contextMenu booléen
données chaîne | nul Données textuelles facultatives effectuant un aller-retour entre des blocs et du code XML. Aucun effet Peut être utilisé par des tiers pour les méta-informations.
décomposer ? (p1: Espace de travail) => Bloquer (Facultatif) Fonction facultative qui renseigne la boîte de dialogue du mutateur avec les composants de ce bloc.
détruire ? () => vide (Facultatif) Méthode facultative appelée lors de la suppression.
supprimer protected booléen Le bloc actuel est-il en cours de suppression ?
domToMutation? (p1: Élément) => vide (Facultatif) Méthode de désérialisation facultative permettant de définir comment désérialiser l'état de mutation à partir d'un fichier XML Cette valeur doit être associée à la définition de mutationToDom.
getDeveloperVariables? () => chaîne[] (Facultatif) Propriété facultative permettant de déclarer des variables de développeur. Renvoyez une liste de noms de variables à utiliser par les générateurs. Les variables de développeur ne sont jamais présentées à l'utilisateur, mais sont déclarées en tant que variables globales dans le code généré.
chapeau ? chaîne (Facultatif) Nom du type de chapeau.
helpUrl chaîne | Fonction | nul Chaîne pour l'aide au bloc, ou fonction qui renvoie une URL. Nul si aucune aide n'est requise.
icônes IIcon[]
id chaîne
init? () => vide (Facultatif) Méthode facultative appelée lors de l'initialisation.
inputList Entrée[]
inputsInline? booléen (Facultatif)
inputsInlineDefault? booléen (Facultatif)
isInFlyout booléen
isInMutator booléen
isInsertionMarker_ protected booléen "True" si ce volume est un repère d'insertion.
loadExtraState? (p1: indifférent) => vide (Facultatif) Méthode de sérialisation facultative permettant de définir comment désérialiser l'état supplémentaire du bloc (par exemple, l'état de mutation) à partir d'un élément compatible avec JSON. Cette valeur doit être associée à la définition de saveExtraState.
mutationToDom? (...p1: tous[]) => Élément (Facultatif) Méthode de sérialisation facultative permettant de définir comment sérialiser l'état de mutation en XML. Cette valeur doit être associée à la définition de domToMutation.
nextConnection Connexion | nul
onchange? ((p1: Extrait) => vide) | nul (Facultatif) Méthode de rappel facultative à utiliser chaque fois que l'espace de travail parent du bloc change. Elle n'est généralement appelée qu'à partir du constructeur, de la fonction d'initialisation du type de bloc ou d'une fonction d'initialisation d'extension.
outputConnection Connexion | nul
outputShape_ protected numéro | nul
parentBlock_ protected ce | nul
previousConnection Connexion | nul
rendu readonly booléen Ce blocage est-il un élément BlockSVG ?
RTL booléen
saveExtraState? (doFullSerialization?: boolean) => tout (Facultatif) Méthode de sérialisation facultative permettant de définir comment sérialiser l'état supplémentaire du bloc (par exemple, l'état de mutation) vers un état compatible avec JSON. Cette valeur doit être associée à la définition de loadExtraState.
styleName_ protected chaîne Nom du style de volume.
suppressPrefixSuffix boolean | nul Propriété facultative permettant d'empêcher l'ajout de STATEMENT_PREFIX et STATEMENT_SUFFIX au code généré.
info-bulle Tooltip.TipInfo
type chaîne
workspace Workspace

Méthodes

Méthode Modificateurs Description
addIcon(icon) Ajoute l'icône donnée au volume.
allInputsFilled(opt_shadowBlocksAreFilled) Vérifie de manière récursive si toutes les entrées d'instruction et de valeur sont remplies par des blocs. Vérifiez également tous les blocs d'instructions suivants dans cette pile.
appendDummyInput(name) Ajoute une ligne d'entrée factice.
appendEndRowInput(name) Ajoute une entrée qui termine la ligne.
appendInput(input)

Ajoute la ligne d'entrée donnée.

Permet d'ajouter des entrées personnalisées au bloc.

appendStatementInput(name) Ajoute une ligne d'entrée d'instruction.
appendValueInput(name) Ajoute une ligne de saisie de valeur.
bumpNeighbours() Accolez les blocs non connectés pour les rendre hors de l'alignement. Deux blocs qui ne sont pas réellement connectés ne doivent pas s'aligner par coïncidence à l'écran.
dispose(healStack) Mettez ce bloc au rebut.
disposeInternal() protected Il se débarrasse de ce bloc sans effectuer les opérations requises par le bloc supérieur. Par exemple, ne déclenche pas d'événements ou ne débranche pas le bloc, etc.
doInit_() protected Appelle la fonction init() et gère le déclenchement des événements associés, etc.
getChildren(ordered) Recherchez tous les blocs directement imbriqués dans celui-ci. Inclut les valeurs et les déclarations, ainsi que toute déclaration suivante. Exclut toute connexion sur un onglet de sortie ou toute instruction précédente. Les blocs peuvent éventuellement être triés par position. de haut en bas.
getColour() Obtenez la couleur d'un bloc.
getCommentText() Renvoie le commentaire sur ce bloc (ou la valeur "null" en l'absence de commentaire).
getDescendants(ordered) Recherchez tous les blocs qui sont directement ou indirectement imbriqués dans celui-ci. Inclut ce bloc dans la liste. Inclut les valeurs et les instructions, ainsi que les éventuelles instructions suivantes. Exclut toute connexion sur un onglet de sortie ou toute instruction précédente. Les blocs peuvent éventuellement être triés par position. de haut en bas.
getDisabledReasons() Obtenez un ensemble des raisons pour lesquelles le blocage est actuellement désactivé, le cas échéant. Si le bloc est activé, cet ensemble sera vide.
getField(name) Renvoie le champ nommé d'un bloc.
getFieldValue(name) Renvoie la valeur neutre de la langue du champ donné.
getHue() Obtenez la valeur de teinte HSV d'un bloc. Null si la teinte n'est pas définie.
getIcon(type)
getIcons()
getInheritedDisabled() Vérifiez si le blocage est désactivé ou non dû aux parents. L'établissement désactivé dans le bloc n'est pas pris en compte.
getInput(name) Récupère l'objet d'entrée nommé.
getInputsInline() Permet de déterminer si les entrées de valeur sont disposées horizontalement ou verticalement.
getInputTargetBlock(name) Récupère le bloc associé à l'entrée nommée.
getInputWithBlock(block) Renvoie l'entrée qui se connecte au bloc spécifié.
getNextBlock() Renvoie le bloc d'instructions suivant directement connecté à ce bloc.
getOutputShape() Permet d'obtenir la forme de sortie du bloc.
getParent() Renvoie le bloc parent ou la valeur null si ce bloc se trouve au niveau supérieur. Le bloc parent est soit le bloc connecté à la connexion précédente (pour un bloc d'instructions), soit le bloc connecté à la connexion de sortie (pour un bloc "value").
getPreviousBlock() Renvoie le bloc connecté à la connexion précédente.
getRelativeToSurfaceXY() Renvoyez les coordonnées de l'angle supérieur gauche de ce bloc par rapport à l'origine de la surface de dessin (0,0), en unités d'espace de travail.
getRootBlock() Affiche le bloc le plus haut dans l'arborescence de ce bloc. Cette valeur est renvoyée si ce bloc est au niveau supérieur.
getStyleName() Obtenez le nom du style de bloc.
getSurroundParent() Renvoie le bloc parent qui entoure le bloc actuel, ou la valeur "null" si ce bloc n'est pas entouré d'un bloc. Un bloc parent peut simplement être l'instruction précédente, tandis que le bloc environnant est une instruction if, une boucle "while", etc.
getTooltip() Affiche le texte de l'info-bulle pour ce bloc.
getVars() Renvoie toutes les variables référencées par ce bloc.
hasDisabledReason(reason) Détermine si le blocage est actuellement désactivé pour le motif indiqué.
hasIcon(type)
initModel() Appelez initModel sur tous les champs du bloc. Peut être appelé plusieurs fois. initModel ou initSvg doit être appelé après la création d'un bloc et avant la première interaction avec celui-ci. Les interactions incluent les actions d'interface utilisateur (par exemple, cliquer et faire glisser) et les événements déclenchés (par exemple, créer, supprimer et modifier).
isCollapsed() Permet de déterminer si le bloc est réduit ou non.
isDeletable() Indique si ce bloc peut être supprimé ou non.
isDisposed() Indique si ce bloc a été supprimé.
isDuplicatable() Détermine si le bloc peut être dupliqué ou non. Si vous dupliquez ce bloc et que les descendants placent ce bloc sur la capacité de l'espace de travail, ce bloc ne peut pas être dupliqué. Si vous dupliquez ce bloc et que les descendants placent n'importe quel type sur leur maxInstances, ce bloc n'est pas dupliqué.
isEnabled() Détermine si ce blocage est activé ou non. Un blocage est considéré comme activé s'il n'est pas désactivé pour une raison quelconque. Un blocage peut toujours être désactivé pour d'autres raisons, même si l'utilisateur tente de l'activer manuellement, par exemple lorsque le blocage se trouve à un emplacement incorrect.
isInsertionMarker() Déterminez si ce bloc est un bloc de repère d'insertion ou non.
isOwnDeletable() Indique si la propriété supprimable de ce bloc est vraie ou fausse.
isOwnEditable() Indique si la propriété modifiable de ce bloc est "true" ou "false".
isShadow() Vérifiez si ce bloc est un bloc fantôme ou non.
jsonInit(json) Initialisez ce bloc à l'aide d'une description JSON multiplate-forme et compatible avec l'internationalisation.
mixin(mixinObj, opt_disableCheck) Ajoutez des clé-valeurs de mixinObj à cet objet de bloc. Par défaut, cette méthode vérifie que les clés dans mixinObj n'écrasent pas les valeurs existantes dans le bloc, y compris les valeurs du prototype. Cela offre une certaine assurance contre les incompatibilités de mixin / extension avec les futures fonctionnalités de bloc. Vous pouvez désactiver cette vérification en transmettant "true" comme deuxième argument.
moveBy(dx, dy, reason) Déplacez un volume d'un décalage relatif.
moveInputBefore(name, refName) Déplacer une entrée nommée vers un autre emplacement de ce bloc.
moveNumberedInputBefore(inputIndex, refIndex) Déplacer une entrée numérotée vers un autre emplacement de ce bloc.
removeIcon(type) Supprime l'icône dont le type getType correspond au type iconType donné du bloc.
removeInput(name, opt_quiet) Supprimez une entrée de ce bloc.
renameVarById(oldId, newId) Notification indiquant qu'une variable est renommée. Si l'ID correspond à l'une des variables de ce bloc, renommez-la.
setCollapsed(collapsed) Indiquez si le volume doit être réduit ou non.
setColour(colour) Modifiez la couleur d'un volume.
setCommentText(text) Définissez le texte des commentaires de ce bloc.
setDeletable(deletable) Indiquez si ce bloc peut être supprimé ou non.
setDisabledReason(disabled, reason) Ajoutez ou supprimez un motif de désactivation du blocage. Si un blocage doit être désactivé pour une raison quelconque, le blocage lui-même sera considéré comme désactivé. Un blocage peut être désactivé simultanément pour plusieurs raisons indépendantes, par exemple lorsque l'utilisateur le désactive manuellement ou que le blocage n'est pas valide.
setEditable(editable) Indiquez si ce bloc peut être modifié ou non.
setEnabled(enabled)
setFieldValue(newValue, name) Définit la valeur du champ donné pour ce bloc.
setHelpUrl(url) Définissez l'URL de la page d'aide de ce bloc.
setInputsInline(newBoolean) Définissez si les entrées de valeur sont disposées horizontalement ou verticalement.
setMovable(movable) Indiquez si ce volume peut être déplacé ou non.
setMutator(_mutator) Attribuez à ce bloc une boîte de dialogue de mutateur.
setNextStatement(newBoolean, opt_check) Indiquez si un autre bloc peut s'enchaîner avec la partie inférieure de ce bloc.
setOnChange(onchangeFn) Définit une fonction de rappel à utiliser chaque fois que l'espace de travail parent du bloc change, remplaçant tout gestionnaire onchange antérieur. Elle n'est généralement appelée qu'à partir du constructeur, de la fonction d'initialisation du type de bloc ou d'une fonction d'initialisation d'extension.
setOutput(newBoolean, opt_check) Indiquez si ce bloc renvoie une valeur.
setOutputShape(outputShape) Définissez la forme de sortie du bloc.
setPreviousStatement(newBoolean, opt_check) Déterminez si ce bloc peut s'enchaîner avec la partie inférieure d'un autre volume.
setStyle(blockStyleName) Définissez les valeurs de style et de couleur d'un bloc.
setTooltip(newTip) Définit l'info-bulle pour ce bloc.
setWarningText(_text, _opt_id) Définissez le texte d'avertissement de ce blocage.
toDevString()

Cette méthode renvoie une chaîne décrivant ce bloc en termes de développement (nom et identifiant de type, en anglais uniquement).

Destiné à être utilisé dans les journaux de la console et les erreurs. Si vous avez besoin d'une chaîne qui utilise la langue maternelle de l'utilisateur (y compris le texte bloc, les valeurs de champ et les blocs enfants), utilisez [toString()].

toString(opt_maxLength, opt_emptyToken) Créez une représentation textuelle lisible par l'humain de ce bloc et de ses enfants.
unplug(opt_healStack) Débranchez ce support de son bloc supérieur. Si ce bloc est une instruction, éventuellement reconnectez le volume situé en dessous avec le volume du dessus.