Class: FieldCheckbox

Constructor

FieldCheckbox

new FieldCheckbox(opt_value, opt_validator)

Class for a checkbox field.

Parameter
opt_value	(string or optional boolean) The initial value of the field. Should either be 'TRUE', 'FALSE' or a boolean. Defaults to 'FALSE'.
opt_validator	Optional function() A function that is called to validate changes to the field's value. Takes in a value ('TRUE' or 'FALSE') & returns a validated value ('TRUE' or 'FALSE'), or null to abort the change.

Parameter

opt_value

(string or optional boolean)

The initial value of the field. Should either be 'TRUE', 'FALSE' or a boolean. Defaults to 'FALSE'.

opt_validator

Optional

function()

A function that is called to validate changes to the field's value. Takes in a value ('TRUE' or 'FALSE') & returns a validated value ('TRUE' or 'FALSE'), or null to abort the change.

Extends: Blockly.Field

Properties

CHECK_CHAR

constant static

string

Character for the checkmark.

CHECK_X_OFFSET

constant static

number

Used to correctly position the check mark.

CHECK_Y_OFFSET

constant static

number

Used to correctly position the check mark.

WIDTH

constant static

number

The width of a checkbox field.

CURSOR

Mouse cursor style when over the hotspot that initiates editability.

EDITABLE

constant

unknown

Editable fields usually show some sort of UI indicating they are editable. They will also be saved by the XML renderer.

Inherited from: Blockly.Field#EDITABLE
Default value: true

fieldGroup_

unknown

Inherited from: Blockly.Field#fieldGroup_

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

SERIALIZABLE

constant

boolean

Serializable fields are saved by the XML renderer, non-serializable fields are not. Editable fields should also be serializable.

sourceBlock_

protected

unknown

Block this field is attached to. Starts as null, then set in init.

Inherited from: Blockly.Field#sourceBlock_

text_

protected

unknown

Text representation of the field's value. Maintained for backwards compatibility reasons.

Inherited from: Blockly.Field#text_
Deprecated: Use or override getText instead.

validator_

protected

unknown

Validation function called when user edits an editable field.

Inherited from: Blockly.Field#validator_

value_

protected

unknown

A generic value possessed by the field. Should generally be non-null, only null when the field is created.

Inherited from: Blockly.Field#value_

visible_

protected

unknown

Is the field visible, or hidden due to the block being collapsed?

Inherited from: Blockly.Field#visible_

Methods

fromJson

package 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.

Parameter

options

Object

A JSON object with options (checked).

Value must not be null.

Returns: non-null Blockly.FieldCheckbox The new field instance.

bindEvents_

protected

bindEvents_()

Bind events to the field. Can be overridden by subclasses if they need to do custom input handling.

Inherited from: Blockly.Field#bindEvents_

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
Deprecated: May 2019. setValue now contains all relevant logic.
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
Deprecated: May 2019. Override doClassValidation and other relevant 'do' functions instead.
Returns: No change needed.

createBorderRect_

protected

createBorderRect_()

Create a field border rect element. Not to be overridden by subclasses. Instead modify the result of the function inside initView, or create a separate function to call.

Inherited from: Blockly.Field#createBorderRect_

createTextElement_

protected

createTextElement_()

Create a field text element. Not to be overridden by subclasses. Instead modify the result of the function inside initView, or create a separate function to call.

Inherited from: Blockly.Field#createTextElement_

dispose

package

dispose()

Dispose of all DOM objects and events belonging to this editable field.

Inherited from: Blockly.Field#dispose

doClassValidation_

protected

doClassValidation_(newValue) returns string

Ensure that the input value is valid ('TRUE' or 'FALSE').

Parameter
newValue	(string or optional boolean) The input value.

Parameter

newValue

(string or optional boolean)

The input value.

