Class: Flyout

Blockly.Flyout

class   abstract   static

Constructor

Flyout

new Flyout(workspaceOptions)

Class for a flyout.

Parameter
workspaceOptions	Blockly.Options Dictionary of options for the workspace. Value must not be null.

Extends

Blockly.DeleteArea

Implements

Blockly.IFlyout

Properties

autoClose

boolean

Does the flyout automatically close when a block is created?

Implements

Blockly.IFlyout#autoClose

buttons_

protected

non-null Array of non-null Blockly.FlyoutButton

List of visible buttons.

CORNER_RADIUS

constant

number

Corner radius of the flyout background.

Implements

Blockly.IFlyout#CORNER_RADIUS

dragAngleRange_

protected

number

Range of a drag angle from a flyout considered "dragging toward workspace". Drags that are within the bounds of this many degrees from the orthogonal line to the flyout edge are considered to be "drags toward the workspace". Example: Flyout Edge Workspace [block] / <-within this angle, drags "toward workspace" | [block] ---- orthogonal to flyout boundary ---- | [block] \ | The angle is given in degrees from the orthogonal.

This is used to know when to create a new block and when to scroll the flyout. Setting it to 360 means that all drags create a new block.

GAP_X

constant

number

Gap between items in horizontal flyouts. Can be overridden with the "sep" element.

GAP_Y

constant

number

Gap between items in vertical flyouts. Can be overridden with the "sep" element.

getClientRect

Returns the bounding rectangle of the drag target area in pixel units relative to viewport.

Returns

Blockly.utils.Rect The component's bounding box.

getX

Calculates the x coordinate for the flyout position.

Implements

Blockly.IFlyout#getX

Returns

number X coordinate.

getY

Calculates the y coordinate for the flyout position.

Implements

Blockly.IFlyout#getY

Returns

number Y coordinate.

height_

protected

number

Height of flyout.

horizontalLayout

package

boolean

Whether the flyout should be laid out horizontally or not.

Implements

Blockly.IFlyout#horizontalLayout

id

string

The unique id for this component that is used to register with the ComponentManager.

isDragTowardWorkspace

package

Determine if a drag delta is toward the workspace, based on the position and orientation of the flyout. This is used in determineDragIntention_ to determine if a new block should be created or if the flyout should scroll.

Parameter
currentDragDeltaXY	Blockly.utils.Coordinate How far the pointer has moved from the position at mouse down, in pixel units. Value must not be null.

Implements

Blockly.IFlyout#isDragTowardWorkspace

Returns

boolean True if the drag is toward the workspace.

layout_

protected

Lay out the blocks in the flyout.

Parameter
contents	Array of non-null Object The blocks and buttons to lay out. Value must not be null.
gaps	Array of number The visible gaps between blocks. Value must not be null.

MARGIN

constant

number

Margin around the edges of the blocks in the flyout.

Implements

Blockly.IFlyout#MARGIN

position

Position the flyout.

Implements

Blockly.IFlyout#position

Returns

void 

reflowInternal_

protected

Compute height of flyout. Position mat under each block. For RTL: Lay out the blocks right-aligned.

Returns

void 

RTL

boolean

Is RTL vs LTR.

Implements

Blockly.IFlyout#RTL

SCROLLBAR_MARGIN

constant

number

Top/bottom padding between scrollbar and edge of flyout background.

setMetrics_

protected

Sets the translation of the flyout to match the scrollbars.

Parameter
xyRatio	{x:number, y:number} Contains a y property which is a float between 0 and 1 specifying the degree of scrolling and a similar x property. Value must not be null.

tabWidth_

constant   protected

number

Width of output tab.

targetWorkspace

package

nullable Blockly.WorkspaceSvg

The target workspace

Implements

Blockly.IFlyout#targetWorkspace

targetWorkspace

non-null Blockly.WorkspaceSvg

Implements

Blockly.IFlyout#targetWorkspace

toolboxPosition_

protected

number

Position of the toolbox and flyout relative to the workspace.

wheel_

protected

Scroll the flyout.

Parameter
e	Event Mouse wheel scroll event. Value must not be null.

width_

protected

number

Width of flyout.

workspace_

protected

non-null Blockly.WorkspaceSvg

wouldDelete_

protected

unknown

