Blockly Framework Reference

Block

@objcMembers public final class Block : NSObject

Class that represents a single block.

Note

To create a block programmatically, use a BlockBuilder.

Tuples

• BlockTree

  A tuple representing a tree of connected blocks where:

  • rootBlock is the root of the tree
  • allBlocks is a list of all connected blocks (including rootBlock).

  Declaration

  Swift

  public typealias BlockTree = (rootBlock: Block, allBlocks: [Block])

Properties

• uuid

  A unique identifier used to identify this block for its lifetime

  Declaration

  Swift

  public let uuid: String

• name

  The type name of this block

  Declaration

  Swift

  public let name: String

• inputsInline

  Flag indicating if input connectors should be drawn inside a block (true) or on the edge of the block (false)

  Declaration

  Swift

  public var inputsInline: Bool

• position

  The absolute position of the block, in the Workspace coordinate system

  Declaration

  Swift

  public var position: WorkspacePoint

• shadow

  Flag indicating if this is a shadow block (true) or not (`false)

  Declaration

  Swift

  public let shadow: Bool

• outputConnection

  The .OutputValue connection for this block

  Declaration

  Swift

  public let outputConnection: Connection?

• outputBlock

  Convenience property for accessing self.outputConnection?.targetBlock

  Declaration

  Swift

  public var outputBlock: Block?

• nextConnection

  The .NextStatement connection for this block

  Declaration

  Swift

  public let nextConnection: Connection?

• nextBlock

  Convenience property for accessing self.nextConnection?.targetBlock

  Declaration

  Swift

  public var nextBlock: Block?

• nextShadowBlock

  Convenience property for accessing self.nextConnection?.shadowBlock

  Declaration

  Swift

  public var nextShadowBlock: Block?

• previousConnection

  The .PreviousStatement connection for this block

  Note

  A block may only have one non-nil self.outputConnection or self.previousConnection

  Declaration

  Swift

  public let previousConnection: Connection?

• previousBlock

  Convenience property for accessing self.previousConnection?.targetBlock

  Declaration

  Swift

  public var previousBlock: Block?

• inferiorConnection

  If an inferior connection exists, returns either self.outputConnection or self.previousConnection (only one may be non-nil).

  Declaration

  Swift

  public var inferiorConnection: Connection?

• directConnections

  List of connections directly attached to this block

  Declaration

  Swift

  public fileprivate(set) var directConnections = [Connection]()

• inputs

  List of inputs attached to this block

  Declaration

  Swift

  public private(set) var inputs: [Input]

• color

  The color of the block

  Declaration

  Swift

  public let color: UIColor

• mutator

  An optional mutator for this block

  Declaration

  Swift

  public var mutator: Mutator?

• tooltip

  Tooltip text of the block

  Declaration

  Swift

  public var tooltip: String

• comment

  The comment text of the block

  Declaration

  Swift

  public var comment: String

• helpURL

  A help URL to learn more info about this block

  Declaration

  Swift

  public var helpURL: String

• deletable

  Flag indicating if this block may be deleted

  Declaration

  Swift

  public var deletable: Bool

• movable

  Flag indicating if this block may be moved by the user

  Declaration

  Swift

  public var movable: Bool

• disabled

  Flag indicating if this block is disabled, which means it will be excluded from code generation.

  Declaration

  Swift

  public var disabled: Bool

• draggable

  Flag indicating if this block may be dragged by the user

  Declaration

  Swift

  public var draggable: Bool

• editable

  Flag indicating if this block can be edited. Updating this property automatically updates the editable property on all child fields.

  Declaration

  Swift

  public var editable: Bool

• topLevel

  Flag indicating if this block is at the highest level in the workspace

  Declaration

  Swift

  public var topLevel: Bool

• style

  The style that should be applied to the block during rendering.

  Declaration

  Swift

  public var style: Style

• listeners

  Listeners for events that occur on this block.

  Declaration

  Swift

  public var listeners = WeakSet<BlockListener>()

• layout

  The layout associated with this block.

  Declaration

  Swift

  public weak var layout: BlockLayout?

Public

• allConnectionsForTree()

  Returns a list of all connections directly or indirectly connected to this block.

  Declaration

  Swift

  public func allConnectionsForTree() -> [Connection]

  Return Value

  A list of all connections directly or indirectly connected to this block.

• lastBlockInChain()

  Follows the chain of next connections starting from this block and returns the last block in the chain.

  Declaration

  Swift

  public func lastBlockInChain() -> Block

• lastInputValueConnectionInChain()

  Follows the chain of input value connections starting from this block, returning the last input value connection. For each block in the chain, if there is exactly one input value, it either follows the input to the next block or returns the input value connection if it’s the last block. Nil is returned if any block in the chain has no or multiple input values.

  Declaration

  Swift

  public func lastInputValueConnectionInChain() -> Connection?

  Return Value

  The last input connection in the chain, or nil if none could be found.

• allBlocksForTree()

  Follows all input and next connections starting from this block and returns all blocks connected to this block, including this block.

  Declaration

  Swift

  public func allBlocksForTree() -> [Block]

  Return Value

  A list of all blocks connected to this block, including this block.

• firstInput(withName:)

  Finds the first input with a given name.

  Declaration

  Swift

  public func firstInput(withName name: String) -> Input?

  Return Value

  The first input with that name or nil.

• firstField(withName:)

  Finds the first field with a given name.

  Declaration

  Swift

  public func firstField(withName name: String) -> Field?

  Return Value

  The first field with that name or nil.

• deepCopy()

  Copies this block and all of the blocks connected to it through its input or next connections.

  Throws

  BlocklyError: Thrown if copied blocks could not be connected to each other.

  Declaration

  Swift

  public func deepCopy() throws -> BlockTree

  Return Value

  A BlockTree tuple of the copied block tree.

• didSetProperty(_:_:)

  A convenience method that should be called inside the didSet { ... } block of instance properties.

  If property != oldValue, this method will automatically call notifyDidUpdateBlock(). If property == oldValue, nothing happens.

  Usage:

  var someString: String {
    didSet { didSetProperty(someString, oldValue) }
  }
  

  Declaration

  Swift

  public func didSetProperty<T: Equatable>(_ property: T, _ oldValue: T) -> Bool

  Return Value

  true if property is now different than oldValue. false otherwise.

Listeners

• notifyDidUpdateBlock()

  Sends a notification to self.listeners that this block has been updated.

  Declaration

  Swift

  public func notifyDidUpdateBlock()

Inputs

• appendInput(_:)

  Append an input to the end of self.inputs.

  Declaration

  Swift

  public func appendInput(_ input: Input)

• insertInput(_:at:)

  Insert an input at the specified position.

  Declaration

  Swift

  public func insertInput(_ input: Input, at index: Int)

• removeInput(_:)

  Remove an input from the block. If the input doesn’t exist, nothing happens.

  Note

  The input must be disconnected from any connected shadow and non-shadow blocks prior to calling this method or else an error is thrown.

  Throws

  BlocklyError: Thrown if input has a shadow or non-shadow block still connected to it.

  Declaration

  Swift

  public func removeInput(_ input: Input) throws

Mutator

• setMutator(_:)

  Associates a mutator with this block and immediately calls mutateBlock() on it.

  Throws

  BlocklyError: Thrown if a mutator has already been associated with the block or if mutator.mutateBlock() throws an error.

  Declaration

  Swift

  public func setMutator(_ mutator: Mutator) throws

Block.Style Class

• Style

  Specifies any styles that should be applied to the block during rendering.

  Declaration

  Swift

  @objcMembers open class Style: NSObject, NSCopying

Public

• makeBuilder(json:mutators:extensions:)

  Creates a new BlockBuilder from a JSON dictionary.

  Throws

  BlocklyError: Occurs if there is a problem parsing the JSON dictionary (eg. insufficient data, malformed data, or contradictory data). It also is thrown if a mutator (or extension) name has been defined in json, but no corresponding mapping could be found in mutators (or extensions).

  Declaration

  Swift

  public class func makeBuilder(
      json: [String: Any], mutators: [String: Mutator] = [:],
      extensions: [String: BlockExtension] = [:]) throws -> BlockBuilder

  Return Value

  A new block builder.

Public

• blockTree(fromXMLString:factory:)

  Creates a new tree of blocks from an XML object.

  Throws

  BlocklyError: Occurs if there is a problem parsing the xml (eg. insufficient data, malformed data, or contradictory data).

  Declaration

  Swift

  public class func blockTree(
      fromXMLString xmlString: String, factory: BlockFactory) throws -> BlockTree

  Return Value

  A BlockTree tuple of all blocks that were created.

• blockTree(fromXML:factory:)

  Creates a new tree of blocks from an XML object.

  Throws

  BlocklyError: Occurs if there is a problem parsing the xml (eg. insufficient data, malformed data, or contradictory data).

  Declaration

  Swift

  public class func blockTree(fromXML xml: AEXMLElement, factory: BlockFactory) throws -> BlockTree

  Return Value

  A BlockTree tuple of all blocks that were created.

Public

• toXML()

  Returns an XML string representing the current state of this block and all of its descendants.

  Throws

  BlocklyError: Thrown if there was an error serializing this block or any of its descendants.

  Declaration

  Swift

  public func toXML() throws -> String

  Return Value

  The XML string.