Class Comment

collapseHidden

iconGroup_

SIZE

applyColour

• applyColour(): void

  Change the colour of the associated bubble to match its block.

  Returns void

computeIconLocation

• computeIconLocation(): void

  Notification that the icon has moved, but we don't really know where. Recompute the icon's location from scratch.

  Returns void

createIcon

• createIcon(): void

  Create the icon on the block.

  Returns void

dispose

• dispose(): void

  Dispose of this comment.

  If you want to receive a comment "delete" event (newValue: null), then this should not be called directly. Instead call block.setCommentText(null);

  Returns void

getBubbleSize

• getBubbleSize(): Blockly.utils.Size

  Get the dimensions of this comment's bubble.

  Returns Blockly.utils.Size

  Object with width and height properties.

getCorrectedSize

• getCorrectedSize(): Blockly.utils.Size

  Get the size of the icon as used for rendering. This differs from the actual size of the icon, because it bulges slightly out of its row rather than increasing the height of its row.

  Returns Blockly.utils.Size

  Height and width.

getIconLocation

• getIconLocation(): Blockly.utils.Coordinate

  Returns the center of the block's icon relative to the surface.

  Returns Blockly.utils.Coordinate

  Object with x and y properties in workspace coordinates.

isVisible

• isVisible(): boolean

  Is the associated bubble visible?

  Returns boolean

  True if the bubble is visible.

setBubbleSize

• setBubbleSize(width: number, height: number): void

  Size this comment's bubble.

  Parameters

  • width: number

    Width of the bubble.

  • height: number

    Height of the bubble.

  Returns void

setIconLocation

• setIconLocation(xy: Blockly.utils.Coordinate): void

  Notification that the icon has moved. Update the arrow accordingly.

  Parameters

  • xy: Blockly.utils.Coordinate

    Absolute location in workspace coordinates.

  Returns void

setVisible

• setVisible(visible: boolean): void

  Show or hide the comment bubble.

  Parameters

  • visible: boolean

    True if the bubble should be visible.

  Returns void

updateEditable

• updateEditable(): void

  Add or remove the UI indicating if this icon may be clicked or not.

  Returns void

updateText

• updateText(): void

  Update the comment's view to match the model.

  Returns void

  Package