Skip to main content

Class: ZoomToFitControl

Defined in: index.ts:18

Class for zoom to fit control.

Implements​

  • IComponent
  • IPositionable
  • IFocusableNode

Properties index​

PropertyDescription
idThe unique id for this component.
workspaceThe workspace that the zoom-to-fit control will be added to.

Methods index​

MethodDescription
canBeFocusedIndicates whether this node allows focus. If this returns false then none of the other IFocusableNode methods will be called.
disposeDisposes of workspace search. Unlink from all DOM elements and remove all event listeners to prevent memory leaks.
getBoundingRectangleReturns the bounding rectangle of the UI element in pixel units relative to the Blockly injection div.
getFocusableElementReturns the DOM element that can be explicitly requested to receive focus.
getFocusableTreeReturns the closest parent tree of this node (in cases where a tree has distinct trees underneath it), which represents the tree to which this node belongs.
initInitializes the zoom reset control.
onNodeBlurCalled when this node loses active focus. It may still have passive focus.
onNodeFocusCalled when this node receives active focus.
performActionOptional method invoked when this node has focus and the user acts on it by pressing Enter or Space. Behavior should generally be similar to the node being clicked on.
positionPositions the zoom-to-fit control. It is positioned in the opposite corner to the corner the categories/toolbox starts at.

Constructors​

Constructor​

new ZoomToFitControl(workspace): ZoomToFitControl;

Defined in: index.ts:74

Constructor for zoom-to-fit control.

Parameters​

ParameterTypeDescription
workspaceWorkspaceSvgThe workspace that the zoom-to-fit control will be added to.

Returns​

ZoomToFitControl

Properties​

id​

id: string = 'zoomToFit';

Defined in: index.ts:24

The unique id for this component.

Implementation of​

Blockly.IComponent.id


workspace​

protected workspace: WorkspaceSvg;

Defined in: index.ts:74

The workspace that the zoom-to-fit control will be added to.

Methods​

canBeFocused()​

canBeFocused(): boolean;

Defined in: index.ts:302

Indicates whether this node allows focus. If this returns false then none of the other IFocusableNode methods will be called.

Note that special care must be taken if implementations of this function dynamically change their return value value over the lifetime of the node as certain environment conditions could affect the focusability of this node's DOM element (such as whether the element has a positive or zero tabindex). Also, changing from a true to a false value while the node holds focus will not immediately change the current focus of the node nor FocusManager's internal state, and thus may result in some of the node's functions being called later on when defocused (since it was previously considered focusable at the time of being focused).

Implementations should generally always return true here unless there are circumstances under which this node should be skipped for focus considerations. Examples may include being disabled, read-only, a purely visual decoration, or a node with no visual representation that must implement this interface (e.g. due to a parent interface extending it). Keep in mind accessibility best practices when determining whether a node should be focusable since even disabled and read-only elements are still often relevant to providing organizational context to users (particularly when using a screen reader).

Returns​

boolean

Whether this node can be focused by FocusManager.

Implementation of​

Blockly.IFocusableNode.canBeFocused


dispose()​

dispose(): void;

Defined in: index.ts:97

Disposes of workspace search. Unlink from all DOM elements and remove all event listeners to prevent memory leaks.

Returns​

void


getBoundingRectangle()​

getBoundingRectangle(): Rect;

Defined in: index.ts:193

Returns the bounding rectangle of the UI element in pixel units relative to the Blockly injection div.

Returns​

Rect

The component’s bounding box.

Implementation of​

Blockly.IPositionable.getBoundingRectangle


getFocusableElement()​

getFocusableElement(): SVGElement | HTMLElement;

Defined in: index.ts:287

Returns the DOM element that can be explicitly requested to receive focus.

IMPORTANT: Please note that this element is expected to have a visual presence on the page as it will both be explicitly focused and have its style changed depending on its current focus state (i.e. blurred, actively focused, and passively focused). The element will have one of two styles attached (where no style indicates blurred/not focused):

  • blocklyActiveFocus
  • blocklyPassiveFocus

The returned element must also have a valid ID specified, and this ID should be unique across the entire page. Failing to have a properly unique ID could result in trying to focus one node (such as via a mouse click) leading to another node with the same ID actually becoming focused by FocusManager.

The returned element must be visible if the node is ever focused via FocusManager.focusNode() or FocusManager.focusTree(). It's allowed for an element to be hidden until onNodeFocus() is called, or become hidden with a call to onNodeBlur().

It's expected the actual returned element will not change for the lifetime of the node (that is, its properties can change but a new element should never be returned). Also, the returned element will have its tabindex overwritten throughout the lifecycle of this node and FocusManager.

If a node requires the ability to be focused directly without first being focused via FocusManager then it must set its own tab index.

Returns​

SVGElement | HTMLElement

The HTMLElement or SVGElement which can both receive focus and be visually represented as actively or passively focused for this node.

Implementation of​

Blockly.IFocusableNode.getFocusableElement


getFocusableTree()​

getFocusableTree(): IFocusableTree;

Defined in: index.ts:294

Returns the closest parent tree of this node (in cases where a tree has distinct trees underneath it), which represents the tree to which this node belongs.

Returns​

IFocusableTree

The node's IFocusableTree.

Implementation of​

Blockly.IFocusableNode.getFocusableTree


init()​

init(): void;

Defined in: index.ts:79

Initializes the zoom reset control.

Returns​

void


onNodeBlur()​

onNodeBlur(): void;

Defined in: index.ts:300

Called when this node loses active focus. It may still have passive focus.

This has the same implementation restrictions as onNodeFocus().

Returns​

void

Implementation of​

Blockly.IFocusableNode.onNodeBlur


onNodeFocus()​

onNodeFocus(): void;

Defined in: index.ts:298

Called when this node receives active focus.

Note that it's fine for implementations to change visibility modifiers, but they should avoid the following:

  • Creating or removing DOM elements (including via the renderer or drawer).
  • Affecting focus via DOM focus() calls or the FocusManager.

Implementations may consider scrolling themselves into view here; that is not handled by the focus manager.

Returns​

void

Implementation of​

Blockly.IFocusableNode.onNodeFocus


performAction()​

performAction(e?): void;

Defined in: index.ts:306

Optional method invoked when this node has focus and the user acts on it by pressing Enter or Space. Behavior should generally be similar to the node being clicked on.

Parameters​

ParameterTypeDescription
e?EventThe event that triggered this action, if any.

Returns​

void

Implementation of​

Blockly.IFocusableNode.performAction


position()​

position(metrics, savedPositions): void;

Defined in: index.ts:211

Positions the zoom-to-fit control. It is positioned in the opposite corner to the corner the categories/toolbox starts at.

Parameters​

ParameterTypeDescription
metricsUiMetricsThe workspace metrics.
savedPositionsRect[]List of rectangles that are already on the workspace.

Returns​

void

Implementation of​

Blockly.IPositionable.position