ptolemy.actor.gui.properties
Class Button

java.lang.Object
  ptolemy.kernel.util.NamedObj
      ptolemy.kernel.util.Attribute
          ptolemy.actor.gui.properties.GUIProperty
              ptolemy.actor.gui.properties.ActionGUIProperty
                  ptolemy.actor.gui.properties.Button

All Implemented Interfaces:

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

public class Button
extends ActionGUIProperty

A GUI property that encloses a JButton component.

Since:

Ptolemy II 8.0

Version:

$Id: Button.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

FileParameter	icon Icon for the button.
StringParameter	tooltip Tooltip for the button.

Fields inherited from class ptolemy.actor.gui.properties.ActionGUIProperty

_action, parse

Fields inherited from class ptolemy.actor.gui.properties.GUIProperty

preferredSize

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

Button(NamedObj container, java.lang.String name)
Construct a GUI property with the given name contained by the specified entity.

Method Summary

protected javax.swing.JComponent	_createComponent() Create a new Java Swing component.
void	attributeChanged(Attribute attribute) React to a change in an attribute.
void	setDisplayName(java.lang.String name) Set a name to present to the user.

Methods inherited from class ptolemy.actor.gui.properties.ActionGUIProperty

_createAction, configure, getConfigureSource, getConfigureText, perform

Methods inherited from class ptolemy.actor.gui.properties.GUIProperty

getComponent, setContainer

Methods inherited from class ptolemy.kernel.util.Attribute

_checkContainer, _getContainedObject, _propagateExistence, clone, getContainer, moveDown, moveToFirst, moveToIndex, moveToLast, moveUp, 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, 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

icon

public FileParameter icon

Icon for the button. Set an empty string to remove the icon.

tooltip

public StringParameter tooltip

Tooltip for the button.

Constructor Detail

Button

public Button(NamedObj container,
              java.lang.String name)
       throws IllegalActionException,
              NameDuplicationException

Construct a GUI property with the given name contained by the specified entity. 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

setDisplayName

public void setDisplayName(java.lang.String name)

Set a name to present to the user.

Overrides:

setDisplayName in class NamedObj

Parameters:

name - A name to present to the user.

See Also:

NamedObj.getDisplayName()

attributeChanged

public void attributeChanged(Attribute attribute)
                      throws IllegalActionException

React to a change in an attribute. This method is called by a contained attribute when its value changes. If the changed attribute is GUIProperty.preferredSize, then the preferred size of the Swing component in this GUI property is adjusted accordingly.

Overrides:

attributeChanged in class GUIProperty

Parameters:

attribute - The attribute that changed.

Throws:

IllegalActionException - If the change is not acceptable to this container (not thrown in this base class).

_createComponent

protected javax.swing.JComponent _createComponent()
                                           throws IllegalActionException

Create a new Java Swing component.

Specified by:

_createComponent in class GUIProperty

Returns:

A Swing component that can be enclosed in this GUI property.

Throws:

IllegalActionException - Not thrown in this base class.