Blockly Framework Reference

WorkbenchViewController

open class WorkbenchViewController: UIViewController

View controller for editing a workspace.

Constants

• Style

  The style of the workbench

  Declaration

  Swift

  public enum Style: Int

Aliases

• UIState

  Details the bitflags for WorkbenchViewController’s state.

  Declaration

  Swift

  public typealias UIState = WorkbenchViewControllerUIState

• UIStateValue

  Specifies the bitflags for individual state values of WorkbenchViewController.

  Declaration

  Swift

  public typealias UIStateValue = WorkbenchViewControllerUIStateValue

Properties

• workspaceViewController

  The main workspace view controller

  Declaration

  Swift

  open fileprivate(set) var workspaceViewController: WorkspaceViewController!

• trashCanView

  The trash can view.

  Declaration

  Swift

  open fileprivate(set) lazy var trashCanView: TrashCanView =

• undoButton

  The undo button

  Declaration

  Swift

  open fileprivate(set) lazy var undoButton: UIButton =

• redoButton

  The redo button

  Declaration

  Swift

  open fileprivate(set) lazy var redoButton: UIButton =

• toolboxCategoryViewController

  The toolbox category view controller.

  Declaration

  Swift

  open fileprivate(set) lazy var toolboxCategoryViewController: ToolboxCategoryViewController =

• engine

  The layout engine to use for all views

  Declaration

  Swift

  public final let engine: LayoutEngine

• layoutBuilder

  The layout builder to create layout hierarchies

  Declaration

  Swift

  public final let layoutBuilder: LayoutBuilder

• blockFactory

  The factory for creating blocks under this workbench. Any block added to the workbench should be able to be re-created using this factory.

  Declaration

  Swift

  public final let blockFactory: BlockFactory

• viewFactory

  The factory for creating views

  Declaration

  Swift

  public final let viewFactory: ViewFactory

• style

  The style of workbench

  Declaration

  Swift

  public final let style: Style

• workspace

  The current state of the main workspace

  Declaration

  Swift

  open var workspace: Workspace?

• toolbox

  The toolbox that has been loaded via loadToolbox(:)

  Declaration

  Swift

  open var toolbox: Toolbox?

• variableNameManager

  The NameManager that controls the variables in this workbench’s scope.

  Declaration

  Swift

  public let variableNameManager: NameManager

• procedureCoordinator

  Coordinator that handles logic for managing procedure functionality

  Declaration

  Swift

  public var procedureCoordinator: ProcedureCoordinator?

• enableTrashCan

  Displays (true) or hides (false) a trash can. By default, this value is set to true.

  Declaration

  Swift

  open var enableTrashCan: Bool = true

• allowZoom

  Enables or disables pinch zooming of the workspace. Defaults to true.

  Declaration

  Swift

  open var allowZoom: Bool

• allowUndoRedo

  Enables or disables the ability to undo/redo actions in the workspace. Defaults to true.

  Declaration

  Swift

  open var allowUndoRedo: Bool = true

• allowInteractivePopGestureRecognizer

  Enables or disables the interactivePopGestureRecognizer on self.navigationController (i.e. the backswipe gesture on UINavigationController). Defaults to false.

  Declaration

  Swift

  open var allowInteractivePopGestureRecognizer: Bool = false

• workspaceBackgroundColor

  The background color to use for the main workspace.

  Declaration

  Swift

  public var workspaceBackgroundColor: UIColor?

• toolboxDrawerStaysOpen

  Flag for whether the toolbox drawer should stay visible once it has been opened (true) or if it should automatically close itself when the user does something else (false). By default, this value is set to false.

  Declaration

  Swift

  open var toolboxDrawerStaysOpen: Bool = false

• state

  The current state of the UI

  Declaration

  Swift

  open fileprivate(set) var state = UIState.defaultState

• delegate

  The delegate for events that occur in the workbench

  Declaration

  Swift

  open weak var delegate: WorkbenchViewControllerDelegate?

• toolboxCategoryListViewController

  Controller for listing the toolbox categories

  Declaration

  Swift

  open fileprivate(set) lazy var toolboxCategoryListViewController:

• trashCanViewController

  Controller for managing the trash can workspace

  Declaration

  Swift

  open fileprivate(set) lazy var trashCanViewController: TrashCanViewController =

• workspacePanGesetureRecognizer

  The pan gesture recognizer attached to the main workspace.

  Declaration

  Swift

  public var workspacePanGesetureRecognizer: UIPanGestureRecognizer!

• workspaceTapGestureRecognizer

  The tap gesture recognizer attached to the main workspace.

  Declaration

  Swift

  public private(set) lazy var workspaceTapGestureRecognizer: UITapGestureRecognizer =

Initializers

• init(style:)

  Creates the workbench with defaults for self.engine, self.layoutBuilder, self.viewFactory.

  Declaration

  Swift

  public init(style: Style)

  Parameters

  style

  The Style to use for this laying out items in this view controller.