Whether the last block or bubble dragged over this delete area would be deleted if dropped on this component. This property is not updated after the block or bubble is deleted.

Inherited from

Blockly.DeleteArea#wouldDelete_

Methods

addBlockListeners_

protected

addBlockListeners_(root, block, rect)

Add listeners to a block that has been added to the flyout.

Parameter
root	SVGElement The root node of the SVG group the block is in. Value must not be null.
block	Blockly.BlockSvg The block to add listeners for. Value must not be null.
rect	SVGElement The invisible rectangle under the block that acts as a mat for that block. Value must not be null.

clearOldBlocks_

protected

clearOldBlocks_()

Delete blocks, mats and buttons from a previous showing of the flyout.

createBlock

package

createBlock(originalBlock) returns Blockly.BlockSvg

Create a copy of this block on the workspace.

Parameter
originalBlock	Blockly.BlockSvg The block to copy from the flyout. Value must not be null.

Implements

Blockly.IFlyout#createBlock

Throws

Error if something went wrong with deserialization.

Returns

non-null Blockly.BlockSvg The newly created block.

createBlock_

protected

createBlock_(blockXml) returns Blockly.BlockSvg

Create a block from the xml and permanently disable any blocks that were defined as disabled.

Parameter
blockXml	Element The xml of the block. Value must not be null.

Returns

non-null Blockly.BlockSvg The block created from the blockXml.

createDom

createDom(tagName) returns SVGElement

Creates the flyout's DOM. Only needs to be called once. The flyout can either exist as its own SVG element or be a g element nested inside a separate SVG element.

Parameter
tagName	(string, non-null Blockly.utils.Svg containing non-null SVGSVGElement, or non-null Blockly.utils.Svg containing non-null SVGGElement) The type of tag to put the flyout in. This should be

Implements

Blockly.IFlyout#createDom

Returns

non-null SVGElement The flyout's SVG group.

createRect_

protected

createRect_(block, x, y, blockHW, index) returns SVGElement

Create and place a rectangle corresponding to the given block.

Parameter
block	Blockly.BlockSvg The block to associate the rect to. Value must not be null.
x	number The x position of the cursor during this layout pass.
y	number The y position of the cursor during this layout pass.
blockHW	{height: number, width: number} The height and width of the block. Value must not be null.
index	number The index into the mats list where this rect should be placed.

Returns

non-null SVGElement Newly created SVG element for the rectangle behind the block.

dispose

dispose()

Dispose of this flyout. Unlink from all DOM elements to prevent memory leaks.

Implements

Blockly.IFlyout#dispose

getFlyoutScale

getFlyoutScale() returns number

Get the scale (zoom level) of the flyout. By default, this matches the target workspace scale, but this can be overridden.

Returns

number Flyout workspace scale.

getHeight

getHeight() returns number

Get the height of the flyout.

Implements

Blockly.IFlyout#getHeight

Returns

number The width of the flyout.

getWidth

getWidth() returns number

Get the width of the flyout.

Implements

Blockly.IFlyout#getWidth

Returns

number The width of the flyout.

getWorkspace

package

getWorkspace() returns Blockly.WorkspaceSvg

Get the workspace inside the flyout.

Implements

Blockly.IFlyout#getWorkspace

Returns

non-null Blockly.WorkspaceSvg The workspace inside the flyout.

hide

hide()

Hide and empty the flyout.

Implements

Blockly.IFlyout#hide

init

init(targetWorkspace)

Initializes the flyout.

Parameter
targetWorkspace	Blockly.WorkspaceSvg The workspace in which to create new blocks. Value must not be null.

Implements

Blockly.IFlyout#init

initFlyoutButton_

protected

initFlyoutButton_(button, x, y)

Initialize the given button: move it to the correct location, add listeners, etc.

Parameter
button	Blockly.FlyoutButton The button to initialize and place. Value must not be null.
x	number The x position of the cursor during this layout pass.
y	number The y position of the cursor during this layout pass.

isBlockCreatable_

package

isBlockCreatable_(block) returns boolean

Does this flyout allow you to create a new instance of the given block? Used for deciding if a block can be "dragged out of" the flyout.

Parameter
block	Blockly.BlockSvg The block to copy from the flyout. Value must not be null.

Returns

boolean True if you can create a new instance of the block, false otherwise.

isScrollable

package

isScrollable() returns boolean

