ptolemy.homer.kernel

Class AttributeElement

java.lang.Object

ptolemy.homer.kernel.PositionableElement

ptolemy.homer.kernel.AttributeElement

public class AttributeElement
extends PositionableElement

The definition of attributes.

Since:

Ptolemy II 10.0

Version:

$Id$

Author:

Peter Foldes

Pt.AcceptedRating:

Red (pdf)

Pt.ProposedRating:

Red (pdf)

Constructor Summary

Constructors

Constructor and Description
AttributeElement(Attribute attribute) Parse the Ptolemy attribute element.

Method Summary

Modifier and Type	Method and Description
void	addListener(ValueListener listener) Attach a value listener to the underlying attribute.
void	addToContainer(PortableContainer container) Add the visual representation of the element to the provided container.
void	changeStyle(ParameterEditorStyle style) Change the style of the parameter to a new style.
void	removeListener(ValueListener listener) Remove a value listener from the underlying attribute.

Methods inherited from class ptolemy.homer.kernel.PositionableElement

getElement, getLocation, getTab, setLocation, setTab

Methods inherited from class java.lang.Object

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

Constructor Detail

AttributeElement

public AttributeElement(Attribute attribute)
                 throws IllegalActionException

Parse the Ptolemy attribute element.

Parameters:

attribute - The Ptolemy attribute element to be parsed.

Throws:

IllegalActionException - If the attribute is not settable.

Method Detail

addListener

public void addListener(ValueListener listener)

Attach a value listener to the underlying attribute.

Parameters:

listener - The listener to attach.

addToContainer

public void addToContainer(PortableContainer container)
                    throws IllegalActionException

Add the visual representation of the element to the provided container.

Specified by:

addToContainer in class PositionableElement

Parameters:

container - The container for the element to be placed in.

Throws:

IllegalActionException - If the element cannot be added to the container.

changeStyle

public void changeStyle(ParameterEditorStyle style)
                 throws IllegalActionException

Change the style of the parameter to a new style. Note: It will remove the style of the element even if there is something wrong with the new style.

Parameters:

style - The new style to be used by the attribute.

Throws:

IllegalActionException - If this attribute is not of the expected class for the container, or it has no name, or the attribute and container are not in the same workspace, or the proposed container would result in recursive containment, or the proposed container is not an instance of Settable. Also, if the style name is not the expected name for the style.

removeListener

public void removeListener(ValueListener listener)

Remove a value listener from the underlying attribute.

Parameters:

listener - The listener to remove.

See Also:

addListener(ValueListener)