Class StateIcon

  • All Implemented Interfaces:
    java.lang.Cloneable, Changeable, Debuggable, DebugListener, Derivable, IconAttribute, ModelErrorHandler, MoMLExportable, Moveable, Nameable
    Direct Known Subclasses:
    EventIcon, FmvStateIcon, StateMatcherIcon

    public class StateIcon
    extends NameIcon
    An icon that displays the name of the container in an appropriately sized rounded box. This is designed to be contained by an instance of State, and if it is, and if the state is the initial state, then the rounded box will be bold. If it is a final state, then it will be double.

    By default, the icon will be filled with color white, unless the refinement name of the containing State is not empty, in which case it returns a light green. However, if this attribute contains a ColorParameter named "fill", then the color of that color parameter is used instead. If not, but if the container is a State and contains a ColorAttribute named "fill", then that color is used..

    Since:
    Ptolemy II 8.0
    Version:
    $Id$
    Author:
    Edward A. Lee
    Pt.AcceptedRating:
    Red (cxh)
    Pt.ProposedRating:
    Red (eal)
    • Constructor Detail

      • StateIcon

        public StateIcon​(NamedObj container,
                         java.lang.String name)
                  throws NameDuplicationException,
                         IllegalActionException
        Create a new icon with the given name in the given container. The container is required to implement Settable, or an exception will be thrown.
        Parameters:
        container - The container for this attribute.
        name - The name of this attribute.
        Throws:
        IllegalActionException - If thrown by the parent class or while setting an attribute.
        NameDuplicationException - If the name coincides with an attribute already in the container.
    • Method Detail

      • _getFill

        protected java.awt.Paint _getFill()
        Return the paint to use to fill the icon. By default, this class returns Color.white, unless the refinement name is not empty, in which case it returns a light green. However, if this attribute contains a ColorParameter named "fill", then the color of that color parameter is returned instead. In addition, if the container is a State and contains a ColorAttribute named "fill", then that color is returned.
        Overrides:
        _getFill in class NameIcon
        Returns:
        The paint to use to fill the icon.
      • _getLineWidth

        protected float _getLineWidth()
        Return the line width to use in rendering the box. This returns 1.0f, unless the container is an instance of State and its isInitialState parameter is set to true.
        Overrides:
        _getLineWidth in class NameIcon
        Returns:
        The line width to use in rendering the box.