Package ptolemy.vergil.actor

Class DocBuilderTableau.Factory

java.lang.Object

ptolemy.kernel.util.NamedObj

ptolemy.kernel.util.Attribute

ptolemy.actor.gui.TableauFactory

ptolemy.vergil.actor.DocBuilderTableau.Factory

All Implemented Interfaces:

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

Enclosing class:

DocBuilderTableau

public static class DocBuilderTableau.Factory
extends TableauFactory

A factory that creates DocBuilderGUI tableaux for Ptolemy models.

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
Factory(NamedObj container, java.lang.String name)	Create a factory with the given name and container.

Method Summary

Modifier and Type	Method	Description
Tableau	createTableau(Effigy effigy)	If the specified effigy already contains a tableau named "DocBuilderTableau", then return that tableau; otherwise, create a new instance of DocBuilderTableau in the specified effigy, and name it "DocBuilderTableau".

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, _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

Factory

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

Create a factory with the given name and container.

Parameters:

container - The container.

name - The name.

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 specified effigy already contains a tableau named "DocBuilderTableau", then return that tableau; otherwise, create a new instance of DocBuilderTableau in the specified effigy, and name it "DocBuilderTableau". If the specified effigy is not an instance of DocBuilderEffigy, then do not create a tableau and 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 - The effigy.

Returns:

A DocBuilder tableau, or null if one cannot be found or created.

Throws:

java.lang.Exception - If the factory should be able to create a tableau for the effigy, but something goes wrong.