ptolemy.vergil.icon
Class TextIcon

java.lang.Object
  extended byptolemy.kernel.util.NamedObj
      extended byptolemy.kernel.util.Attribute
          extended byptolemy.vergil.icon.EditorIcon
              extended byptolemy.vergil.icon.DynamicEditorIcon
                  extended byptolemy.vergil.icon.TextIcon
All Implemented Interfaces:
Changeable, java.lang.Cloneable, Debuggable, DebugListener, Derivable, ModelErrorHandler, MoMLExportable, Nameable, java.io.Serializable

public class TextIcon
extends DynamicEditorIcon

An icon that displays specified text.

Since:
Ptolemy II 4.0
Version:
$Id: TextIcon.java,v 1.9 2004/04/13 05:12:54 cxh Exp $
Author:
Edward A. Lee
See Also:
Serialized Form
Accepted Rating:
Red (johnr)
Proposed Rating:
Yellow (eal)

Nested Class Summary
 
Nested classes inherited from class ptolemy.kernel.util.NamedObj
NamedObj.ContainedObjectsIterator
 
Field Summary
 
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, _workspace, ATTRIBUTES, CLASSNAME, COMPLETE, CONTENTS, DEEP, FULLNAME, LINKS
 
Constructor Summary
TextIcon(NamedObj container, java.lang.String name)
          Create a new icon with the given name in the given container.
 
Method Summary
 java.lang.Object clone(Workspace workspace)
          Clone the object into the specified workspace.
 Figure createBackgroundFigure()
          Create a new default background figure, which is the text set by setText, if it has been called, or default text if not.
 javax.swing.Icon createIcon()
          Create a new Swing icon.
 void setFont(java.awt.Font font)
          Specify the font to use.
 void setText(java.lang.String text)
          Specify text to display.
 void setTextColor(java.awt.Color textColor)
          Specify the text color to use.
 
Methods inherited from class ptolemy.vergil.icon.DynamicEditorIcon
_addLiveFigure, _liveFigureIterator, _trimLiveFigures
 
Methods inherited from class ptolemy.vergil.icon.EditorIcon
_createDefaultBackgroundFigure, _recreateFigure, createFigure, exportMoML, getContainerOrContainerToBe, setContainerToBe
 
Methods inherited from class ptolemy.kernel.util.Attribute
_getContainedObject, _propagateExistence, getContainer, setContainer, setName
 
Methods inherited from class ptolemy.kernel.util.NamedObj
_addAttribute, _attachText, _cloneFixAttributeFields, _debug, _debug, _debug, _debug, _debug, _description, _exportMoMLContents, _getIndentPrefix, _isMoMLSuppressed, _markContentsDerived, _propagateValue, _removeAttribute, _splitName, _stripNumericSuffix, addChangeListener, addDebugListener, attributeChanged, attributeList, attributeList, attributeTypeChanged, clone, containedObjectsIterator, deepContains, depthInHierarchy, description, description, event, executeChangeRequests, exportMoML, exportMoML, exportMoML, exportMoML, getAttribute, getAttribute, getAttributes, getChangeListeners, getClassName, getDerivedLevel, getDerivedList, getElementName, getFullName, getModelErrorHandler, getName, getName, getPrototypeList, getSource, handleModelError, isDeferringChangeRequests, isOverridden, isPersistent, message, propagateExistence, propagateValue, propagateValues, removeChangeListener, removeDebugListener, requestChange, setClassName, setDeferringChangeRequests, setDerivedLevel, setModelErrorHandler, setPersistent, setSource, toplevel, toString, uniqueName, validateSettables, workspace
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

TextIcon

public TextIcon(NamedObj container,
                java.lang.String name)
         throws IllegalActionException,
                NameDuplicationException
Create a new icon with the given name in the given container.

Parameters:
container - The container.
name - The name of the attribute.
Throws:
IllegalActionException - If the attribute is not of an acceptable class for the container.
NameDuplicationException - If the name coincides with an attribute already in the container.
Method Detail

clone

public java.lang.Object clone(Workspace workspace)
                       throws java.lang.CloneNotSupportedException
Clone the object into the specified workspace. The new object is not added to the directory of that workspace (you must do this yourself if you want it there). The result is an object with no container.

Overrides:
clone in class DynamicEditorIcon
Parameters:
workspace - The workspace for the cloned object.
Returns:
The new Attribute.
Throws:
java.lang.CloneNotSupportedException - Not thrown in this base class

createBackgroundFigure

public Figure createBackgroundFigure()
Create a new default background figure, which is the text set by setText, if it has been called, or default text if not. This must be called in the Swing thread, or a concurrent modification exception could occur.

Overrides:
createBackgroundFigure in class EditorIcon
Returns:
A figure representing the specified shape.

createIcon

public javax.swing.Icon createIcon()
Create a new Swing icon. This returns an icon with the text "-A-".

Overrides:
createIcon in class EditorIcon
Returns:
A new Swing Icon.

setTextColor

public void setTextColor(java.awt.Color textColor)
Specify the text color to use. This is deferred and executed in the Swing thread.

Parameters:
textColor - The fill color to use.

setFont

public void setFont(java.awt.Font font)
Specify the font to use. This is deferred and executed in the Swing thread.

Parameters:
font - The font to use.

setText

public void setText(java.lang.String text)
Specify text to display. This is deferred and executed in the Swing thread.

Parameters:
text - The text to display.