ptolemy.vergil.kernel.attributes
Class ArrowAttribute

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.LineAttribute
                      ptolemy.vergil.kernel.attributes.ArrowAttribute

All Implemented Interfaces:

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

public class ArrowAttribute
extends LineAttribute

An attribute shown as an arrow. The length and width of the arrow head can be set with the arrowLength and arrowWidth parameters.

Since:

Ptolemy II 8.0

Version:

$Id: ArrowAttribute.java 57044 2010-01-27 22:41:05Z cxh $

Author:

Thomas Huining Feng

See Also:

Serialized Form

Accepted Rating:

Red (tfeng)

Proposed Rating:

Red (tfeng)

Nested Class Summary

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

NamedObj.ContainedObjectsIterator

Field Summary

Parameter	arrowLength Length of the arrow head.
Parameter	arrowWidth Width of the arrow head.

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

x, y

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, _elementName, _isPersistent, _verbose, _workspace, ATTRIBUTES, CLASSNAME, COMPLETE, CONTENTS, DEEP, FULLNAME, LINKS

Constructor Summary

ArrowAttribute(NamedObj container, java.lang.String name)
Construct an attribute with the given name contained by the specified container.

Method Summary

private static java.awt.Shape	_createArrow(double x, double y, double arrowLength, double arrowWidth) Create an arrow with the given x, y, arrow length and arrow width values.
java.awt.Shape	_getDefaultShape() Return a default arrow.
void	attributeChanged(Attribute attribute) React to a changes in the attributes by changing the icon.

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

clone

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, _debug, _debug, _debug, _debug, _debug, _description, _exportMoMLContents, _getIndentPrefix, _isMoMLSuppressed, _markContentsDerived, _propagateValue, _recordDecoratedAttributes, _removeAttribute, _splitName, _stripNumericSuffix, _validateSettables, addChangeListener, addDebugListener, attributeList, attributeList, attributeTypeChanged, clone, containedObjectsIterator, 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, propagateExistence, propagateValue, propagateValues, removeChangeListener, removeDebugListener, 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

arrowLength

public Parameter arrowLength

Length of the arrow head. Default to 16.0

arrowWidth

public Parameter arrowWidth

Width of the arrow head. Default to 10.0.

Constructor Detail

ArrowAttribute

public ArrowAttribute(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

_getDefaultShape

public java.awt.Shape _getDefaultShape()

Return a default arrow.

Overrides:

_getDefaultShape in class LineAttribute

Returns:

An arrow.

attributeChanged

public void attributeChanged(Attribute attribute)
                      throws IllegalActionException

React to a changes in the attributes by changing the icon.

Overrides:

attributeChanged in class LineAttribute

Parameters:

attribute - The attribute that changed.

Throws:

IllegalActionException - If the change is not acceptable to this container (should not be thrown).

_createArrow

private static java.awt.Shape _createArrow(double x,
                                           double y,
                                           double arrowLength,
                                           double arrowWidth)

Create an arrow with the given x, y, arrow length and arrow width values.

Parameters:

x - The x extent.

y - The y extent.

arrowLength - Length of the arrow head.

arrowWidth - Width of the arrow head.

Returns:

An arrow with the given x, y, arrow length and arrow width values.