ptolemy.actor.gui
Class InsideEntityEditorPaneFactory

java.lang.Object
  ptolemy.kernel.util.NamedObj
      ptolemy.kernel.util.Attribute
          ptolemy.actor.gui.EditorPaneFactory
              ptolemy.actor.gui.InsideEntityEditorPaneFactory

All Implemented Interfaces:

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

public class InsideEntityEditorPaneFactory
extends EditorPaneFactory

This is an attribute that can create a pane (called a "configuration widget") for interactively configuring an entity contained by its container. That is, it adds a level of indirection, making it appear as if you were configuring the container, when in fact you are configuring an entity contained by the container. If the container is not an instance of CompositeEntity, or it does not contain any entities, then this behaves just like the base class. If the container contains more than one entity, then only the first one encountered is configured. To use this, place an instance of this class (or a derived class) inside a Ptolemy II object. When the user double clicks on the icon for that object, or selects Configure from the context menu, then a dialog is opened containing the pane returned by createEditorPane().

Since:

Ptolemy II 4.0

Version:

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

Author:

Edward A. Lee

See Also:

Serialized Form

Accepted Rating:

Red (johnr)

Proposed Rating:

Yellow (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, _elementName, _isPersistent, _verbose, _workspace, ATTRIBUTES, CLASSNAME, COMPLETE, CONTENTS, DEEP, FULLNAME, LINKS

Constructor Summary

InsideEntityEditorPaneFactory(NamedObj container, java.lang.String name)
Construct a factory with the specified container and name.

Method Summary

java.awt.Component

createEditorPane() Override the base class to look for an entity contained by the container and return a configurer for that.

Methods inherited from class ptolemy.actor.gui.EditorPaneFactory

createEditorPane, createEditorPane

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, _debug, _debug, _debug, _debug, _debug, _description, _exportMoMLContents, _getIndentPrefix, _isMoMLSuppressed, _markContentsDerived, _propagateValue, _recordDecoratedAttributes, _removeAttribute, _splitName, _stripNumericSuffix, _validateSettables, addChangeListener, addDebugListener, attributeChanged, 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

Constructor Detail

InsideEntityEditorPaneFactory

public InsideEntityEditorPaneFactory(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

createEditorPane

public java.awt.Component createEditorPane()

Override the base class to look for an entity contained by the container and return a configurer for that.

Overrides:

createEditorPane in class EditorPaneFactory

Returns:

A new widget for configuring the container.