Package com.inductiveautomation.ignition.designer.blockandconnector.model

Interface BlockDiagramModel

All Known Implementing Classes:
PipelineBlockModel
public interface BlockDiagramModel
A model of a block diagram. This model is what drives each tab of a block and connector workspace.

  • Method Details

    • getResourcePath

      ResourcePath getResourcePath()
      The resource path of the project resource this block model is contained in

    • getDiagramName

      String getDiagramName()
      The name of the diagram will be used as the tab name

    • getDiagramSize

      Dimension getDiagramSize()
      The size of the block and connector diagram canvas

    • setDiagramSize

      void setDiagramSize(Dimension dim)

    • getConnectedSetRoot

      UUID getConnectedSetRoot()
      If this diagram logically supports the idea of a "connected set" of vertices, this is the ID of the block that is the root of the connected set

    • getBlock

      Block getBlock(UUID id)
      Find the block with the given id, or null if no such block exists

    • addBlock

      void addBlock(Block block)
      Add a new block to this model. You must fire a change after this

    • deleteBlock

      void deleteBlock(Block block)
      Delete the given block from the model. You must fire a change after this

    • getBlocks

      Iterable<? extends Block> getBlocks()
      Provide an iterable collection for all the blocks in this model

    • isConnectionValid

      boolean isConnectionValid(AnchorPoint addingStartAnchor, AnchorPoint addingEndAnchor)
      Check whether a connection between the given anchor points is semantically valid or not

    • addChangeListener

      void addChangeListener(ChangeListener listener)

    • removeChangeListener

      void removeChangeListener(ChangeListener listener)

    • addConnection

      void addConnection(AnchorPoint origin, AnchorPoint terminus)
      Add a connection between two blocks. You must fire a change after this

    • deleteConnection

      void deleteConnection(AnchorPoint origin, AnchorPoint terminus)
      Remove a connection. You must fire a change after this.

    • getConnections

      Collection<Connection> getConnections()