ptolemy.vergil.kernel.attributes
Class LineAttribute

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

All Implemented Interfaces:

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

Direct Known Subclasses:

ArrowAttribute

public class LineAttribute
extends ShapeAttribute

This is an attribute that is rendered as a line.

This contains two parameters, x and y, which control the run and rise, respectively, of the line. Note that the origin is in the upper-left hand corner, so positive x values will extend to the right, and positive y values will extend downwards on the screen.

Since:

Ptolemy II 4.0

Version:

$Id: LineAttribute.java 57040 2010-01-27 20:52:32Z cxh $

Author:

Edward A. Lee

See Also:

Serialized Form

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

Parameter	x The horizontal extent.
Parameter	y The y 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, _elementName, _isPersistent, _verbose, _workspace, ATTRIBUTES, CLASSNAME, COMPLETE, CONTENTS, DEEP, FULLNAME, LINKS

Constructor Summary

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

Method Summary

java.awt.Shape	_getDefaultShape() Return a line.
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

x

public Parameter x

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

y

public Parameter y

The y extent. This is a double that defaults to 0.0.

Constructor Detail

LineAttribute

public LineAttribute(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).

_getDefaultShape

public java.awt.Shape _getDefaultShape()

Return a line.

Overrides:

_getDefaultShape in class ShapeAttribute

Returns:

A line.