Class AttributeValueIcon

    • Field Detail

      • attributeName

        public StringAttribute attributeName
        The name of the attribute of the container whose value to display. This is a string that by default is empty. An empty string means that the attribute whose value to display is the container itself, rather than an attribute contained by the container.
      • displayHeight

        public Parameter displayHeight
        The maximum number of lines to display. This is an integer, with default value 1.
      • displayWidth

        public Parameter displayWidth
        The number of characters to display. This is an integer, with default value 6.
      • entityName

        public StringParameter entityName
        Name of the entity contained by the container whose attribute this icon will display. This is a string that defaults to the empty string, which means that the attribute is contained by the container of this attribute.
      • _labelFont

        protected static final java.awt.Font _labelFont
        The font used.
    • Constructor Detail

      • AttributeValueIcon

        public AttributeValueIcon​(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

      • createFigure

        public Figure createFigure()
        Create a new Diva figure that visually represents this icon. The figure will be an instance of LabelFigure that renders the value of the specified attribute of the container.
        Overrides:
        createFigure in class EditorIcon
        Returns:
        A new CompositeFigure consisting of the label.
      • _associatedAttribute

        protected Settable _associatedAttribute()
                                         throws IllegalActionException
        Return the associated attribute. If an entityName is given, then the associated attribute is attribute with name given by attributeName contained by the specified entity. If no entityName is given, then the associated attribute is the one contained by the container of this object with the specified name. If no attributeName is given either, and the the container of this object is an Attribute, then the associated attribute is that container. Otherwise, throw an exception.
        Returns:
        The associated attribute.
        Throws:
        IllegalActionException - If no Settable associated attribute can be found.
      • _attributeValueString

        protected java.lang.String _attributeValueString()
        Get the string value of the attribute to render in the icon. This string is the expression giving the value of the attribute of the container having the name attributeName. If the string is empty, then return a string with one space (diva fails on empty strings). This method will always return the full string value of the attribute and will not be truncated.
        Returns:
        The string value of the attribute to display, or a string with one space if none is found.
      • _displayString

        protected java.lang.String _displayString()
        Get the string to render in the icon. This string is the expression giving the value of the attribute of the container having the name attributeName, truncated so that it is no longer than displayWidth characters. If it is truncated, then the string has a trailing "...". If the string is empty, then return a string with one space (diva fails on empty strings).
        Returns:
        The string to display, or a string with one space if none is found.