Package ptolemy.vergil.icon

Class BoxedValuesIcon

  • All Implemented Interfaces:
    java.lang.Cloneable, Changeable, Debuggable, DebugListener, Derivable, IconAttribute, ModelErrorHandler, MoMLExportable, Moveable, Nameable, ValueListener
    public class BoxedValuesIcon
extends XMLIcon
    This icon displays the value of all visible attributes of class Settable contained by the container of this icon. Visible attributes are those whose visibility is Settable.FULL. The names and values of the attributes are displayed in a box that resizes as necessary. If any line is longer than displayWidth (in characters), then it is truncated.
    Since:
    Ptolemy II 4.0
    Version:
    $Id$
    Author:
    Edward A. Lee
    Pt.AcceptedRating:
    Red (johnr)
    Pt.ProposedRating:
    Yellow (eal)

    • Field Detail

      • displayWidth

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

      • _labelFont

        protected static final java.awt.Font _labelFont
        The font used.

    • Constructor Detail

      • BoxedValuesIcon

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

      • createBackgroundFigure

        public Figure createBackgroundFigure()
        Create a new background figure. This overrides the base class to draw a box around the value display, where the width of the box depends on the value.
        Overrides:
        createBackgroundFigure in class XMLIcon
        Returns:
        A new figure.

      • 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 values of the attributes of the container.
        Overrides:
        createFigure in class EditorIcon
        Returns:
        A new CompositeFigure consisting of the label.

      • _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 null if none is found.