Blockly. FieldColour
Constructor
FieldColour
new FieldColour(colour, opt_validator)
Class for a colour input field.
Parameter |
|
---|---|
colour |
string The initial colour in '#rrggbb' format. |
opt_validator |
Optional function() A function that is executed when a new colour is selected. Its sole argument is the new colour value. Its return value becomes the selected colour, unless it is undefined, in which case the new colour stands, or it is null, in which case the change is aborted. |
- Extends
- Blockly.Field
Properties
COLOURS
non-null Array of string
An array of colour strings for the palette. Copied from goog.ui.ColorPicker.SIMPLE_GRID_COLORS All colour pickers use this unless overridden with setColours.
COLUMNS
Number of columns in the palette. All colour pickers use this unless overridden with setColumns.
TITLES
non-null Array of string
An array of tooltip strings for the palette. If not the same length as COLOURS, the colour's hex code will be used for any missing titles. All colour pickers use this unless overridden with setColours.
CURSOR
Mouse cursor style when over the hotspot that initiates the editor.
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
sourceBlock_
unknown
Block this field is attached to. Starts as null, then in set in init.
- Inherited from
- Blockly.Field#sourceBlock_
text_
unknown
Visible text to display.
- Inherited from
- Blockly.Field#text_
textElement_
unknown
- Inherited from
- Blockly.Field#textElement_
validator_
unknown
Validation function called when user edits an editable field.
- Inherited from
- Blockly.Field#validator_
visible_
unknown
Is the field visible, or hidden due to the block being collapsed?
- Inherited from
- Blockly.Field#visible_
Methods
fromJson
fromJson(options) returns Blockly.FieldColour
Construct a FieldColour from a JSON arg object.
Parameter |
|
---|---|
options |
Object A JSON object with options (colour). Value must not be null. |
- Returns
-
non-null Blockly.FieldColour
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()
Close the colour picker if this input is being deleted.
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
getDisplayText_
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_
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.
- 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. Used when the block is collapsed.
- Returns
-
string
Current text.
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
Return the current colour.
- Returns
-
string
Current colour in '#rrggbb' format.
init
init()
Install this field 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.
onMouseDown_
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
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_
render_()
Draws the border with the correct width. Saves the computed width in a property.
- Inherited from
- Blockly.Field#render_
setColours
setColours(colours, opt_titles) returns Blockly.FieldColour
Set a custom colour grid for this field.
Parameter |
|
---|---|
colours |
Array of string Array of colours for this block, or null to use default (Blockly.FieldColour.COLOURS). |
opt_titles |
Array of string Optional array of colour tooltips, or null to use default (Blockly.FieldColour.TITLES). |
- Returns
-
non-null Blockly.FieldColour
Returns itself (for method chaining).
setColumns
setColumns(columns) returns Blockly.FieldColour
Set a custom grid size for this field.
Parameter |
|
---|---|
columns |
number Number of columns for this block, or 0 to use default (Blockly.FieldColour.COLUMNS). |
- Returns
-
non-null Blockly.FieldColour
Returns itself (for method chaining).
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, or clears a previously set validator.
The validator function takes in the text form of the users input, and optionally returns the accepted field text. Alternatively, if the function returns null, the field value change aborts. If the function does not return anything (or returns undefined), the input value is accepted as valid. This is a shorthand for fields using the validator function call as a field-level change event notification.
Parameter |
|
---|---|
handler |
The validator function or null to clear a previous validator. Value may be null. |
- Inherited from
- Blockly.Field#setValidator
setValue
setValue(colour)
Set the colour.
Parameter |
|
---|---|
colour |
string The new colour in '#rrggbb' format. |
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