Blockly.FieldCheckbox

class   static

Constructor

FieldCheckbox

new FieldCheckbox(state, opt_validator)

Class for a checkbox field.

Parameter

state

string

The initial state of the field ('TRUE' or 'FALSE').

opt_validator

Optional

function()

A function that is executed when a new option is selected. Its sole argument is the new checkbox state. If it returns a value, this becomes the new checkbox state, unless the value is null, in which case the change is aborted.
Extends
Blockly.Field

Properties

CHECK_CHAR

static

Character for the checkmark.

CURSOR

Mouse cursor style when over the hotspot that initiates editability.

EDITABLE

Editable fields are saved by the XML renderer, non-editable fields are not.

Inherited from
Blockly.Field#EDITABLE

maxDisplayLength

unknown

Maximum characters of text to display before adding an ellipsis.

Inherited from
Blockly.Field#maxDisplayLength

name

unknown

Name of field. Unique within each block. Static labels are usually unnamed.

Inherited from
Blockly.Field#name

textElement_

unknown

Inherited from
Blockly.Field#textElement_

Methods

fromJson

static

fromJson(options) returns Blockly.FieldCheckbox

Construct a FieldCheckbox from a JSON arg object.

Parameter

options

Object

A JSON object with options (checked).

Value must not be null.
Returns

non-null Blockly.FieldCheckbox The new field instance.

callValidator

callValidator(text) returns string

Calls the validation function for this field, as well as all the validation function for the field's class and its parents.

Parameter

text

Proposed text.
Inherited from
Blockly.Field#callValidator
Returns

Revised text, or null if invalid.

classValidator

classValidator(text) returns string

Validates a change. Does nothing. Subclasses may override this.

Parameter

text

The user's text.
Inherited from
Blockly.Field#classValidator
Returns

No change needed.

dispose

dispose()

Dispose of all DOM objects belonging to this editable field.

Inherited from
Blockly.Field#dispose

forceRerender

forceRerender()

Force a rerender of the block that this field is installed on, which will rerender this field and adjust for any sizing changes. Other fields on the same block will not rerender, because their sizes have already been recorded.

Inherited from
Blockly.Field#forceRerender

getSize

getSize() returns goog.math.Size

Returns the height and width of the field.

Inherited from
Blockly.Field#getSize
Returns

Height and width.

getSvgRoot

getSvgRoot() returns Element

Gets the group element for this editable field. Used for measuring the size and for positioning.

Inherited from
Blockly.Field#getSvgRoot
Returns

The group element.

getText

getText() returns string

Get the text from this field.

Inherited from
Blockly.Field#getText
Returns

Current text.

getValidator

getValidator() returns function()

Gets the validation function for editable fields.

Inherited from
Blockly.Field#getValidator
Returns

Validation function, or null.

getValue

getValue() returns string

Return 'TRUE' if the checkbox is checked, 'FALSE' otherwise.

Returns

string Current state.

init

init()

Install this checkbox on a block.

initModel

initModel()

Initializes the model of the field after it has been installed on a block. No-op by default.

Inherited from
Blockly.Field#initModel

isCurrentlyEditable

isCurrentlyEditable() returns boolean

Check whether this field is currently editable. Some fields are never editable (e.g. text labels). Those fields are not serialized to XML. Other fields may be editable, and therefore serialized, but may exist on non-editable blocks.

Inherited from
Blockly.Field#isCurrentlyEditable
Returns

whether this field is editable and on an editable block

isVisible

isVisible() returns boolean

Gets whether this editable field is visible or not.

Inherited from
Blockly.Field#isVisible
Returns

True if visible.

referencesVariables

referencesVariables() returns boolean

Whether this field references any Blockly variables. If true it may need to be handled differently during serialization and deserialization. Subclasses may override this.

Inherited from
Blockly.Field#referencesVariables
Returns

True if this field has any variable references.

setSourceBlock

setSourceBlock(block)

Attach this field to a block.

Parameter

block

The block containing this field.

Value must not be null.
Inherited from
Blockly.Field#setSourceBlock

setText

setText(newText)

Set the text in this field. Trigger a rerender of the source block.

Parameter

newText

New text.
Inherited from
Blockly.Field#setText

setTooltip

setTooltip(_newTip)

Change the tooltip text for this field.

Parameter

_newTip

Text for tooltip or a parent element to link to for its tooltip.
Inherited from
Blockly.Field#setTooltip

setValidator

setValidator(handler)

Sets a new validation function for editable fields.

Parameter

handler

New validation function, or null.
Inherited from
Blockly.Field#setValidator

setValue

setValue(newBool)

Set the checkbox to be checked if newBool is 'TRUE' or true, unchecks otherwise.

Parameter

newBool

(string or boolean)

New state.

setVisible

setVisible(visible)

Sets whether this editable field is visible or not.

Parameter

visible

True if visible.
Inherited from
Blockly.Field#setVisible

updateEditable

updateEditable()

Add or remove the UI indicating if this field is editable or not.

Inherited from
Blockly.Field#updateEditable

updateWidth

updateWidth()

Updates thw width of the field. This calls getCachedWidth which won't cache the approximated width on IE/Edge when getComputedTextLength fails. Once it eventually does succeed, the result will be cached.

Inherited from
Blockly.Field#updateWidth