ptolemy.vergil.tree
Class TreeTableau.Factory

java.lang.Object
  ptolemy.kernel.util.NamedObj
      ptolemy.kernel.util.Attribute
          ptolemy.actor.gui.TableauFactory
              ptolemy.vergil.tree.TreeTableau.Factory

All Implemented Interfaces:

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

Enclosing class:

TreeTableau

public static class TreeTableau.Factory
extends TableauFactory

This is a factory that creates tree-view tableaux for Ptolemy models.

See Also:

Serialized Form

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

TreeTableau.Factory(NamedObj container, java.lang.String name)
Create an factory with the given name and container.

Method Summary

Tableau

createTableau(Effigy effigy) If the effigy is an instance of PtolemyEffigy referencing an instance of CompositeEntity, then create a TreeTableau contained by the effigy.

Methods inherited from class ptolemy.actor.gui.TableauFactory

_configureTableau, configure, getConfigureSource, getConfigureText

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

TreeTableau.Factory

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

Create an factory with the given name and container.

Parameters:

container - The container entity.

name - The name of the entity.

Throws:

IllegalActionException - If the container is incompatible with this attribute.

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

Method Detail

createTableau

public Tableau createTableau(Effigy effigy)
                      throws java.lang.Exception

If the effigy is an instance of PtolemyEffigy referencing an instance of CompositeEntity, then create a TreeTableau contained by the effigy. The tableau will assigned the name "treeTableau". If there is already such a tableau in the effigy, then just show it instead of creating a new one. If the effigy is not an instance of PtolemyEffigy referencing an instance of CompositeEntity, and there no pre-existing tableau named "treeTableau", then return null. It is the responsibility of callers of this method to check the return value and call show().

Overrides:

createTableau in class TableauFactory

Parameters:

effigy - An effigy of a Ptolemy model.

Returns:

A new tree-view tableau, or null if the effigy is not that of a composite entity.

Throws:

java.lang.Exception - If the effigy is a PtolemyEffigy, but construction of the tree view fails for some reason.