Blockly Framework Reference

WorkbenchViewController

@objcMembers 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

  Set of UIStateValue values representing the workbench state.

  Declaration

  Swift

  public typealias UIState = Set<UIStateValue>

• UIStateValue

  Underlying type for a UI state value.

  Declaration

  Swift

  public typealias UIStateValue = Int

Properties

• stateTrashCanOpen

  State indicating the trash can is open.

  Declaration

  Swift

  public let stateTrashCanOpen = WorkbenchViewController.newUIStateValue()

• stateTrashCanHighlighted

  State indicating the trash can is highlighted

  Declaration

  Swift

  public let stateTrashCanHighlighted = WorkbenchViewController.newUIStateValue()

• stateCategoryOpen

  State indicating the toolbox category is open.

  Declaration

  Swift

  public let stateCategoryOpen = WorkbenchViewController.newUIStateValue()

• stateEditingTextField

  State indicating a text field is being edited.

  Declaration

  Swift

  public let stateEditingTextField = WorkbenchViewController.newUIStateValue()

• stateDraggingBlock

  State indicating a block is currently being dragged.

  Declaration

  Swift

  public let stateDraggingBlock = WorkbenchViewController.newUIStateValue()

• statePresentingPopover

  State indicating a popover is being presented.

  Declaration

  Swift

  public let statePresentingPopover = WorkbenchViewController.newUIStateValue()

• stateDidPanWorkspace

  State indicating the user panned the workspace.

  Declaration

  Swift

  public let stateDidPanWorkspace = WorkbenchViewController.newUIStateValue()

• stateDidTapWorkspace

  State indicating the user tapped the workspace.

  Declaration

  Swift

  public let stateDidTapWorkspace = WorkbenchViewController.newUIStateValue()

• workspaceViewController

  The main workspace view controller

  Declaration

  Swift

  public private(set) lazy 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 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

• keepTrashedBlocks

  If true, blocks dragged into trash are kept in memory and can be recalled by tapping the trash can. If false, blocks are not kept in memory and tapping the trash can is disabled. Defaults to false.

  Declaration

  Swift

  open var keepTrashedBlocks: Bool = false

• 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

  A set containing all active states of the UI.

  Declaration

  Swift

  open fileprivate(set) var state = WorkbenchViewController.UIState()

• 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 =

• shouldRecordEvents

  Flag determining if this view controller should be recording events for undo/redo purposes.

  Declaration

  Swift

  open fileprivate(set) var shouldRecordEvents = true

• undoStack

  Stack of events to run when applying undo actions. The events are sorted in chronological order, where the first event to undo is at the end of the array.

  Declaration

  Swift

  open var undoStack = [BlocklyEvent]()

• redoStack

  Stack of events to run when applying redo actions. The events are sorted in reverse chronological order, where the first event to redo is at the end of the array.

  Declaration

  Swift

  open var redoStack = [BlocklyEvent]()

• 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)

• 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)

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

• 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

• 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

• refreshView()

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

  Declaration

  Swift

  open func refreshView()

• newUIStateValue()

  Creates a new UIStateValue. Subclasses may call this to create additional state values that should be handled by WorkbenchViewController.

  Declaration

  Swift

  public static func newUIStateValue() -> UIStateValue

  Return Value

  A unique UIStateValue.

• addUIStateValue(_:animated:)

  Adds an individual UI state value to the current state of the workbench. Generally, this call should be matched by a future call to removeUIStateValue(_:animated:).

  See

  To change the behavior of how the state value is added to the current state, see WorkbenchViewControllerDelegate.workbenchViewController(_:shouldKeepStates:forStateValue:).

  Declaration

  Swift

  public func addUIStateValue(_ stateValue: UIStateValue, animated: Bool = true)

• removeUIStateValue(_:animated:)

  Removes a UI state value from the current state of the workbench. This call should have matched a previous call to addUIStateValue(_:animated:).

  Declaration

  Swift

  public func removeUIStateValue(_ stateValue: UIStateValue, animated: Bool = true)

• eventManager(_:didFireEvent:)

  Declaration

  Swift

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

• update(fromEvent:runForward:)

  Updates the workbench based on a BlocklyEvent.

  Declaration

  Swift

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

• update(fromCreateEvent:runForward:)

  Updates the workbench based on a BlocklyEvent.Create.

  Declaration

  Swift

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

• update(fromDeleteEvent:runForward:)

  Updates the workbench based on a BlocklyEvent.Delete.

  Declaration

  Swift

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

• update(fromMoveEvent:runForward:)

  Updates the workbench based on a BlocklyEvent.Move.

  Declaration

  Swift

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

• update(fromChangeEvent:runForward:)

  Updates the workbench based on a BlocklyEvent.Change.

  Declaration

  Swift

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

• workspaceViewController(_:didAddBlockView:)

  Declaration

  Swift

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

• workspaceViewController(_:didRemoveBlockView:)

  Declaration

  Swift

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

• workspaceViewController(_:willPresentViewController:)

  Declaration

  Swift

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

• workspaceViewControllerDismissedViewController(_:)

  Declaration

  Swift

  open func workspaceViewControllerDismissedViewController(
      _ workspaceViewController: WorkspaceViewController)

• copyBlockToWorkspace(_:)

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

  Declaration

  Swift

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

  Return Value

  The new BlockView

• addBlockToTrash(_:)

  Adds a copy of a given block to the trash.

  Note

  If keepTrashedBlocks is set to false, this method does nothing.

  Declaration

  Swift

  public func addBlockToTrash(_ block: Block)

• removeBlockFromTrash(_:)

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

  Declaration

  Swift

  public func removeBlockFromTrash(_ blockView: BlockView)

• 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)

• removeGestureTracking(forBlockView:)

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

  Declaration

  Swift

  open func removeGestureTracking(forBlockView blockView: BlockView)

• 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)

• 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)

• setViewport(to:animated:)

  Sets the content offset of the workspace’s scroll view so that a specific location in the workspace is visible.

  Declaration

  Swift

  public func setViewport(to location: WorkspaceView.Location, animated: Bool)

• 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)