Classe di blocco
Corso per un blocco. Di solito non viene chiamato direttamente, è preferibile utilizzare workspace.newBlock().
Firma:
export declare class Block
Costruttori
Costruttore | Modificatori | Descrizione |
---|---|---|
(constructor)(workspace, prototypeName, opt_id) | Costruisce una nuova istanza della classe Block |
Proprietà
Proprietà | Modificatori | Tipo | Descrizione |
---|---|---|---|
childBlocks_ | protected |
this[] | |
collapsed_ | protected |
booleano | |
COLLAPSED_FIELD_NAME |
|
stringa | L'ID indipendente dalla lingua assegnato al campo compresso. |
COLLAPSED_INPUT_NAME |
|
stringa | L'ID indipendente dalla lingua assegnato all'input compresso. |
colour_ | protected |
stringa | Colore del blocco in formato "#RRGGBB". |
compose? | (rootBlock: Block) => void | (Facoltativo) Un metodo facoltativo che riconfigura il blocco in base ai contenuti della finestra di dialogo del modificatore. | |
contextMenu | booleano | ||
data | string | null | Dati di testo facoltativi che passano da blocchi a XML e viceversa. Non ha alcun effetto. Potrebbe essere utilizzato da terze parti per le meta informazioni. | |
decompose? | (workspace: Workspace) => Block | (Facoltativo) Una funzione facoltativa che compila il menu a comparsa del modificatore con blocchi che rappresentano la configurazione di questo blocco. | |
destroy? | () => void | (Facoltativo) Un metodo facoltativo chiamato durante lo smaltimento. | |
disposing | protected |
booleano | Il blocco corrente è in fase di smaltimento? |
domToMutation? | (p1: Element) => void | (Facoltativo) Un metodo facoltativo di deserializzazione per definire come deserializzare lo stato della mutazione dal XML. Questo deve essere associato alla definizione di mutationToDom . |
|
getDeveloperVariables? | () => string[] | (Facoltativo) Un metodo facoltativo per dichiarare le variabili dello sviluppatore, da utilizzare dai generatori. Le variabili sviluppatore non vengono mai mostrate all'utente, ma sono dichiarate come variabili globali nel codice generato. | |
cappello? | stringa | (Facoltativo) Nome del tipo di cappello. | |
helpUrl | string | (() => string) | null | Stringa per la guida al blocco o funzione che restituisce un URL. Valore nullo per nessuna assistenza. | |
icone | IIcon[] | ||
id | stringa | ||
init? | () => void | (Facoltativo) Un metodo facoltativo chiamato durante l'inizializzazione. | |
inputList | Input[] | ||
inputsInline? | booleano | (Facoltativo) | |
inputsInlineDefault? | booleano | (Facoltativo) | |
isInFlyout | booleano | ||
isInMutator | booleano | ||
isInsertionMarker_ | protected |
booleano | True se questo blocco è un indicatore di inserimento. |
loadExtraState? | (p1: any) => void | (Facoltativo) Un metodo di serializzazione facoltativo per definire come deserializzare lo stato extra del blocco (ad es. lo stato di mutazione) da un elemento compatibile con JSON. Questo deve essere associato alla definizione di saveExtraState . |
|
mutationToDom? | (...p1: any[]) => Element | (Facoltativo) Un metodo di serializzazione facoltativo per definire la modalità di serializzazione dello stato della mutazione in XML. Questo deve essere associato alla definizione di domToMutation . |
|
nextConnection | Connessione | null | ||
onchange? | ((p1: Abstract) => void) | null | (Facoltativo) Un metodo di callback facoltativo da utilizzare ogni volta che cambia lo spazio di lavoro principale del blocco. Di solito viene chiamato solo dal costruttore, dalla funzione di inizializzazione del tipo di blocco o da una funzione di inizializzazione dell'estensione. | |
outputConnection | Connessione | null | ||
outputShape_ | protected |
number | null | |
parentBlock_ | protected |
this | null | |
previousConnection | Connessione | null | ||
renderizzati | readonly |
booleano | Questo blocco è un BlockSVG? |
RTL | booleano | ||
saveExtraState? | (doFullSerialization?: boolean) => any | (Facoltativo) Un metodo di serializzazione facoltativo per definire come serializzare lo stato extra del blocco (ad es. lo stato di mutazione) in un formato compatibile con JSON. Questo deve essere associato alla definizione di loadExtraState . |
|
styleName_ | protected |
stringa | Nome dello stile del blocco. |
suppressPrefixSuffix | boolean | null | Una proprietà facoltativa per impedire l'aggiunta di STATEMENT_PREFIX e STATEMENT_SUFFIX al codice generato. | |
Descrizione comando | Tooltip.TipInfo | ||
type | stringa | ||
workspace | Workspace |
Metodi
Metodo | Modificatori | Descrizione |
---|---|---|
addIcon(icon) | Aggiunge l'icona specificata al blocco. | |
allInputsFilled(opt_shadowBlocksAreFilled) | Controlla in modo ricorsivo se tutti gli input di istruzioni e valori sono compilati con blocchi. Controlla anche tutti i blocchi di istruzioni successivi in questo stack. | |
appendDummyInput(name) | Collega una riga di input fittizia. | |
appendEndRowInput(name) | Collega un input che termina la riga. | |
appendInput(input) | Collega la riga di input specificata. Consente di aggiungere input personalizzati al blocco. |
|
appendStatementInput(name) | Aggiunge una riga di input dell'istruzione. | |
appendValueInput(name) | Collega una riga di input del valore. | |
bumpNeighbours() | Fai uscire dall'allineamento i blocchi scollegati. Due blocchi che non sono effettivamente collegati non devono essere allineati per caso sullo schermo. | |
dispose(healStack) | Sbarazzati di questo blocco. | |
disposeInternal() | protected |
Elimina questo blocco senza eseguire le operazioni richieste dal blocco superiore. Ad esempio, non attiva gli eventi, scollega il blocco e così via. |
doInit_() | protected |
Chiama la funzione init() e gestisce l'attivazione degli eventi associati e così via. |
getChildren(ordered) | Trova tutti i blocchi nidificati direttamente al suo interno. Sono inclusi gli input di valore e di istruzione, nonché eventuali istruzioni successive. Esclude qualsiasi connessione in una scheda di output o qualsiasi istruzione precedente. I blocchi possono essere ordinati in base alla posizione, dall'alto verso il basso. | |
getColour() | Recupera il colore di un blocco. | |
getCommentText() | Restituisce il commento su questo blocco (o null se non è presente alcun commento). | |
getDescendants(ordered) | Trova tutti i blocchi nidificati direttamente o indirettamente al suo interno. Include questo blocco nell'elenco. Sono inclusi gli input di valore e di istruzione, nonché eventuali istruzioni successive. Esclude qualsiasi connessione in una scheda di output o eventuali istruzioni precedenti. I blocchi possono essere ordinati in base alla posizione, dall'alto verso il basso. | |
getDisabledReasons() | Visualizza una serie di motivi per cui il blocco è attualmente disattivato, se presenti. Se il blocco è attivato, questo insieme sarà vuoto. | |
getField(name) | Restituisce il campo denominato da un blocco. | |
getFields() | Restituisce un generatore che fornisce tutti i campi del blocco. Un generatore che può essere utilizzato per eseguire l'iterazione dei campi nel blocco. |
|
getFieldValue(name) | Restituisce il valore indipendente dalla lingua del campo specificato. | |
getHue() | Recupera il valore di tonalità HSV di un blocco. Valore nullo se la tonalità non è impostata. | |
getIcon(type) | ||
getIcons() | ||
getInheritedDisabled() | Indica se il blocco è disattivato o meno a causa dei genitori. La proprietà disattivata del blocco non viene considerata. | |
getInput(name) | Recupera l'oggetto di input denominato. | |
getInputsInline() | Indica se gli input di valore sono disposti orizzontalmente o verticalmente. | |
getInputTargetBlock(name) | Recupera il blocco associato all'input denominato. | |
getInputWithBlock(block) | Restituisce l'input che si connette al blocco specificato. | |
getNextBlock() | Restituisce il blocco di istruzioni successivo collegato direttamente a questo blocco. | |
getOutputShape() | Recupera la forma di output del blocco. | |
getParent() | Restituisce il blocco principale o null se questo blocco è al livello superiore. Il blocco principale è il blocco collegato alla connessione precedente (per un blocco di istruzioni) o il blocco collegato alla connessione di output (per un blocco di valori). | |
getPreviousBlock() | Restituisce il blocco collegato al collegamento precedente. | |
getRelativeToSurfaceXY() | Restituisce le coordinate dell'angolo in alto a sinistra di questo blocco rispetto all'origine (0,0) della superficie di disegno, in unità di spazio di lavoro. | |
getRootBlock() | Restituisce il blocco più alto nell'albero di questo blocco. Verrà restituito se questo blocco è al livello superiore. | |
getStyleName() | Recupera il nome dello stile del blocco. | |
getSurroundParent() | Restituisce il blocco padre che circonda il blocco corrente o null se questo blocco non ha blocchi circostanti. Un blocco principale potrebbe essere semplicemente l'istruzione precedente, mentre il blocco circostante è un'istruzione if, un ciclo while e così via. | |
getTooltip() | Restituisce il testo della descrizione comando per questo blocco. | |
getVars() | Restituisce tutte le variabili a cui fa riferimento questo blocco. | |
hasDisabledReason(reason) | Indica se il blocco è attualmente disattivato per il motivo specificato. | |
hasIcon(type) | ||
initModel() | Chiama initModel su tutti i campi del blocco. Può essere chiamato più volte. initModel o initSvg deve essere chiamato dopo la creazione di un blocco e prima della prima interazione con il blocco. Le interazioni includono azioni dell'interfaccia utente (ad es. clic e trascinamenti) e l'attivazione di eventi (ad es. creazione, eliminazione e modifica). | |
isCollapsed() | Indica se il blocco è compresso o meno. | |
isDeletable() | Indica se questo blocco è eliminabile o meno. | |
isDisposed() | Restituisce se questo blocco è stato eliminato / rimosso. | |
isDuplicatable() | Indica se il blocco è duplicabile o meno. Se la duplicazione di questo blocco e dei relativi discendenti supererà la capacità dello spazio di lavoro, il blocco non potrà essere duplicato. Se la duplicazione di questo blocco e dei relativi discendenti comporta l'inserimento di qualsiasi tipo oltre il valore maxInstances, questo blocco non è duplicabile. | |
isEnabled() | Indica se questo blocco è attivo o meno. Un blocco è considerato abilitato se non ci sono motivi per cui dovrebbe essere disattivato. Un blocco potrebbe essere comunque disattivato per altri motivi anche se l'utente tenta di attivarlo manualmente, ad esempio quando il blocco si trova in una posizione non valida. | |
isInsertionMarker() | Indica se questo blocco è un blocco di indicatori di inserimento o meno. | |
isOwnDeletable() | Restituisce se la proprietà deletable di questo blocco è true o false. | |
isOwnEditable() | Restituisce se la proprietà modificabile di questo blocco è true o false. | |
isShadow() | Indica se questo blocco è un blocco shadow o meno. | |
jsonInit(json) | Inizializza questo blocco utilizzando una descrizione JSON multipiattaforma e adatta all'internazionalizzazione. | |
mixin(mixinObj, opt_disableCheck) | Aggiungi la chiave/i valori da mixinObj a questo oggetto blocco. Per impostazione predefinita, questo metodo verifica che le chiavi in mixinObj non sovrascrivano i valori esistenti nel blocco, inclusi i valori del prototipo. Ciò offre una certa protezione contro le incompatibilità di mixin / estensioni con le funzionalità future dei blocchi. Questo controllo può essere disattivato passando true come secondo argomento. | |
moveBy(dx, dy, reason) | Sposta un blocco di un offset relativo. | |
moveInputBefore(name, refName) | Sposta un input denominato in un'altra posizione in questo blocco. | |
moveNumberedInputBefore(inputIndex, refIndex) | Sposta un input numerato in un'altra posizione in questo blocco. | |
removeIcon(type) | Rimuove dal blocco l'icona il cui getType corrisponde al tipo specificato iconType. | |
removeInput(name, opt_quiet) | Rimuovi un input da questo blocco. | |
renameVarById(oldId, newId) | Notifica che una variabile viene rinominata. Se l'ID corrisponde a una delle variabili di questo blocco, rinominalo. | |
setCollapsed(collapsed) | Imposta se il blocco è compresso o meno. | |
setColour(colour) | Modificare il colore di un blocco. | |
setCommentText(text) | Imposta il testo del commento di questo blocco. | |
setDeletable(deletable) | Imposta se questo blocco è eliminabile o meno. | |
setDisabledReason(disabled, reason) | Aggiungi o rimuovi un motivo per cui il blocco potrebbe essere disattivato. Se un blocco ha motivi per essere disattivato, il blocco stesso verrà considerato disattivato. Un blocco potrebbe essere disattivato contemporaneamente per più motivi indipendenti, ad esempio quando l'utente lo disattiva manualmente o se il blocco non è valido. | |
setEditable(editable) | Imposta se questo blocco è modificabile o meno. | |
setFieldValue(newValue, name) | Imposta il valore del campo specificato per questo blocco. | |
setHelpUrl(url) | Imposta l'URL della pagina di assistenza di questo blocco. | |
setInputsInline(newBoolean) | Imposta se gli input dei valori sono disposti orizzontalmente o verticalmente. | |
setMovable(movable) | Imposta se questo blocco è spostabile o meno. | |
setMutator(_mutator) | Assegna a questo blocco una finestra di dialogo del modificatore. | |
setNextStatement(newBoolean, opt_check) | Imposta se un altro blocco può essere collegato alla parte inferiore di questo blocco. | |
setOnChange(onchangeFn) | Imposta una funzione di callback da utilizzare ogni volta che cambia lo spazio di lavoro principale del blocco, sostituendo qualsiasi gestore onchange precedente. In genere viene chiamato solo dal costruttore, dalla funzione di inizializzazione del tipo di blocco o da una funzione di inizializzazione dell'estensione. | |
setOutput(newBoolean, opt_check) | Imposta se questo blocco restituisce un valore. | |
setOutputShape(outputShape) | Imposta la forma dell'output del blocco. | |
setPreviousStatement(newBoolean, opt_check) | Imposta se questo blocco può essere collegato alla parte inferiore di un altro blocco. | |
setStyle(blockStyleName) | Imposta lo stile e i valori di colore di un blocco. | |
setTooltip(newTip) | Imposta la descrizione comando per questo blocco. | |
setWarningText(_text, _opt_id) | Imposta il testo dell'avviso di questo blocco. | |
toDevString() | Questo metodo restituisce una stringa che descrive questo blocco in termini di sviluppatore (nome e ID tipo; solo in inglese). Destinato a essere utilizzato nei log e negli errori della console. Se hai bisogno di una stringa che utilizzi la lingua nativa dell'utente (inclusi il testo del blocco, i valori dei campi e i blocchi secondari), utilizza toString(). |
|
toString(opt_maxLength, opt_emptyToken) | Crea una rappresentazione di testo di facile lettura di questo blocco e di eventuali elementi secondari. | |
unplug(opt_healStack) | Scollega questo blocco dal blocco superiore. Se questo blocco è un'istruzione, puoi ricollegare facoltativamente il blocco sottostante con quello in alto. |