Kepler

/* An icon that renders the value of the container.

 Copyright (c) 1999-2011 The Regents of the University of California.

 All rights reserved.

 Permission is hereby granted, without written agreement and without

 license or royalty fees, to use, copy, modify, and distribute this

 software and its documentation for any purpose, provided that the above

 copyright notice and the following two paragraphs appear in all copies

 of this software.

 IN NO EVENT SHALL THE UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY

 FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES

 ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF

 THE UNIVERSITY OF CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF

 SUCH DAMAGE.

 THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY WARRANTIES,

 INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF

 MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE

 PROVIDED HEREUNDER IS ON AN "AS IS" BASIS, AND THE UNIVERSITY OF

 CALIFORNIA HAS NO OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES,

 ENHANCEMENTS, OR MODIFICATIONS.

 PT_COPYRIGHT_VERSION_2

 COPYRIGHTENDKEY

 */

package ptolemy.vergil.icon;

import java.awt.Color;

import java.awt.Font;

import java.util.List;

import javax.swing.SwingConstants;

import ptolemy.actor.gui.ColorAttribute;

import ptolemy.data.IntToken;

import ptolemy.data.expr.Parameter;

import ptolemy.data.type.BaseType;

import ptolemy.kernel.util.*;

import ptolemy.util.StringUtilities;

import diva.canvas.CompositeFigure;

import diva.canvas.Figure;

import diva.canvas.toolbox.BasicEllipse;

import diva.canvas.toolbox.LabelFigure;

///////////////////////////////////////////////////////////////////

//// ValueIcon

/**

 An icon that displays a bullet, the name, and, if the container is

 an instance of settable, its value.

 @author Edward A. Lee, Steve Neuendorffer

 @version $Id: ValueIcon.java 64753 2012-10-02 02:05:53Z cxh $

 @since Ptolemy II 2.0

 @Pt.ProposedRating Yellow (eal)

 @Pt.AcceptedRating Red (johnr)

 */

public class ValueIcon extends XMLIcon {

    /** 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.

     *  @param container The container for this attribute.

     *  @param name The name of this attribute.

     *  @exception IllegalActionException If thrown by the parent

     *  class or while setting an attribute.

     *  @exception NameDuplicationException If the name coincides with

     *   an attribute already in the container.

     */

    public ValueIcon(NamedObj container, String name)

            throws NameDuplicationException, IllegalActionException {

        super(container, name);

        displayWidth = new Parameter(this, "displayWidth");

        displayWidth.setExpression("60");

        displayWidth.setTypeEquals(BaseType.INT);

    }

    ///////////////////////////////////////////////////////////////////

    ////                         parameters                        ////

    /** The number of characters to display. This is an integer, with

     *  default value 60.

     */

    public Parameter displayWidth;

    ///////////////////////////////////////////////////////////////////

    ////                         public methods                    ////

    /** Create a background figure based on this icon, which is a text

     *  element with the name of the container, a colon, and its value.

     *  @return A figure for this icon.

     */

    public Figure createBackgroundFigure() {

        return createFigure();

    }

    /** Create a new Diva figure that visually represents this icon.

     *  The figure will be an instance of LabelFigure that renders the

     *  container name and value, separated by a colon.

     *  @return A new CompositeFigure consisting of the label.

     */

    public Figure createFigure() {

        CompositeFigure background = new CompositeFigure(

                super.createBackgroundFigure());

        Nameable container = getContainer();

        // Patch from Sean Riddle so that attributes that have _hideName

        // are handled in a manner similar to how actors handle _hideName.

        // See http://bugzilla.ecoinformatics.org/show_bug.cgi?id=4903

        // and http://bugzilla.ecoinformatics.org/show_bug.cgi?id=5266

        // and http://bugzilla.ecoinformatics.org/show_bug.cgi?id=5642.

        if (!_isPropertySet(getContainer(), "_hideName")) {

            if (container instanceof Settable) {

                String name = container.getDisplayName();

                String value = ((Settable) container).getExpression();

                int width = 60;

                try {

                    width = ((IntToken) displayWidth.getToken()).intValue();

                } catch (IllegalActionException ex) {

                    throw new InternalErrorException(this, ex,

                            "Failed to get the width?");

                }

                String truncated = StringUtilities

                    .truncateString(value, width, 1);

				LabelFigure label;

				if (container instanceof Parameter) {

					label = new LabelFigure(truncated,

							_labelFont, 1.0, SwingConstants.SOUTH_WEST);

				}

				else {

					label = new LabelFigure(name + ": "

							+ truncated,

							_labelFont, 1.0, SwingConstants.SOUTH_WEST);

				}

                background.add(label);

                return background;

            } else {

                String name = container.getName();

                LabelFigure label = new LabelFigure(name, _labelFont, 1.0,

                        SwingConstants.SOUTH_WEST);

                background.add(label);

                return background;

			}

        }

		else {

            return background;

        }

    }

    ///////////////////////////////////////////////////////////////////

    ////                         protected methods                 ////

    /** Create a new default background figure, which is a bullet.

     *  @return A figure representing a bullet.

     */

    protected Figure _createDefaultBackgroundFigure() {

        Color color = Color.black;

        List colorAttributes = attributeList(ColorAttribute.class);

        if (colorAttributes.size() > 0) {

            ColorAttribute colorAttribute = (ColorAttribute) colorAttributes

                    .get(0);

            color = colorAttribute.asColor();

        }

        return new BasicEllipse(-10, -6, 6, 6, color, 1);

    }

    ///////////////////////////////////////////////////////////////////

    ////                         private members                   ////

    private static Font _labelFont = new Font("SansSerif", Font.PLAIN, 12);

}