Implements

Blockly.IFlyout#isScrollable

Returns

boolean True if this flyout may be scrolled with a scrollbar or by dragging.

isVisible

isVisible() returns boolean

Is the flyout visible?

Implements

Blockly.IFlyout#isVisible

Returns

boolean True if visible.

moveRectToBlock_

protected

moveRectToBlock_(rect, block)

Move a rectangle to sit exactly behind a block, taking into account tabs, hats, and any other protrusions we invent.

Parameter
rect	SVGElement The rectangle to move directly behind the block. Value must not be null.
block	Blockly.BlockSvg The block the rectangle should be behind. Value must not be null.

onDragEnter

onDragEnter(_dragElement)

Handles when a cursor with a block or bubble enters this drag target.

Parameter
_dragElement	The block or bubble currently being dragged. Value must not be null.

Inherited from

Blockly.DragTarget#onDragEnter

Implements

Blockly.IDragTarget#onDragEnter

onDragExit

onDragExit(_dragElement)

Handles when a cursor with a block or bubble exits this drag target.

Parameter
_dragElement	The block or bubble currently being dragged. Value must not be null.

Inherited from

Blockly.DragTarget#onDragExit

Implements

Blockly.IDragTarget#onDragExit

onDragOver

onDragOver(_dragElement)

Handles when a cursor with a block or bubble is dragged over this drag target.

Parameter
_dragElement	The block or bubble currently being dragged. Value must not be null.

Inherited from

Blockly.DragTarget#onDragOver

Implements

Blockly.IDragTarget#onDragOver

onDrop

onDrop(_dragElement)

Handles when a block or bubble is dropped on this component. Should not handle delete here.

Parameter
_dragElement	The block or bubble currently being dragged. Value must not be null.

Inherited from

Blockly.DragTarget#onDrop

Implements

Blockly.IDragTarget#onDrop

positionAt_

protected

positionAt_(width, height, x, y)

Update the view based on coordinates calculated in position().

Parameter
width	number The computed width of the flyout's SVG group
height	number The computed height of the flyout's SVG group.
x	number The computed x origin of the flyout's SVG group.
y	number The computed y origin of the flyout's SVG group.

reflow

reflow()

Reflow blocks and their mats.

Implements

Blockly.IFlyout#reflow

setContainerVisible

setContainerVisible(visible)

Set whether this flyout's container is visible.

Parameter
visible	boolean Whether the container is visible.

Implements

Blockly.IFlyout#setContainerVisible

setVisible

setVisible(visible)

Set whether the flyout is visible. A value of true does not necessarily mean that the flyout is shown. It could be hidden because its container is hidden.

Parameter
visible	boolean True if visible.

Implements

Blockly.IFlyout#setVisible

shouldPreventMove

shouldPreventMove(_dragElement) returns boolean

Returns whether the provided block or bubble should not be moved after being dropped on this component. If true, the element will return to where it was when the drag started.

Parameter
_dragElement	The block or bubble currently being dragged. Value must not be null.

Inherited from

Blockly.DragTarget#shouldPreventMove

Implements

Blockly.IDragTarget#shouldPreventMove

Returns

Whether the block or bubble provided should be returned to drag start.

show

show(flyoutDef)

Show and populate the flyout.

Parameter
flyoutDef	(non-null Blockly.utils.toolbox.FlyoutDefinition or string) Contents to display in the flyout. This is either an array of Nodes, a NodeList, a toolbox definition, or a string with the name of the dynamic category.

Implements

Blockly.IFlyout#show

updateWouldDelete_

protected

updateWouldDelete_(wouldDelete)

Updates the internal wouldDelete_ state.

Parameter
wouldDelete	The new value for the wouldDelete state.

Inherited from

Blockly.DeleteArea#updateWouldDelete_

wouldDelete

wouldDelete(element, couldConnect) returns boolean

Returns whether the provided block or bubble would be deleted if dropped on this area. This method should check if the element is deletable and is always called before onDragEnter/onDragOver/onDragExit.

Parameter
element	The block or bubble currently being dragged. Value must not be null.
couldConnect	Whether the element could could connect to another.

Inherited from

Blockly.DeleteArea#wouldDelete

Implements

Blockly.IDeleteArea#wouldDelete

Returns

Whether the element provided would be deleted if dropped on this area.