Class: Comment

Constructor

Comment

new Comment(block)

Class for a comment.

Parameter
block	Blockly.Block The block associated with this comment. Value must not be null.

Parameter

block

Blockly.Block

The block associated with this comment.

Value must not be null.

Extends: Blockly.Icon

Properties

bubble_

protected

unknown

Bubble UI (if visible).

Inherited from: Blockly.Icon#bubble_

collapseHidden

Does this icon get hidden when the block is collapsed.

Inherited from: Blockly.Icon#collapseHidden

iconGroup_

unknown

Inherited from: Blockly.Icon#iconGroup_

iconXY_

protected

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

getBubbleSize

getBubbleSize() returns Object

Get the dimensions of this comment's bubble.

Returns: non-null Object Object with width and height properties.

getIconLocation

getIconLocation() returns Blockly.utils.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

Returns this comment's text.

Returns: string Comment text.

iconClick_

protected

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.

setBubbleSize

setBubbleSize(width, height)

Size this comment's bubble.

Parameter
width	number Width of the bubble.
height	number Height of the bubble.

Parameter

width

number

Width of the bubble.

height

number

Height of the bubble.

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)

Set this comment's text.

Parameter
text	string Comment text.

setVisible

setVisible(visible)

Show or hide the comment bubble.

Parameter
visible	boolean True if the bubble should be visible.

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 editability of the comment.

Inherited from: Blockly.Comment#updateEditable