org.kepler.gui.frame

Class MultiCompositeTableau

java.lang.Object

ptolemy.kernel.util.NamedObj

ptolemy.kernel.InstantiableNamedObj

ptolemy.kernel.Entity<T>

ptolemy.kernel.ComponentEntity

ptolemy.kernel.CompositeEntity

ptolemy.actor.gui.Tableau

org.kepler.gui.frame.KeplerGraphTableau

org.kepler.gui.frame.TabbedKeplerGraphTableau

org.kepler.gui.frame.MultiCompositeTableau

All Implemented Interfaces:

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

Direct Known Subclasses:

CaseGraphTableau, ExecutionChoiceGraphTableau

public abstract class MultiCompositeTableau
extends TabbedKeplerGraphTableau
implements StateChangeListener

An editor tableau for MultiCompositeActors.

Author:

Daniel Crawl, Possibly based on CaseGraphTableau by Edward A. Lee.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	MultiCompositeTableau.AddRefinementAction Class implementing the Add Refinement menu command.
class	MultiCompositeTableau.RemoveRefinementAction Class implementing the Remove Refinement menu command.

Nested classes/interfaces inherited from class org.kepler.gui.frame.TabbedKeplerGraphTableau

TabbedKeplerGraphTableau.Factory

Nested classes/interfaces inherited from class ptolemy.kernel.CompositeEntity

CompositeEntity.ContainedObjectsIterator

Field Summary

Fields

Modifier and Type	Field and Description
protected TabbedKeplerGraphFrame	_frame The frame displaying the MultiCompositeActor.

Fields inherited from class org.kepler.gui.frame.TabbedKeplerGraphTableau

_createdNewFrame

Fields inherited from class ptolemy.actor.gui.Tableau

_debugClosing, size

Fields inherited from class ptolemy.kernel.CompositeEntity

_levelCrossingLinks

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 and Description
MultiCompositeTableau(PtolemyEffigy container, java.lang.String name) Create a new multicomposite editor tableau with the specified container and name.
MultiCompositeTableau(PtolemyEffigy container, java.lang.String name, LibraryAttribute defaultLibrary) Create a new multicomposite editor tableau with the specified container, name, and default library.

Method Summary

Modifier and Type	Method and Description
protected void	_configureFrame(TabbedKeplerGraphFrame frame, CompositeEntity model) Configure the frame for the opened multi composite model.
protected void	_multiCompositeSelected(boolean isSelected) This method is called whenever the tab containing the MultiCompositeActor is selected or unselected in the frame.
java.lang.Object	clone(Workspace workspace) Clone the object into the specified workspace.
void	createGraphFrame(CompositeEntity model, LibraryAttribute defaultLibrary) Create the graph frame that displays the model associated with this tableau together with the specified library.
void	handleStateChange(StateChangeEvent event) React to changes in the selected tab in a TabbedKeplerGraphFrame.
void	setContainer(CompositeEntity container) Set the container for this tableau.

Methods inherited from class org.kepler.gui.frame.TabbedKeplerGraphTableau

_addCompositeToExistingFrame, createGraphFrame, show

Methods inherited from class ptolemy.actor.gui.Tableau

attributeChanged, close, getFrame, getTitle, isEditable, isMaster, setEditable, setFrame, setMaster, setTitle

Methods inherited from class ptolemy.kernel.CompositeEntity

_addEntity, _addRelation, _adjustDeferrals, _containedDecorators, _deepOpaqueEntityList, _description, _exportMoMLContents, _finishedAddEntity, _removeEntity, _removeRelation, _validateSettables, allAtomicEntityList, allowLevelCrossingConnect, classDefinitionList, connect, connect, containedObjectsIterator, deepCompositeEntityList, deepEntityList, deepGetEntities, deepNamedObjList, deepOpaqueEntityList, deepRelationSet, entityList, entityList, exportLinks, exportMoML, getAttribute, getEntities, getEntity, getPort, getRelation, getRelations, isAtomic, isOpaque, lazyAllAtomicEntityList, lazyAllCompositeEntityList, lazyAllCompositeTransparentAndOpaqueEntityList, lazyClassDefinitionList, lazyDeepEntityList, lazyEntityList, lazyRelationList, newRelation, numberOfEntities, numberOfRelations, numEntities, numRelations, relationList, removeAllEntities, removeAllRelations, setClassDefinition, statistics, uniqueName

Methods inherited from class ptolemy.kernel.ComponentEntity

_checkContainer, _getContainedObject, _propagateExistence, getContainer, instantiate, moveDown, moveToFirst, moveToIndex, moveToLast, moveUp, newPort, propagateExistence, setName

Methods inherited from class ptolemy.kernel.Entity

_addPort, _removePort, connectedPortList, connectedPorts, connectionsChanged, getPorts, linkedRelationList, linkedRelations, portList, removeAllPorts

Methods inherited from class ptolemy.kernel.InstantiableNamedObj

_setParent, getChildren, getElementName, getParent, getPrototypeList, isClassDefinition, isWithinClassDefinition

