Class: CommentIcon
Defined in: packages/blockly/core/icons/comment_icon.ts:40
An icon which allows the user to add comment text to a block.
Extends
Implements
Properties index
| Property | Description |
|---|---|
| TYPE | The type string used to identify this icon. |
| WEIGHT | The weight this icon has relative to other icons. Icons with more positive weight values are rendered farther toward the end of the block. |
| sourceBlock | - |
| offsetInBlock | The position of this icon relative to its blocks top-start, in workspace units. |
| workspaceLocation | The position of this icon in workspace coordinates. |
| svgRoot | The root svg element visually representing this icon. |
| tooltip | The tooltip for this icon. |
Methods index
| Method | Description |
|---|---|
| getType | Returns the IconType representing the type of the icon. This value should also be used to register the icon via Blockly.icons.registry.register. |
| initView | Creates the SVG elements for the icon that will live on the block. |
| dispose | Disposes of any elements of the icon. |
| getWeight | Returns the "weight" of the icon, which determines the static order which icons should be rendered in. More positive numbers are rendered farther toward the end of the block. |
| getSize | Returns the dimensions of the icon for use in rendering. |
| applyColour | Updates the icon's color when the block's color changes.. |
| updateEditable | Updates the state of the bubble (editable / noneditable) to reflect the state of the bubble if the bubble is currently shown. |
| onLocationChange | Notifies the icon that it has changed locations. |
| setText | Sets the text of this comment. Updates any bubbles if they are visible. |
| getText | Returns the text of this comment. |
| setBubbleSize | Sets the size of the editable bubble for this comment. Resizes the bubble if it is visible. |
| getBubbleSize | Returns the size of the editable bubble for this comment. |
| setBubbleLocation | Sets the location of the comment bubble in the workspace. |
| getBubbleLocation | Returns the location of the comment bubble in the workspace. |
| saveState | Returns the state of the comment as a JSON serializable value if the comment has text. Otherwise returns null. |
| loadState | Applies the given state to this comment. |
| onClick | Notifies the icon that it has been clicked. |
| isClickableInFlyout | Check whether the icon should be clickable while the block is in a flyout. The default is that icons are clickable in all flyouts (auto-closing or not). Subclasses may override this function to change this behavior. |
| onTextChange | Updates the text of this comment in response to changes in the text of the input bubble. |
| onSizeChange | Updates the size of this icon in response to changes in the size of the input bubble. |
| onBubbleLocationChange | - |
| bubbleIsVisible | Returns true if the bubble is currently open, false otherwise. |
| setBubbleVisible | Sets whether the bubble is open or not. |
| getBubble | See IHasBubble.getBubble. |
| createBubble | - |
| getAriaLabel | Returns the ARIA label to use for this icon (defaults to null). Note that this method will only be called during initialization by default, so dynamic changes to the icon's ARIA label need to be applied by calling recomputeAriaContext. |
| setTooltip | Sets the tooltip for this icon to the given value. Null to show the tooltip of the block. |
| getTooltip | Returns the tooltip for this icon. |
| updateCollapsed | Updates the icon's collapsed-ness/view when the block's collapsed-ness changes. |
| hideForInsertionMarker | Hides the icon when it is part of an insertion marker. |
| isShownWhenCollapsed | Returns whether this icon is shown when the block is collapsed. Used to allow renderers to account for padding. |
| setOffsetInBlock | Notifies the icon where it is relative to its block's top-start, in workspace units. |
| getFocusableElement | See IFocusableNode.getFocusableElement. |
| getFocusableTree | See IFocusableNode.getFocusableTree. |
| onNodeFocus | See IFocusableNode.onNodeFocus. |
| onNodeBlur | See IFocusableNode.onNodeBlur. |
| canBeFocused | See IFocusableNode.canBeFocused. |
| performAction | Handles the user acting on this icon via keyboard navigation. Performs the same action as a click would, and focuses this icon's bubble if it has one. |
| getSourceBlock | Returns the block that this icon is attached to. |
| showContextMenu | Show the context menu for this object. |
| recomputeAriaContext | Recomputes the ARIA label and role for this icon. This is automatically called during initialization, but implementations may find it useful to call this if the icon's label should be changed. |
Constructors
Constructor
new CommentIcon(sourceBlock): CommentIcon;
Defined in: packages/blockly/core/icons/comment_icon.ts:71
Parameters
| Parameter | Type |
|---|---|
sourceBlock | Block |
Returns
CommentIcon
Overrides
Properties
TYPE
readonly static TYPE: IconType<ICommentIcon> = IconType.COMMENT;
Defined in: packages/blockly/core/icons/comment_icon.ts:42
The type string used to identify this icon.
WEIGHT
readonly static WEIGHT: 3 = 3;
Defined in: packages/blockly/core/icons/comment_icon.ts:48
The weight this icon has relative to other icons. Icons with more positive weight values are rendered farther toward the end of the block.
sourceBlock
protected readonly sourceBlock: Block;
Defined in: packages/blockly/core/icons/comment_icon.ts:71
Inherited from
offsetInBlock
protected offsetInBlock: Coordinate;
Defined in: packages/blockly/core/icons/icon.ts:39
The position of this icon relative to its blocks top-start, in workspace units.
Inherited from
workspaceLocation
protected workspaceLocation: Coordinate;
Defined in: packages/blockly/core/icons/icon.ts:42
The position of this icon in workspace coordinates.
Inherited from
svgRoot
protected svgRoot: SVGGElement | null = null;
Defined in: packages/blockly/core/icons/icon.ts:45
The root svg element visually representing this icon.
Inherited from
tooltip
protected tooltip: TipInfo;
Defined in: packages/blockly/core/icons/icon.ts:48
The tooltip for this icon.
Inherited from
Methods
getType()
getType(): IconType<CommentIcon>;
Defined in: packages/blockly/core/icons/comment_icon.ts:75
Returns
IconType<CommentIcon>
the IconType representing the type of the icon. This value should
also be used to register the icon via Blockly.icons.registry.register.
Overrides
initView()
initView(pointerdownListener): void;
Defined in: packages/blockly/core/icons/comment_icon.ts:79
Creates the SVG elements for the icon that will live on the block.
Parameters
| Parameter | Type | Description |
|---|---|---|
pointerdownListener | (e) => void | An event listener that must be attached to the root SVG element by the implementation of initView. Used by Blockly's gesture system to properly handle clicks and drags. |
Returns
void
Overrides
dispose()
dispose(): void;
Defined in: packages/blockly/core/icons/comment_icon.ts:118
Disposes of any elements of the icon.
Returns
void
Remarks
In particular, if this icon is currently showing a bubble, this should be used to hide it.
Overrides
getWeight()
getWeight(): number;
Defined in: packages/blockly/core/icons/comment_icon.ts:123
Returns
number
the "weight" of the icon, which determines the static order which icons should be rendered in. More positive numbers are rendered farther toward the end of the block.
Overrides
getSize()
getSize(): Size;
Defined in: packages/blockly/core/icons/comment_icon.ts:127
Returns
The dimensions of the icon for use in rendering.
Overrides
applyColour()
applyColour(): void;
Defined in: packages/blockly/core/icons/comment_icon.ts:131
Updates the icon's color when the block's color changes..
Returns
void
Overrides
updateEditable()
updateEditable(): Promise<void>;
Defined in: packages/blockly/core/icons/comment_icon.ts:141
Updates the state of the bubble (editable / noneditable) to reflect the state of the bubble if the bubble is currently shown.
Returns
Promise<void>
Overrides
onLocationChange()
onLocationChange(blockOrigin): void;
Defined in: packages/blockly/core/icons/comment_icon.ts:150
Notifies the icon that it has changed locations.
Parameters
| Parameter | Type | Description |
|---|---|---|
blockOrigin | Coordinate | The location of this icon's block's top-start corner in workspace coordinates. |
Returns
void
Overrides
setText()
setText(text): void;
Defined in: packages/blockly/core/icons/comment_icon.ts:163
Sets the text of this comment. Updates any bubbles if they are visible.
Parameters
| Parameter | Type |
|---|---|
text | string |
Returns
void
getText()
getText(): string;
Defined in: packages/blockly/core/icons/comment_icon.ts:179
Returns the text of this comment.
Returns
string
setBubbleSize()
setBubbleSize(size): void;
Defined in: packages/blockly/core/icons/comment_icon.ts:187
Sets the size of the editable bubble for this comment. Resizes the bubble if it is visible.
Parameters
| Parameter | Type |
|---|---|
size | Size |
Returns
void
getBubbleSize()
getBubbleSize(): Size;
Defined in: packages/blockly/core/icons/comment_icon.ts:193
Returns
the size of the editable bubble for this comment.
setBubbleLocation()
setBubbleLocation(location): void;
Defined in: packages/blockly/core/icons/comment_icon.ts:200
Sets the location of the comment bubble in the workspace.
Parameters
| Parameter | Type |
|---|---|
location | Coordinate |
Returns
void
getBubbleLocation()
getBubbleLocation(): Coordinate | undefined;
Defined in: packages/blockly/core/icons/comment_icon.ts:208
Returns
Coordinate | undefined
the location of the comment bubble in the workspace.
saveState()
saveState(): CommentState | null;
Defined in: packages/blockly/core/icons/comment_icon.ts:216
Returns
CommentState | null
the state of the comment as a JSON serializable value if the comment has text. Otherwise returns null.
Implementation of
loadState()
loadState(state): void;
Defined in: packages/blockly/core/icons/comment_icon.ts:238
Applies the given state to this comment.
Parameters
| Parameter | Type |
|---|---|
state | CommentState |
Returns
void
Implementation of
onClick()
onClick(): void;
Defined in: packages/blockly/core/icons/comment_icon.ts:258
Notifies the icon that it has been clicked.
Returns
void
Overrides
isClickableInFlyout()
isClickableInFlyout(): boolean;
Defined in: packages/blockly/core/icons/comment_icon.ts:263
Check whether the icon should be clickable while the block is in a flyout. The default is that icons are clickable in all flyouts (auto-closing or not). Subclasses may override this function to change this behavior.
Returns
boolean
Whether the icon should be clickable while the block is in a flyout.
Overrides
onTextChange()
onTextChange(): void;
Defined in: packages/blockly/core/icons/comment_icon.ts:271
Updates the text of this comment in response to changes in the text of the input bubble.
Returns
void
onSizeChange()
onSizeChange(): void;
Defined in: packages/blockly/core/icons/comment_icon.ts:293
Updates the size of this icon in response to changes in the size of the input bubble.
Returns
void
onBubbleLocationChange()
onBubbleLocationChange(): void;
Defined in: packages/blockly/core/icons/comment_icon.ts:299
Returns
void
bubbleIsVisible()
bubbleIsVisible(): boolean;
Defined in: packages/blockly/core/icons/comment_icon.ts:305
Returns
boolean
True if the bubble is currently open, false otherwise.
Implementation of
setBubbleVisible()
setBubbleVisible(visible): Promise<void>;
Defined in: packages/blockly/core/icons/comment_icon.ts:309
Sets whether the bubble is open or not.
Parameters
| Parameter | Type |
|---|---|
visible | boolean |
Returns
Promise<void>
Implementation of
getBubble()
getBubble(): TextInputBubble | null;
Defined in: packages/blockly/core/icons/comment_icon.ts:346
See IHasBubble.getBubble.
Returns
TextInputBubble | null
Implementation of
createBubble()
protected createBubble(): void;
Defined in: packages/blockly/core/icons/comment_icon.ts:366
Returns
void
getAriaLabel()
protected getAriaLabel(): string | null;
Defined in: packages/blockly/core/icons/comment_icon.ts:422
Returns the ARIA label to use for this icon (defaults to null). Note that this method will only be called during initialization by default, so dynamic changes to the icon's ARIA label need to be applied by calling recomputeAriaContext.
Returns
string | null
The ARIA label to use for this icon, or null to use a default.
Overrides
setTooltip()
setTooltip(tip): void;
Defined in: packages/blockly/core/icons/icon.ts:104
Sets the tooltip for this icon to the given value. Null to show the tooltip of the block.
Parameters
| Parameter | Type |
|---|---|
tip | TipInfo | null |
Returns
void
Inherited from
getTooltip()
getTooltip(): TipInfo;
Defined in: packages/blockly/core/icons/icon.ts:109
Returns the tooltip for this icon.
Returns
Inherited from
updateCollapsed()
updateCollapsed(): void;
Defined in: packages/blockly/core/icons/icon.ts:117
Updates the icon's collapsed-ness/view when the block's collapsed-ness changes.
Returns
void
Inherited from
hideForInsertionMarker()
hideForInsertionMarker(): void;
Defined in: packages/blockly/core/icons/icon.ts:129
Hides the icon when it is part of an insertion marker.
Returns
void
Inherited from
isShownWhenCollapsed()
isShownWhenCollapsed(): boolean;
Defined in: packages/blockly/core/icons/icon.ts:134
Returns
boolean
Whether this icon is shown when the block is collapsed. Used to allow renderers to account for padding.
Inherited from
setOffsetInBlock()
setOffsetInBlock(offset): void;
Defined in: packages/blockly/core/icons/icon.ts:138
Notifies the icon where it is relative to its block's top-start, in workspace units.
Parameters
| Parameter | Type |
|---|---|
offset | Coordinate |
Returns
void
Inherited from
getFocusableElement()
getFocusableElement(): HTMLElement | SVGElement;
Defined in: packages/blockly/core/icons/icon.ts:170
See IFocusableNode.getFocusableElement.
Returns
HTMLElement | SVGElement
Inherited from
getFocusableTree()
getFocusableTree(): IFocusableTree;
Defined in: packages/blockly/core/icons/icon.ts:177
See IFocusableNode.getFocusableTree.
Returns
Inherited from
onNodeFocus()
onNodeFocus(): void;
Defined in: packages/blockly/core/icons/icon.ts:182
See IFocusableNode.onNodeFocus.
Returns
void
Inherited from
onNodeBlur()
onNodeBlur(): void;
Defined in: packages/blockly/core/icons/icon.ts:194
See IFocusableNode.onNodeBlur.
Returns
void
Inherited from
canBeFocused()
canBeFocused(): boolean;
Defined in: packages/blockly/core/icons/icon.ts:197
See IFocusableNode.canBeFocused.
Returns
boolean
Inherited from
performAction()
performAction(): void;
Defined in: packages/blockly/core/icons/icon.ts:206
Handles the user acting on this icon via keyboard navigation. Performs the same action as a click would, and focuses this icon's bubble if it has one.
Returns
void
Inherited from
getSourceBlock()
getSourceBlock(): Block;
Defined in: packages/blockly/core/icons/icon.ts:222
Returns the block that this icon is attached to.
Returns
The block this icon is attached to.
Inherited from
showContextMenu()
showContextMenu(e): void;
Defined in: packages/blockly/core/icons/icon.ts:226
Show the context menu for this object.
Parameters
| Parameter | Type | Description |
|---|---|---|
e | PointerEvent | Mouse event. |
Returns
void
Inherited from
recomputeAriaContext()
protected recomputeAriaContext(): void;
Defined in: packages/blockly/core/icons/icon.ts:235
Recomputes the ARIA label and role for this icon. This is automatically called during initialization, but implementations may find it useful to call this if the icon's label should be changed.
Returns
void