ptolemy.vergil.kernel.attributes
Class TextAttribute

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

public class TextAttribute
extends Attribute

This is an attribute that is rendered as text annotation.

Since:
Ptolemy II 4.0
Version:
$Id: TextAttribute.java,v 1.10 2004/05/06 03:46:43 eal Exp $
Author:
Edward A. Lee
See Also:
Serialized Form
Accepted Rating:
Red (cxh)
Proposed Rating:
Yellow (eal)

Nested Class Summary
 
Nested classes inherited from class ptolemy.kernel.util.NamedObj
NamedObj.ContainedObjectsIterator
 
Field Summary
protected  TextIcon _icon
          The text icon.
 Parameter bold
          A boolean indicating whether the font should be bold.
 StringParameter fontFamily
          The font family.
 Parameter italic
          A boolean indicating whether the font should be italic.
 StringAttribute text
          The text.
 ColorAttribute textColor
          The text color.
 Parameter textSize
          The text size.
 
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
TextAttribute(NamedObj container, java.lang.String name)
          Construct an attribute with the given name contained by the specified container.
 
Method Summary
 void attributeChanged(Attribute attribute)
          React to a changes in the attributes by changing the icon.
 java.lang.Object clone(Workspace workspace)
          Clone the object into the specified workspace.
 
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, attributeList, attributeList, attributeTypeChanged, clone, containedObjectsIterator, deepContains, depthInHierarchy, description, description, event, executeChangeRequests, exportMoML, 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
 

Field Detail

bold

public Parameter bold
A boolean indicating whether the font should be bold. This defaults to false.


fontFamily

public StringParameter fontFamily
The font family. This is a string that defaults to "SansSerif".


italic

public Parameter italic
A boolean indicating whether the font should be italic. This defaults to false.


text

public StringAttribute text
The text. This is a string that defaults to "Double click to edit text."


textColor

public ColorAttribute textColor
The text color. This is a string representing an array with four elements, red, green, blue, and alpha, where alpha is transparency. The default is "{0.0, 0.0, 0.0, 1.0}", which represents an opaque black.


textSize

public Parameter textSize
The text size. This is an int that defaults to 14.


_icon

protected TextIcon _icon
The text icon.

Constructor Detail

TextAttribute

public TextAttribute(NamedObj container,
                     java.lang.String name)
              throws IllegalActionException,
                     NameDuplicationException
Construct an attribute with the given name contained by the specified container. The container argument must not be null, or a NullPointerException will be thrown. This attribute will use the workspace of the container for synchronization and version counts. If the name argument is null, then the name is set to the empty string. Increment the version of the workspace.

Parameters:
container - The container.
name - The name of this attribute.
Throws:
IllegalActionException - If the attribute is not of an acceptable class for the container, or if the name contains a period.
NameDuplicationException - If the name coincides with an attribute already in the container.
Method Detail

attributeChanged

public void attributeChanged(Attribute attribute)
                      throws IllegalActionException
React to a changes in the attributes by changing the icon.

Overrides:
attributeChanged in class NamedObj
Parameters:
attribute - The attribute that changed.
Throws:
IllegalActionException - If the change is not acceptable to this container (should not be thrown).

clone

public java.lang.Object clone(Workspace workspace)
                       throws java.lang.CloneNotSupportedException
Clone the object into the specified workspace.

Overrides:
clone in class Attribute
Parameters:
workspace - The workspace for the new object.
Returns:
A new TextAttribute.
Throws:
java.lang.CloneNotSupportedException - If any of the attributes cannot be cloned.