Blockly.
Constructor
Warning
new Warning(block)
Class for a warning.
Parameter |
|
|---|---|
|
block |
The block associated with this warning. Value must not be null. |
- Extends
- Blockly.Icon
Properties
bubble_
unknown
Bubble UI (if visible).
- Inherited from
- Blockly.Icon#bubble_
collapseHidden
Does this icon get hidden when the block is collapsed.
iconGroup_
unknown
- Inherited from
- Blockly.Icon#iconGroup_
iconXY_
unknown
Absolute coordinate of icon's center.
- Inherited from
- Blockly.Icon#iconXY_
SIZE
Height and width of icons.
- Inherited from
- Blockly.Icon#SIZE
Methods
computeIconLocation
computeIconLocation()
Notification that the icon has moved, but we don't really know where. Recompute the icon's location from scratch.
- Inherited from
- Blockly.Icon#computeIconLocation
createIcon
createIcon()
Create the icon on the block.
- Inherited from
- Blockly.Icon#createIcon
dispose
dispose()
Dispose of this warning.
getIconLocation
getIconLocation() returns goog.math.Coordinate
Returns the center of the block's icon relative to the surface.
- Inherited from
- Blockly.Icon#getIconLocation
- Returns
-
Object with x and y properties in workspace coordinates.
getText
getText() returns string
Get this warning's texts.
- Returns
-
stringAll texts concatenated into one string.
iconClick_
iconClick_(e)
Clicking on the icon toggles if the bubble is visible.
Parameter |
|
|---|---|
|
e |
Mouse click event. Value must not be null. |
- Inherited from
- Blockly.Icon#iconClick_
isVisible
isVisible() returns boolean
Is the associated bubble visible?
- Inherited from
- Blockly.Icon#isVisible
- Returns
-
True if the bubble is visible.
renderIcon
renderIcon(cursorX) returns number
Render the icon.
Parameter |
|
|---|---|
|
cursorX |
Horizontal offset at which to position the icon. |
- Inherited from
- Blockly.Icon#renderIcon
- Returns
-
Horizontal offset for next item to draw.
setIconLocation
setIconLocation(xy)
Notification that the icon has moved. Update the arrow accordingly.
Parameter |
|
|---|---|
|
xy |
Absolute location in workspace coordinates. Value must not be null. |
- Inherited from
- Blockly.Icon#setIconLocation
setText
setText(text, id)
Set this warning's text.
Parameter |
|
|---|---|
|
text |
string Warning text (or '' to delete). |
|
id |
string An ID for this text entry to be able to maintain multiple warnings. |
setVisible
setVisible(visible)
Show or hide the warning bubble.
Parameter |
|
|---|---|
|
visible |
boolean True if the bubble should be visible. |
updateColour
updateColour()
Change the colour of the associated bubble to match its block.
- Inherited from
- Blockly.Icon#updateColour
updateEditable
updateEditable()
Add or remove the UI indicating if this icon may be clicked or not.
- Inherited from
- Blockly.Icon#updateEditable