• init(style:engine:layoutBuilder:blockFactory:viewFactory:variableNameManager:procedureCoordinator:)

  Creates the workbench.

  Declaration

  Swift

  public init(
      style: Style, engine: LayoutEngine, layoutBuilder: LayoutBuilder, blockFactory: BlockFactory,
      viewFactory: ViewFactory, variableNameManager: NameManager,
      procedureCoordinator: ProcedureCoordinator)

  Parameters

  style	The Style to use for this laying out items in this view controller.
  engine	Value used for self.layoutEngine.
  layoutBuilder	Value used for self.layoutBuilder.
  blockFactory	Value used for self.blockFactory.
  viewFactory	Value used for self.viewFactory.
  variableNameManager	Value used for self.variableNameManager.
  procedureCoordinator	Value used for self.procedureCoordinator.

Public

• loadWorkspace(_:)

  Automatically creates a WorkspaceLayout and WorkspaceLayoutCoordinator for a given workspace (using both the self.engine and self.layoutBuilder instances). The workspace is then rendered into the view controller.

  Note

  All blocks in workspace must have corresponding BlockBuilder objects in self.blockFactory, based on their associated block name. This is needed for things like handling undo/redo and automatic creation of variable blocks.

  Note

  A ConnectionManager is automatically created for the WorkspaceLayoutCoordinator.

  Throws

  BlocklyError: Thrown if an associated WorkspaceLayout could not be created for the workspace, or if no corresponding BlockBuilder could be found in self.blockFactory for at least one of the blocks in workspace.

  Declaration

  Swift

  open func loadWorkspace(_ workspace: Workspace) throws

  Parameters

  workspace

  The Workspace to load

• loadWorkspace(_:connectionManager:)

  Automatically creates a WorkspaceLayout and WorkspaceLayoutCoordinator for a given workspace (using both the self.engine and self.layoutBuilder instances). The workspace is then rendered into the view controller.

  Note

  All blocks in workspace must have corresponding BlockBuilder objects in self.blockFactory, based on their associated block name. This is needed for things like handling undo/redo and automatic creation of variable blocks.

  Throws

  BlocklyError: Thrown if an associated WorkspaceLayout could not be created for the workspace, or if no corresponding BlockBuilder could be found in self.blockFactory for at least one of the blocks in workspace.

  Declaration

  Swift

  open func loadWorkspace(_ workspace: Workspace, connectionManager: ConnectionManager) throws

  Parameters

  workspace	The Workspace to load
  connectionManager	A ConnectionManager to track connections in the workspace.

• loadToolbox(_:)

  Automatically creates a ToolboxLayout for a given Toolbox (using both the self.engine and self.layoutBuilder instances) and loads it into the view controller.

  Note

  All blocks defined by categories in toolbox must have corresponding BlockBuilder objects in self.blockFactory, based on their associated block name. This is needed for things like handling undo/redo and automatic creation of variable blocks.

  Throws

  BlocklyError: Thrown if an associated ToolboxLayout could not be created for the toolbox, or if no corresponding BlockBuilder could be found in self.blockFactory for at least one of the blocks specified intoolbox.

  Declaration

  Swift

  open func loadToolbox(_ toolbox: Toolbox) throws

  Parameters

  toolbox

  The Toolbox to load

• refreshView()

  Refreshes the UI based on the current version of self.workspace and self.toolbox.

  Declaration

  Swift

  open func refreshView()

• eventManager(_:didFireEvent:)

  Declaration

  Swift

  public func eventManager(_ eventManager: EventManager, didFireEvent event: BlocklyEvent)

  Parameters

  eventManager
  event

• update(fromEvent:runForward:)

  Updates the workbench based on a BlocklyEvent.

  Declaration

  Swift

  open func update(fromEvent event: BlocklyEvent, runForward: Bool)

  Parameters

  event	The BlocklyEvent.
  runForward	Flag determining if the event should be run forward (true for redo operations) or run backward (false for undo operations).

• update(fromCreateEvent:runForward:)

  Updates the workbench based on a BlocklyEvent.Create.

  Declaration

  Swift

  open func update(fromCreateEvent event: BlocklyEvent.Create, runForward: Bool)

  Parameters

  event	The BlocklyEvent.Create.
  runForward	Flag determining if the event should be run forward (true for redo operations) or run backward (false for undo operations).

• update(fromDeleteEvent:runForward:)

  Updates the workbench based on a BlocklyEvent.Delete.

  Declaration

  Swift

  open func update(fromDeleteEvent event: BlocklyEvent.Delete, runForward: Bool)

  Parameters

  event	The BlocklyEvent.Delete.
  runForward	Flag determining if the event should be run forward (true for redo operations) or run backward (false for undo operations).

