ptolemy.vergil.kernel.attributes

Class FilledShapeAttribute

java.lang.Object

ptolemy.kernel.util.NamedObj

ptolemy.kernel.util.Attribute

ptolemy.vergil.kernel.attributes.VisibleAttribute

ptolemy.vergil.kernel.attributes.ShapeAttribute

ptolemy.vergil.kernel.attributes.FilledShapeAttribute

All Implemented Interfaces:

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

Direct Known Subclasses:

ArcAttribute, EllipseAttribute, RectangleAttribute, ResizablePolygonAttribute

public abstract class FilledShapeAttribute
extends ShapeAttribute

This is an abstract attribute that is rendered as a filled shape. Concrete subclasses produce particular shapes, such as rectangles and circles. Derived classes need to react to changes in the width and height parameters in the attributeChanged() method by calling setShape() on the protected member _icon.

Since:

Ptolemy II 4.0

Version:

$Id: FilledShapeAttribute.java 70398 2014-10-22 23:44:32Z cxh $

Author:

Edward A. Lee

Accepted Rating:

Red (cxh)

Proposed Rating:

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 boolean	_centeredValue Most recently set value of the centered parameter.
protected double	_heightValue Most recently set value of the height parameter.
protected boolean	_inAttributeChanged Variable used to prevent re-entry into attributeChanged().
protected double	_widthValue Most recently set value of the width parameter.
Parameter	centered Indicator of whether the shape should be centered on the location.
ColorAttribute	fillColor The line color.
Parameter	height The vertical extent.
Parameter	width The horizontal extent.

Fields inherited from class ptolemy.vergil.kernel.attributes.ShapeAttribute

_icon, _none, dashArray, lineColor, lineWidth

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
FilledShapeAttribute(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 abstract java.awt.Shape	_newShape() Return the a new shape given a new width and height.
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.ShapeAttribute

_getDefaultShape

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

centered

public Parameter centered

Indicator of whether the shape should be centered on the location. This is a boolean that defaults to false, which means that the location is the upper left corner.

fillColor

public ColorAttribute fillColor

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.

height

public Parameter height

The vertical extent. This is a double that defaults to 100.0.

width

public Parameter width

The horizontal extent. This is a double that defaults to 100.0.

_centeredValue

protected boolean _centeredValue

Most recently set value of the centered parameter.

_heightValue

protected double _heightValue

Most recently set value of the height parameter.

_inAttributeChanged

protected transient boolean _inAttributeChanged

Variable used to prevent re-entry into attributeChanged().

_widthValue

protected double _widthValue

Most recently set value of the width parameter.

Constructor Detail

FilledShapeAttribute

public FilledShapeAttribute(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 ShapeAttribute

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 ShapeAttribute

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)

_newShape

protected abstract java.awt.Shape _newShape()

Return the a new shape given a new width and height. This class guarantees that the protected variables _centeredValue, _widthValue, and _heightValue are up to date when this method is called. Derived classes should override this to return an appropriate shape.

Returns:

A new shape.