ptolemy.actor.gui
Class DialogTableau

java.lang.Object
  extended byptolemy.kernel.util.NamedObj
      extended byptolemy.kernel.InstantiableNamedObj
          extended byptolemy.kernel.Entity
              extended byptolemy.kernel.ComponentEntity
                  extended byptolemy.kernel.CompositeEntity
                      extended byptolemy.actor.gui.Tableau
                          extended byptolemy.actor.gui.DialogTableau
All Implemented Interfaces:
Changeable, java.lang.Cloneable, Debuggable, DebugListener, Derivable, Instantiable, ModelErrorHandler, MoMLExportable, Nameable, java.io.Serializable

public class DialogTableau
extends Tableau

A tableau representing a Dialog in a toplevel window.

DialogTableau is just like all the other XXXTableau classes except that the Frame associated with DialogTableau is not an extension of TableauFrame, and, ultimately, the Top class. The reason being that Top adorns the GUI manifestation with the normal status bar which isn't appropriate for a dialog. In addition, the created dialog is not a JDialog, but a JFrame. And, the created dialog is non-modal.

There can be any number of instances of this class in an effigy, however, there can only be one each for the model represented by the effigy, and one each of the actors that are part of the model.

Since:
Ptolemy II 4.0
Version:
$Id: DialogTableau.java,v 1.19 2004/04/15 19:10:54 rowland Exp $
Author:
Rowland R Johnson
See Also:
Effigy, Serialized Form
Accepted Rating:
Red (cxh)
Proposed Rating:
Red (rowland)

Nested Class Summary
 
Nested classes inherited from class ptolemy.kernel.CompositeEntity
CompositeEntity.ContainedObjectsIterator
 
Field Summary
 
Fields inherited from class ptolemy.actor.gui.Tableau
size
 
Fields inherited from class ptolemy.kernel.util.NamedObj
_changeListeners, _changeLock, _changeRequests, _debugging, _debugListeners, _elementName, _isPersistent, _workspace, ATTRIBUTES, CLASSNAME, COMPLETE, CONTENTS, DEEP, FULLNAME, LINKS
 
Constructor Summary
DialogTableau(Effigy container, java.lang.String name)
          Construct a new tableau for the model represented by the given effigy.
 
Method Summary
static DialogTableau createDialog(java.awt.Frame parent, Configuration configuration, Effigy effigy, java.lang.Class dialogClass, Entity target)
          Create a tableau for the specified dialog.
 Entity getTarget()
          Get the target associated with this DialogTableau.
 boolean hasTarget(Entity entity)
          Determines if a particular Entity is associated with this DialogTableau
 
Methods inherited from class ptolemy.actor.gui.Tableau
attributeChanged, clone, close, getFrame, getTitle, isEditable, isMaster, setContainer, setEditable, setFrame, setMaster, setTitle, show
 
Methods inherited from class ptolemy.kernel.CompositeEntity
_addEntity, _addRelation, _adjustDeferrals, _description, _exportMoMLContents, _finishedAddEntity, _removeEntity, _removeRelation, allAtomicEntityList, allowLevelCrossingConnect, classDefinitionList, connect, connect, containedObjectsIterator, deepEntityList, deepGetEntities, entityList, entityList, exportLinks, getAttribute, getEntities, getEntity, getPort, getRelation, getRelations, isAtomic, isOpaque, newRelation, numberOfClassDefinitions, numberOfEntities, numberOfRelations, numEntities, numRelations, relationList, removeAllEntities, removeAllRelations, uniqueName, validateSettables
 
Methods inherited from class ptolemy.kernel.ComponentEntity
_addPort, _checkContainer, _getContainedObject, _propagateExistence, getContainer, instantiate, newPort, propagateExistence, setName
 
Methods inherited from class ptolemy.kernel.Entity
_removePort, connectedPortList, connectedPorts, connectionsChanged, getPorts, linkedRelationList, linkedRelations, portList, removeAllPorts, setClassDefinition
 
Methods inherited from class ptolemy.kernel.InstantiableNamedObj
_setParent, exportMoML, getChildren, getElementName, getParent, getPrototypeList, isClassDefinition
 
Methods inherited from class ptolemy.kernel.util.NamedObj
_addAttribute, _attachText, _cloneFixAttributeFields, _debug, _debug, _debug, _debug, _debug, _getIndentPrefix, _isMoMLSuppressed, _markContentsDerived, _propagateValue, _removeAttribute, _splitName, _stripNumericSuffix, addChangeListener, addDebugListener, attributeList, attributeList, attributeTypeChanged, clone, deepContains, depthInHierarchy, description, description, event, executeChangeRequests, exportMoML, exportMoML, exportMoML, exportMoML, getAttribute, getAttributes, getChangeListeners, getClassName, getDerivedLevel, getDerivedList, getFullName, getModelErrorHandler, getName, getName, getSource, handleModelError, isDeferringChangeRequests, isOverridden, isPersistent, message, propagateValue, propagateValues, removeChangeListener, removeDebugListener, requestChange, setClassName, setDeferringChangeRequests, setDerivedLevel, setModelErrorHandler, setPersistent, setSource, toplevel, toString, workspace
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface ptolemy.kernel.util.Derivable
getDerivedLevel, getDerivedList, propagateValue
 
Methods inherited from interface ptolemy.kernel.util.Nameable
description, getFullName, getName, getName
 

Constructor Detail

DialogTableau

public DialogTableau(Effigy container,
                     java.lang.String name)
              throws IllegalActionException,
                     NameDuplicationException
Construct a new tableau for the model represented by the given effigy. Use setFrame() to specify the Dialog after construction.

Parameters:
container - The container.
name - The name.
Throws:
IllegalActionException - If the container does not accept this entity (this should not occur).
NameDuplicationException - If the name coincides with an attribute already in the container.
Method Detail

createDialog

public static DialogTableau createDialog(java.awt.Frame parent,
                                         Configuration configuration,
                                         Effigy effigy,
                                         java.lang.Class dialogClass,
                                         Entity target)
Create a tableau for the specified dialog. First look to see if a dialog already exists. If so, then just return that one.

Parameters:
parent - The Frame parent
configuration - The configuration
effigy - The Effigy containing the model that needs a dialog.
dialogClass - The Dialog class to create.
target - The entity that needs the Dialog
Returns:
DialogTableau

getTarget

public Entity getTarget()
Get the target associated with this DialogTableau. Actually, the target is associated with the frame that is associated with this DialogTableau.

Returns:
target The Entity that this DialogTableau is associated with.

hasTarget

public boolean hasTarget(Entity entity)
Determines if a particular Entity is associated with this DialogTableau

Parameters:
entity - Entity that test is performed on.,
Returns:
true/false True if entity is associated with this DialogTableau.