Methods inherited from class ptolemy.kernel.util.NamedObj

_addAttribute, _adjustOverride, _attachText, _cloneFixAttributeFields, _copyChangeRequestList, _debug, _debug, _debug, _debug, _debug, _executeChangeRequests, _getIndentPrefix, _isMoMLSuppressed, _markContentsDerived, _notifyHierarchyListenersAfterChange, _notifyHierarchyListenersBeforeChange, _propagateValue, _removeAttribute, _splitName, _stripNumericSuffix, addChangeListener, addDebugListener, addHierarchyListener, attributeDeleted, attributeList, attributeList, attributeTypeChanged, clone, decorators, deepContains, depthInHierarchy, description, description, event, executeChangeRequests, exportMoML, exportMoML, exportMoML, exportMoML, exportMoMLPlain, getAttribute, getAttributes, getChangeListeners, getClassName, getDecoratorAttribute, getDecoratorAttributes, getDerivedLevel, getDerivedList, getDisplayName, getFullName, getModelErrorHandler, getName, getName, getSource, handleModelError, isDeferringChangeRequests, isOverridden, isPersistent, lazyContainedObjectsIterator, message, notifyOfNameChange, propagateValue, propagateValues, removeAttribute, removeChangeListener, removeDebugListener, removeHierarchyListener, requestChange, setClassName, setDeferringChangeRequests, setDerivedLevel, setDisplayName, setModelErrorHandler, setPersistent, setSource, sortContainedObjects, toplevel, toString, validateSettables, 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, getDisplayName, getFullName, getName, getName

Field Detail

_frame

protected TabbedKeplerGraphFrame _frame

The frame displaying the MultiCompositeActor.

Constructor Detail

MultiCompositeTableau

public MultiCompositeTableau(PtolemyEffigy container,
                             java.lang.String name)
                      throws IllegalActionException,
                             NameDuplicationException

Create a new multicomposite editor tableau with the specified container and name.

Parameters:

container - The container.

name - The name.

Throws:

IllegalActionException - If the model associated with the container effigy is not an instance of CompositeEntity.

NameDuplicationException - If the container already contains an object with the specified name.

MultiCompositeTableau

public MultiCompositeTableau(PtolemyEffigy container,
                             java.lang.String name,
                             LibraryAttribute defaultLibrary)
                      throws IllegalActionException,
                             NameDuplicationException

Create a new multicomposite editor tableau with the specified container, name, and default library.

Parameters:

container - The container.

name - The name.

defaultLibrary - The default library, or null to not specify one.

Throws:

IllegalActionException - If the model associated with the container effigy is not an instance of CompositeEntity.

NameDuplicationException - If the container already contains an object with the specified name.

Method Detail

clone

public java.lang.Object clone(Workspace workspace)
                       throws java.lang.CloneNotSupportedException

Clone the object into the specified workspace.

Overrides:

clone in class Tableau

Parameters:

workspace - The workspace for the new object.

Returns:

A new object.

Throws:

java.lang.CloneNotSupportedException - If a derived class contains an attribute that cannot be cloned.

See Also:

NamedObj.exportMoML(Writer, int, String), NamedObj.setDeferringChangeRequests(boolean)

createGraphFrame

public void createGraphFrame(CompositeEntity model,
                             LibraryAttribute defaultLibrary)

Description copied from class: TabbedKeplerGraphTableau

Create the graph frame that displays the model associated with this tableau together with the specified library.

Overrides:

createGraphFrame in class TabbedKeplerGraphTableau

Parameters:

model - The Ptolemy II model to display in the graph frame.

defaultLibrary - The default library, or null to not specify one.

handleStateChange

public void handleStateChange(StateChangeEvent event)

React to changes in the selected tab in a TabbedKeplerGraphFrame.

Specified by:

handleStateChange in interface StateChangeListener

Parameters:

event - the StateChangeEvent indicating what state changed

setContainer

public void setContainer(CompositeEntity container)
                  throws IllegalActionException,
                         NameDuplicationException

Set the container for this tableau. If the tab for the MultiCompositeActor is closed, the container will be null. In this case, stop listening for tab changes, and the tab for the MultiCompositeActor is no longer selected.

Overrides:

setContainer in class TabbedKeplerGraphTableau

Parameters:

container - The container to attach this attribute to.

Throws:

IllegalActionException - If the proposed container is not an instance of Effigy, or if this attribute is not of the expected class for the container, or it has no name, or the attribute and container are not in the same workspace, or the proposed container would result in recursive containment.

NameDuplicationException - If the container already has an attribute with the name of this attribute.

See Also:

ComponentEntity.getContainer()

_configureFrame

protected void _configureFrame(TabbedKeplerGraphFrame frame,
                               CompositeEntity model)

Configure the frame for the opened multi composite model.

Overrides:

_configureFrame in class TabbedKeplerGraphTableau

_multiCompositeSelected

protected void _multiCompositeSelected(boolean isSelected)

This method is called whenever the tab containing the MultiCompositeActor is selected or unselected in the frame.