ptolemy.vergil.icon
Class BoxedValueIcon

java.lang.Object
  ptolemy.kernel.util.NamedObj
      ptolemy.kernel.util.Attribute
          ptolemy.vergil.icon.EditorIcon
              ptolemy.vergil.icon.DynamicEditorIcon
                  ptolemy.vergil.icon.XMLIcon
                      ptolemy.vergil.icon.AttributeValueIcon
                          ptolemy.vergil.icon.BoxedValueIcon

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, Changeable, Debuggable, DebugListener, Derivable, ModelErrorHandler, MoMLExportable, Moveable, Nameable, ValueListener

Direct Known Subclasses:

ActorNameIcon

public class BoxedValueIcon
extends AttributeValueIcon

An icon that displays the value of an attribute of the container in a box that resizes according to the width of the attribute value. The attribute is assumed to be an instance of Settable, and its name is given by the parameter attributeName.

Since:

Ptolemy II 2.0

Version:

$Id: BoxedValueIcon.java 57040 2010-01-27 20:52:32Z cxh $

Author:

Edward A. Lee

See Also:

Serialized Form

Accepted Rating:

Red (johnr)

Proposed Rating:

Yellow (eal)

Nested Class Summary

Nested classes/interfaces inherited from class ptolemy.kernel.util.NamedObj

NamedObj.ContainedObjectsIterator

Field Summary

ColorAttribute

boxColor Color of the box.

Fields inherited from class ptolemy.vergil.icon.AttributeValueIcon

_labelFont, attributeName, displayHeight, displayWidth, entityName

Fields inherited from class ptolemy.vergil.icon.EditorIcon

_containerToBe, _iconCache

Fields inherited from class ptolemy.kernel.util.NamedObj

_changeListeners, _changeLock, _changeRequests, _debugging, _debugListeners, _elementName, _isPersistent, _verbose, _workspace, ATTRIBUTES, CLASSNAME, COMPLETE, CONTENTS, DEEP, FULLNAME, LINKS

Constructor Summary

BoxedValueIcon(NamedObj container, java.lang.String name)
Create a new icon with the given name in the given container.

Method Summary

Figure

createBackgroundFigure() Create a new background figure.

Methods inherited from class ptolemy.vergil.icon.AttributeValueIcon

_displayString, createFigure

Methods inherited from class ptolemy.vergil.icon.XMLIcon

_description, _recreateFigure, clone, createIcon, getXMLIcon, getXMLIcon, paintedList, toString, valueChanged

Methods inherited from class ptolemy.vergil.icon.DynamicEditorIcon

_addLiveFigure, _liveFigureIterator, _trimLiveFigures

Methods inherited from class ptolemy.vergil.icon.EditorIcon

_createDefaultBackgroundFigure, _isPropertySet, getContainerOrContainerToBe, setContainerToBe

Methods inherited from class ptolemy.kernel.util.Attribute

_checkContainer, _getContainedObject, _propagateExistence, getContainer, moveDown, moveToFirst, moveToIndex, moveToLast, moveUp, setContainer, setName, updateContent

Methods inherited from class ptolemy.kernel.util.NamedObj

_addAttribute, _adjustOverride, _attachText, _cloneFixAttributeFields, _debug, _debug, _debug, _debug, _debug, _exportMoMLContents, _getIndentPrefix, _isMoMLSuppressed, _markContentsDerived, _propagateValue, _recordDecoratedAttributes, _removeAttribute, _splitName, _stripNumericSuffix, _validateSettables, addChangeListener, addDebugListener, attributeChanged, attributeList, attributeList, attributeTypeChanged, clone, containedObjectsIterator, deepContains, depthInHierarchy, description, description, event, executeChangeRequests, exportMoML, exportMoML, exportMoML, exportMoML, exportMoML, exportMoMLPlain, getAttribute, getAttribute, getAttributes, getChangeListeners, getClassName, getDecoratorAttribute, getDecoratorAttributes, getDerivedLevel, getDerivedList, getDisplayName, getElementName, getFullName, getModelErrorHandler, getName, getName, getPrototypeList, getSource, handleModelError, isDeferringChangeRequests, isOverridden, isPersistent, lazyContainedObjectsIterator, message, propagateExistence, propagateValue, propagateValues, removeChangeListener, removeDebugListener, requestChange, setClassName, setDeferringChangeRequests, setDerivedLevel, setDisplayName, setModelErrorHandler, setPersistent, setSource, sortContainedObjects, toplevel, uniqueName, validateSettables, workspace

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

boxColor

public ColorAttribute boxColor

Color of the box. This defaults to white.

Constructor Detail

BoxedValueIcon

public BoxedValueIcon(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.