Returns: nullable string A valid value ('TRUE' or 'FALSE), or null if invalid.

doValueInvalid_

protected

doValueInvalid_(_invalidValue)

Used to notify the field an invalid value was input. Can be overidden by subclasses, see FieldTextInput. No-op by default.

Parameter
_invalidValue	The input value that was determined to be invalid.

Inherited from: Blockly.Field#doValueInvalid_

doValueUpdate_

protected

doValueUpdate_(newValue)

Update the value of the field, and update the checkElement.

Parameter
newValue	string The new value ('TRUE' or 'FALSE') of the field.

Parameter

newValue

string

The new value ('TRUE' or 'FALSE') of the field.

forceRerender

package

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

fromXml

package

fromXml(fieldElement)

Sets the field's value based on the given XML element. Should only be called by Blockly.Xml.

Parameter
fieldElement	The element containing info about the field's state. Value must not be null.

Parameter

fieldElement

The element containing info about the field's state.

Value must not be null.

Inherited from: Blockly.Field#fromXml

getDisplayText_

protected

getDisplayText_() returns string

Get the text from this field as displayed on screen. May differ from getText due to ellipsis, and other formatting.

Inherited from: Blockly.Field#getDisplayText_
Returns: Currently displayed text.

getScaledBBox_

protected

getScaledBBox_() returns Object

Returns the bounding box of the rendered field, accounting for workspace scaling.

Inherited from: Blockly.Field#getScaledBBox_
Returns: An object with top, bottom, left, and right in pixels relative to the top left corner of the page (window coordinates).

getSize

getSize() returns goog.math.Size

Returns the height and width of the field.

This should in general be the only place render_ gets called from.

Inherited from: Blockly.Field#getSize
Returns: Height and width.

getSourceBlock

getSourceBlock() returns Blockly.Block

Get the block this field is attached to.

Inherited from: Blockly.Field#getSourceBlock
Returns: The block containing this field.

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 of this field. Used when the block is collapsed.

Returns: string Text representing the value of this field ('true' or 'false').

getValidator

getValidator() returns function()

Gets the validation function for editable fields, or null if not set.

Inherited from: Blockly.Field#getValidator
Returns: Validation function, or null.

getValue

getValue() returns string

Get the value of this field, either 'TRUE' or 'FALSE'.

Returns: string The value of this field.

getValueBoolean

getValueBoolean() returns string

Get the boolean value of this field.

Returns: string The boolean value of this field.

init

package

init()

Initialize everything to render this field. Override methods initModel and initView rather than this method.

Inherited from: Blockly.Field#init

initModel

package

initModel()

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

Inherited from: Blockly.Field#initModel

initView

package

initView()

Create the block UI for this checkbox.

isClickable

isClickable() returns boolean

Check whether this field defines the showEditor_ function.

Inherited from: Blockly.Field#isClickable
Returns: Whether this field is clickable.

isCurrentlyEditable

isCurrentlyEditable() returns boolean

Check whether this field is currently editable. Some fields are never EDITABLE (e.g. text labels). Other fields may be EDITABLE but may exist on non-editable blocks.

Inherited from: Blockly.Field#isCurrentlyEditable
Returns: Whether this field is editable and on an editable block

isSerializable

isSerializable() returns boolean

Check whether this field should be serialized by the XML renderer. Handles the logic for backwards compatibility and incongruous states.

Inherited from: Blockly.Field#isSerializable
Returns: Whether this field should be serialized or not.

isVisible

isVisible() returns boolean

Gets whether this editable field is visible or not.

Inherited from: Blockly.Field#isVisible
Returns: True if visible.

onMouseDown_

protected

onMouseDown_(e)

Handle a mouse down event on a field.

Parameter
e	Mouse down event. Value must not be null.

Inherited from: Blockly.Field#onMouseDown_

referencesVariables

package

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.

render_

protected

render_()

Used by getSize() to move/resize any dom elements, and get the new size.

All rendering that has an effect on the size/shape of the block should be done here, and should be triggered by getSize().

Inherited from: Blockly.Field#render_

setSourceBlock

setSourceBlock(block)

Attach this field to a block.

Parameter
block	The block containing this field. Value must not be null.

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, or clears a previously set validator.

The validator function takes in the new field value, and returns validated value. The validated value could be the input value, a modified version of the input value, or null to abort the change.

If the function does not return anything (or returns undefined) the new value is accepted as valid. This is to allow for fields using the validated founction as a field-level change event notification.

Parameter
handler	Optional The validator function or null to clear a previous validator.

Parameter

handler

Optional

The validator function or null to clear a previous validator.

Inherited from: Blockly.Field#setValidator

setValue

setValue(newValue)

Used to change the value of the field. Handles validation and events. Subclasses should override doClassValidation_ and doValueUpdate_ rather than this method.

Parameter
newValue	New value.

Inherited from: Blockly.Field#setValue

setVisible

package

setVisible(visible)

Sets whether this editable field is visible or not. Should only be called by input.setVisible.

Parameter
visible	True if visible.

Inherited from: Blockly.Field#setVisible

showEditor_

protected

showEditor_()

Toggle the state of the checkbox on click.

toXml

package

toXml(fieldElement) returns Element

Serializes this field's value to XML. Should only be called by Blockly.Xml.

Parameter
fieldElement	The element to populate with info about the field's state. Value must not be null.

Parameter

fieldElement

The element to populate with info about the field's state.

Value must not be null.

Inherited from: Blockly.Field#toXml
Returns: The element containing info about the field's state.

updateColour

package

updateColour()

Updates the field to match the colour/style of the block. Should only be called by BlockSvg.updateColour().

Inherited from: Blockly.Field#updateColour

updateEditable

updateEditable()

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

Inherited from: Blockly.Field#updateEditable

updateSize_

protected

updateSize_()

Updates the size of the field based on the text.

Inherited from: Blockly.Field#updateSize_

updateWidth

updateWidth()

Updates the width of the field. Redirects to updateSize_().

Inherited from: Blockly.Field#updateWidth
Deprecated: May 2019 Use Blockly.Field.updateSize_() to force an update to the size of the field, or Blockly.Field.getCachedWidth() to check the size of the field..