• update(fromMoveEvent:runForward:)

  Updates the workbench based on a BlocklyEvent.Move.

  Declaration

  Swift

  open func update(fromMoveEvent event: BlocklyEvent.Move, runForward: Bool)

  Parameters

  event	The BlocklyEvent.Move.
  runForward	Flag determining if the event should be run forward (true for redo operations) or run backward (false for undo operations).

• update(fromChangeEvent:runForward:)

  Updates the workbench based on a BlocklyEvent.Change.

  Declaration

  Swift

  open func update(fromChangeEvent event: BlocklyEvent.Change, runForward: Bool)

  Parameters

  event	The BlocklyEvent.Change.
  runForward	Flag determining if the event should be run forward (true for redo operations) or run backward (false for undo operations).

• workspaceViewController(_:didAddBlockView:)

  Declaration

  Swift

  open func workspaceViewController(
      _ workspaceViewController: WorkspaceViewController,
      didAddBlockView blockView: BlockView)

  Parameters

  workspaceViewController
  blockView

• workspaceViewController(_:didRemoveBlockView:)

  Declaration

  Swift

  open func workspaceViewController(
      _ workspaceViewController: WorkspaceViewController,
      didRemoveBlockView blockView: BlockView)

  Parameters

  workspaceViewController
  blockView

• workspaceViewController(_:willPresentViewController:)

  Declaration

  Swift

  open func workspaceViewController(
      _ workspaceViewController: WorkspaceViewController,
      willPresentViewController viewController: UIViewController)

  Parameters

  workspaceViewController
  viewController

• workspaceViewControllerDismissedViewController(_:)

  Declaration

  Swift

  open func workspaceViewControllerDismissedViewController(
      _ workspaceViewController: WorkspaceViewController)

  Parameters

  workspaceViewController

• copyBlockToWorkspace(_:)

  Copies the specified block from a flyout (trash/toolbox) to the workspace.

  Declaration

  Swift

  public func copyBlockToWorkspace(_ blockView: BlockView) -> BlockView?

  Parameters

  blockView

  The BlockView to copy

  Return Value

  The new BlockView

• removeBlockFromTrash(_:)

  Removes a BlockView from the trash, when moving it back to the workspace.

  Declaration

  Swift

  public func removeBlockFromTrash(_ blockView: BlockView)

  Parameters

  blockView

  The BlockView to remove.

• addGestureTracking(forBlockView:)

  Adds custom gesture recognizers to a block view. It is automatically called by WorkbenchViewController when a block view is added to the workspace.

  Subclasses may override this to add custom gesture tracking to a block view. The default implementation does nothing.

  Declaration

  Swift

  open func addGestureTracking(forBlockView blockView: BlockView)

  Parameters

  blockView

  A given block view.

• removeGestureTracking(forBlockView:)

  Removes all gesture recognizers and any on-going gesture data from a block view.

  Declaration

  Swift

  open func removeGestureTracking(forBlockView blockView: BlockView)

  Parameters

  blockView

  A given block view.

• toolboxCategoryListViewController(_:didSelectCategory:)

  Declaration

  Swift

  public func toolboxCategoryListViewController(
      _ controller: ToolboxCategoryListViewController, didSelectCategory category: Toolbox.Category)

• toolboxCategoryListViewControllerDidDeselectCategory(_:)

  Declaration

  Swift

  public func toolboxCategoryListViewControllerDidDeselectCategory(
      _ controller: ToolboxCategoryListViewController)

• highlightBlock(blockUUID:)

  Highlights a block in the workspace.

  Declaration

  Swift

  public func highlightBlock(blockUUID: String)

  Parameters

  blockUUID

  The UUID of the block to highlight

• unhighlightBlock(blockUUID:)

  Unhighlights a block in the workspace.

  • Paramater blockUUID: The UUID of the block to unhighlight.

  Declaration

  Swift

  public func unhighlightBlock(blockUUID: String)

• unhighlightAllBlocks()

  Unhighlights all blocks in the workspace.

  Declaration

  Swift

  public func unhighlightAllBlocks()

• scrollBlockIntoView(blockUUID:location:animated:)

  Automatically adjusts the workspace’s scroll view to bring a given Block into view.

  Declaration

  Swift

  public func scrollBlockIntoView(
      blockUUID: String, location: WorkspaceView.Location = .anywhere, animated: Bool)

  Parameters

  block	The Block to bring into view.
  location	The area of the screen where the block should appear. If .anywhere is specified, the viewport is changed the minimal amount necessary to bring the block into view.
  animated	Flag determining if this scroll view adjustment should be animated.

• blocklyPanGestureRecognizer(_:didTouchBlock:touch:touchState:)

  Pan gesture event handler for a block view inside self.workspaceView.

  Declaration

  Swift

  open func blocklyPanGestureRecognizer(
      _ gesture: BlocklyPanGestureRecognizer, didTouchBlock block: BlockView,
      touch: UITouch, touchState: BlocklyPanGestureRecognizer.TouchState)