ptolemy.vergil.kernel.attributes

Class ArcAttribute

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

ptolemy.vergil.kernel.attributes.ArcAttribute

All Implemented Interfaces:

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

public class ArcAttribute
extends FilledShapeAttribute

This is an attribute that is rendered as an ellipse. Unlike the base class, by default, an ellipse is centered on its origin.

Since:

Ptolemy II 10.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
Parameter	extent The angular extent of the angle of the arc in degrees.
Parameter	start The starting angle of the arc in degrees.
StringParameter	type The type of the arc, which should be one of "chord", "open", or "pie".

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

_centeredValue, _heightValue, _inAttributeChanged, _widthValue, centered, fillColor, height, width

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

_icon, _none, dashArray, lineColor, lineWidth, rotation

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
ArcAttribute(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 a circle.
protected java.awt.Shape	_newShape() Return the a new ellipse given a new width and height.
void	attributeChanged(Attribute attribute) React to changes in attribute values.
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

extent

public Parameter extent

The angular extent of the angle of the arc in degrees. This is a double that defaults to 90.0.

start

public Parameter start

The starting angle of the arc in degrees. This is a double that defaults to 0.0.

type

public StringParameter type

The type of the arc, which should be one of "chord", "open", or "pie". The default is "pie".

Constructor Detail

ArcAttribute

public ArcAttribute(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 changes in attribute values.

Overrides:

attributeChanged in class FilledShapeAttribute

Parameters:

attribute - The attribute that changed.

Throws:

IllegalActionException - If thrown while getting the value of an attribute.

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 FilledShapeAttribute

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 a circle.

Overrides:

_getDefaultShape in class ShapeAttribute

Returns:

A Circle.

_newShape

protected java.awt.Shape _newShape()

Return the a new ellipse given a new width and height.

Specified by:

_newShape in class FilledShapeAttribute

Returns:

A new shape.