Interface ISymbol

  • All Superinterfaces:
    IItem

    public interface ISymbol
    extends IItem
    Represents a symbol displayed in a diagram.

    This interface is not intended to be implemented by clients.

    Since:
    2.2.0
    • Method Detail

      • getDefinition

        IDefinition getDefinition()
        Returns the definition this symbol is representing in a diagram.
        Returns:
        the definition this symbol is representing in a diagram.
      • getDiagram

        IDiagram getDiagram()
        Returns the diagram on which the symbol has been created.
        Returns:
        the diagram on which the symbol has been created.
      • isSelected

        boolean isSelected()
        Determines whether the symbol is highlighted on the diagram.
        Returns:
        true if the symbol is highlighted on the diagram, false otherwise.
      • setSelected

        void setSelected​(boolean selected)
        Determines whether the symbol is highlighted on the diagram.
        Parameters:
        selected - a boolean indicates whether the symbol should be selected in the diagram.
      • setConnectedFrom

        void setConnectedFrom​(ISymbol from)
        Used to connect a symbol at the "from" end of the line.
        Parameters:
        from - Any instantiated line symbol.
      • setConnectedTo

        void setConnectedTo​(ISymbol to)
        Used to connect a symbol at the "to" end of the line.
        Parameters:
        to - any instantiated line symbol.