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

Interface Block

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void addBlockListener​(BlockListener listener)
      The block should notify this change listener when it moves
      Block copy​(java.util.Map<java.util.UUID,​java.util.UUID> newIds)
      Copy the settings of this block into a new block instance.
      java.util.Collection<AnchorPoint> getAnchorPoints()
      The valid origins and terminus points for connectors coming into or out of this block
      AnchorPoint getDefaultDropAnchor​(AnchorPoint oppositeAnchor)
      When a connector is being dropped on this block, what anchor point should it attach to if it isn't specifically over an anchor's hotspot (may return null)
      java.util.UUID getId()
      Each block in a model is identified by a UUID
      java.awt.Point getLocation()
      The upper left-most point of the block in the diagram.
      void initUI​(BlockComponent panel)
      Used to initialize the display of a block.
      void removeBlockListener​(BlockListener listener)  
      void setLocation​(java.awt.Point newLocation)
      Don't forget to fire a change so that the UI knows the block has moved

    • Method Detail

      • getId

        java.util.UUID getId()
        Each block in a model is identified by a UUID

      • addBlockListener

        void addBlockListener​(BlockListener listener)
        The block should notify this change listener when it moves

      • removeBlockListener

        void removeBlockListener​(BlockListener listener)

      • getLocation

        java.awt.Point getLocation()
        The upper left-most point of the block in the diagram. The size of the block is determined by the block's ui

      • setLocation

        void setLocation​(java.awt.Point newLocation)
        Don't forget to fire a change so that the UI knows the block has moved

      • copy

        Block copy​(java.util.Map<java.util.UUID,​java.util.UUID> newIds)
        Copy the settings of this block into a new block instance. Any outgoing connections originating at this block should also be copied. If the destination of those connections is in the id set, it should point to the new block.
        Parameters:
        newIds - a map of all new ids for copied blocks (including this one). Should be used to point outgoing connections to blocks in the copied set to their new ids.

      • getAnchorPoints

        java.util.Collection<AnchorPoint> getAnchorPoints()
        The valid origins and terminus points for connectors coming into or out of this block

      • getDefaultDropAnchor

        AnchorPoint getDefaultDropAnchor​(AnchorPoint oppositeAnchor)
        When a connector is being dropped on this block, what anchor point should it attach to if it isn't specifically over an anchor's hotspot (may return null)
        Parameters:
        oppositeAnchor - The anchor point that would be the opposite anchor on the connector being hovered over this block.

      • initUI

        void initUI​(BlockComponent panel)
        Used to initialize the display of a block. The block component is just a JPanel, so you can add whatever you want to it and set its layout manager. The block's size will be the preferred size of the contents that you add.