ptolemy.vergil.kernel.attributes

Class ShapeAttribute

java.lang.Object

ptolemy.kernel.util.NamedObj

ptolemy.kernel.util.Attribute

ptolemy.vergil.kernel.attributes.VisibleAttribute

ptolemy.vergil.kernel.attributes.ShapeAttribute

All Implemented Interfaces:

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

Direct Known Subclasses:

FilledShapeAttribute, LineAttribute

public abstract class ShapeAttribute
extends VisibleAttribute

This is an abstract attribute that is rendered as a shape. This base class provides support for a line width and a line color. The line color can be "none", in which case no line is drawn. Concrete derived classes provide particular shapes.

Since:

Ptolemy II 4.0

Version:

$Id$

Author:

Edward A. Lee

Pt.AcceptedRating:

Red (cxh)

Pt.ProposedRating:

Yellow (eal)

Nested Class Summary

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

NamedObj.ContainedObjectsIterator

Field Summary

Fields

Modifier and Type	Field and Description
protected ShapeIcon	_icon The shape icon.
protected Variable	_none A color parameter whose value is a fully transparent white (alpha = 0.0), which is interpreted as no color.
Parameter	dashArray Specification of the dash pattern for dashed or dotted lines.
ColorAttribute	lineColor The line color.
Parameter	lineWidth The line width.
Parameter	rotation The angle of rotation in radians.

Fields inherited from class ptolemy.kernel.util.NamedObj

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

Constructor Summary

Constructors

Constructor and Description
ShapeAttribute(NamedObj container, java.lang.String name) Construct an attribute with the given name contained by the specified container.

Method Summary

Modifier and Type	Method and Description
protected java.awt.Shape	_getDefaultShape() Return the default shape to use for this icon.
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.vergil.kernel.attributes.VisibleAttribute

moveToFirst, moveToLast

Methods inherited from class ptolemy.kernel.util.Attribute

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

Methods inherited from class ptolemy.kernel.util.NamedObj

_addAttribute, _adjustOverride, _attachText, _cloneFixAttributeFields, _containedDecorators, _copyChangeRequestList, _debug, _debug, _debug, _debug, _debug, _description, _executeChangeRequests, _exportMoMLContents, _getIndentPrefix, _isMoMLSuppressed, _markContentsDerived, _notifyHierarchyListenersAfterChange, _notifyHierarchyListenersBeforeChange, _propagateValue, _removeAttribute, _splitName, _stripNumericSuffix, _validateSettables, addChangeListener, addDebugListener, addHierarchyListener, attributeDeleted, attributeList, attributeList, attributeTypeChanged, clone, containedObjectsIterator, decorators, 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, notifyOfNameChange, propagateExistence, propagateValue, propagateValues, removeAttribute, removeChangeListener, removeDebugListener, removeHierarchyListener, requestChange, setClassName, setDeferringChangeRequests, setDerivedLevel, setDisplayName, setModelErrorHandler, setPersistent, setSource, sortContainedObjects, toplevel, toString, uniqueName, validateSettables, workspace

Methods inherited from class java.lang.Object

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

Field Detail

dashArray

public Parameter dashArray

Specification of the dash pattern for dashed or dotted lines. An empty value indicates that the line should not be dashed. The values specify the length of solid and transparent segments in an alternating fashion. This is an array of doubles that by default is empty.

lineColor

public ColorAttribute lineColor

The line 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.

lineWidth

public Parameter lineWidth

The line width. This is a double that defaults to 1.0.

rotation

public Parameter rotation

The angle of rotation in radians. This is a double that defaults to 0.0.

_icon

protected ShapeIcon _icon

The shape icon.

_none

protected Variable _none

A color parameter whose value is a fully transparent white (alpha = 0.0), which is interpreted as no color.

Constructor Detail

ShapeAttribute

public ShapeAttribute(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. 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 Attribute

Parameters:

workspace - The workspace for the cloned object.

Returns:

The new Attribute.

Throws:

java.lang.CloneNotSupportedException - Not thrown in this base class

See Also:

NamedObj.exportMoML(Writer, int, String), NamedObj.setDeferringChangeRequests(boolean)

_getDefaultShape

protected java.awt.Shape _getDefaultShape()

Return the default shape to use for this icon. Note that this is called in the constructor, so if you override it in derived classed, you cannot access any methods or members of the derived class because they will not have been constructed.

Returns:

The default shape for this attribute.