ptolemy.actor.gui

Class TextEditorTableau

java.lang.Object

ptolemy.kernel.util.NamedObj

ptolemy.kernel.InstantiableNamedObj

ptolemy.kernel.Entity<T>

ptolemy.kernel.ComponentEntity

ptolemy.kernel.CompositeEntity

ptolemy.actor.gui.Tableau

ptolemy.actor.gui.TextEditorTableau

All Implemented Interfaces:

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

Direct Known Subclasses:

ExternalTextTableau

public class TextEditorTableau
extends Tableau

A tableau representing a text window. The constructor of this class creates the window. The text window itself is an instance of TextEditor, and can be accessed using the getFrame() method. As with other tableaux, this is an entity that is contained by an effigy of a model. There can be any number of instances of this class in an effigy.

Since:

Ptolemy II 1.0

Version:

$Id$

Author:

Steve Neuendorffer and Edward A. Lee

See Also:

Effigy

Pt.AcceptedRating:

Red (cxh)

Pt.ProposedRating:

Yellow (eal)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TextEditorTableau.Factory A factory that creates text editor tableaux for Ptolemy models.

Nested classes/interfaces inherited from class ptolemy.actor.gui.Tableau

Tableau.WindowClosedAdapter

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

CompositeEntity.ContainedObjectsIterator

Field Summary

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
TextEditorTableau(TextEffigy container, java.lang.String name) Construct a new tableau for the model represented by the given effigy.
TextEditorTableau(TextEffigy container, java.lang.String name, TextEditor editor) Construct a new tableau for the model represented by the given effigy.

Method Summary

Modifier and Type	Method and Description
void	setEditable(boolean flag) Make the tableau editable or uneditable.
void	show() Make this tableau visible by calling setVisible(true), and raising or deiconifying its window.

Methods inherited from class ptolemy.actor.gui.Tableau

attributeChanged, clone, close, getFrame, getTitle, isEditable, isMaster, setContainer, 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

Constructor Detail

TextEditorTableau

public TextEditorTableau(TextEffigy container,
                         java.lang.String name)
                  throws IllegalActionException,
                         NameDuplicationException

Construct a new tableau for the model represented by the given effigy.

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.

TextEditorTableau

public TextEditorTableau(TextEffigy container,
                         java.lang.String name,
                         TextEditor editor)
                  throws IllegalActionException,
                         NameDuplicationException

Construct a new tableau for the model represented by the given effigy.

Parameters:

container - The container.

name - The name.

editor - The text editor to use, or null to use the default.

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

setEditable

public void setEditable(boolean flag)

Make the tableau editable or uneditable. Notice that this does not change whether the effigy is modifiable, so other tableaux on the same effigy may still modify the associated file.

Overrides:

setEditable in class Tableau

Parameters:

flag - False to make the tableau uneditable.

See Also:

Tableau.isEditable()

show

public void show()

Make this tableau visible by calling setVisible(true), and raising or deiconifying its window. If no frame has been set, then do nothing.

Overrides:

show in class Tableau