Package ptolemy.actor.gui.properties

Class ComboBox

java.lang.Object

ptolemy.kernel.util.NamedObj

ptolemy.kernel.util.Attribute

ptolemy.actor.gui.properties.GUIProperty

ptolemy.actor.gui.properties.ComboBox

All Implemented Interfaces:

java.awt.event.ItemListener, java.lang.Cloneable, java.util.EventListener, Changeable, Debuggable, DebugListener, Derivable, ModelErrorHandler, MoMLExportable, Moveable, Nameable

public class ComboBox
extends GUIProperty
implements java.awt.event.ItemListener

A GUI property that encloses a JComboBox component.

Since:

Ptolemy II 8.0

Version:

$Id$

Author:

Thomas Huining Feng

Pt.AcceptedRating:

Red (tfeng)

Pt.ProposedRating:

Red (tfeng)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ComboBox.Item	The base class for an item that can be added to the combo box as a choice.

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

NamedObj.ContainedObjectsIterator

Field Summary

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

preferredSize

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	Description
ComboBox(NamedObj container, java.lang.String name)	Construct a GUI property with the given name contained by the specified entity.
ComboBox(NamedObj container, java.lang.String name, java.lang.Object constraint)	Construct a GUI property with the given name contained by the specified entity with the given layout constraint.
ComboBox(NamedObj container, java.lang.String name, javax.swing.JComponent component)	Construct a GUI property with the given name contained by the specified entity with the given Java Swing component.
ComboBox(NamedObj container, java.lang.String name, javax.swing.JComponent component, java.lang.Object constraint)	Construct a GUI property with the given name contained by the specified entity with the given Java Swing component and the given layout constraint.

Method Summary

Modifier and Type	Method	Description
protected javax.swing.JComponent	_createComponent()	Create a new JComboBox component.
void	itemStateChanged(java.awt.event.ItemEvent event)	React to an action of changing the selected item in the combo box.

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

attributeChanged, clone, getComponent, setContainer

Methods inherited from class ptolemy.kernel.util.Attribute

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

Constructor Detail

ComboBox

public ComboBox(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.

ComboBox

public ComboBox(NamedObj container,
                java.lang.String name,
                javax.swing.JComponent component)
         throws IllegalActionException,
                NameDuplicationException

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

component - The Java Swing component.

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.

ComboBox

public ComboBox(NamedObj container,
                java.lang.String name,
                javax.swing.JComponent component,
                java.lang.Object constraint)
         throws IllegalActionException,
                NameDuplicationException

Construct a GUI property with the given name contained by the specified entity with the given Java Swing component and the given layout constraint. 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.

component - The Java Swing component.

constraint - The layout constraint.

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.

ComboBox

public ComboBox(NamedObj container,
                java.lang.String name,
                java.lang.Object constraint)
         throws IllegalActionException,
                NameDuplicationException

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

constraint - The layout constraint.

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

itemStateChanged

public void itemStateChanged(java.awt.event.ItemEvent event)

React to an action of changing the selected item in the combo box. The item must be an instance of ComboBox.Item and when it is selected, the ActionGUIProperty.perform() method is invoked. After that, if the item specifies the next item to be selected in its ComboBox.Item.next attribute, that next item is selected, which may cause this method to be invoked again.

Specified by:

itemStateChanged in interface java.awt.event.ItemListener

Parameters:

event - The item event representing which item is selected.

_createComponent

protected javax.swing.JComponent _createComponent()
                                           throws IllegalActionException

Create a new JComboBox 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.