Package ptolemy.vergil.toolbox

Class VisibleParameterEditorFactory

java.lang.Object

ptolemy.kernel.util.NamedObj

ptolemy.kernel.util.Attribute

ptolemy.actor.gui.EditorFactory

ptolemy.vergil.toolbox.VisibleParameterEditorFactory

All Implemented Interfaces:

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

public class VisibleParameterEditorFactory
extends EditorFactory

If this class is contained by a settable attribute, then double clicking on that attribute will invoke an editor for only that parameter. This is contrary to the the double-click action for most objects, which edits the parameters they contain.. This class is contained by visible parameters in the Vergil utilities library.

Since:

Ptolemy II 2.0

Version:

$Id$

Author:

Steve Neuendorffer

Pt.AcceptedRating:

Red (johnr)

Pt.ProposedRating:

Red (eal)

Nested Class Summary

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

NamedObj.ContainedObjectsIterator

Field Summary

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
VisibleParameterEditorFactory(NamedObj container, java.lang.String name)	Construct a factory with the specified container and name.

Method Summary

Modifier and Type	Method	Description
void	createEditor(NamedObj object, java.awt.Frame parent)	Create an editor for configuring the specified object.
java.awt.Component	createEditorPane()	Return a new widget for configuring the container.

Methods inherited from class ptolemy.actor.gui.EditorFactory

createEditor, createEditor

Methods inherited from class ptolemy.kernel.util.Attribute

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

VisibleParameterEditorFactory

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

Construct a factory with the specified container and name.

Parameters:

container - The container.

name - The name of the factory.

Throws:

IllegalActionException - If the factory is not of an acceptable attribute for the container.

NameDuplicationException - If the name coincides with an attribute already in the container.

Method Detail

createEditor

public void createEditor(NamedObj object,
                         java.awt.Frame parent)

Create an editor for configuring the specified object.

Specified by:

createEditor in interface Editable

Specified by:

createEditor in class EditorFactory

Parameters:

object - The object to configure.

parent - The parent window, or null if there is none.

createEditorPane

public java.awt.Component createEditorPane()

Return a new widget for configuring the container. This class returns a new PtolemyQuery that references the container, assuming that that container is a settable attribute.

Returns:

A new widget for configuring the container.