ptolemy.actor.gui
Class TokenTableau
java.lang.Object
ptolemy.kernel.util.NamedObj
ptolemy.kernel.InstantiableNamedObj
ptolemy.kernel.Entity
ptolemy.kernel.ComponentEntity
ptolemy.kernel.CompositeEntity
ptolemy.actor.gui.Tableau
ptolemy.actor.gui.TokenTableau
- All Implemented Interfaces:
- Changeable, java.lang.Cloneable, Debuggable, DebugListener, Derivable, Instantiable, ModelErrorHandler, MoMLExportable, Nameable, java.io.Serializable
- Direct Known Subclasses:
- MatrixTokenTableau
- public class TokenTableau
- extends Tableau
A tableau representing one or more tokens in a top-level window with
a text editor. Subclasses can be created to represent specific token
types in more specialized ways.
- Since:
- Ptolemy II 2.1
- Version:
- $Id: TokenTableau.java,v 1.13 2004/04/13 05:12:07 cxh Exp $
- Author:
- Edward A. Lee
- See Also:
TokenEffigy,
Serialized Form
- Accepted Rating:
- Proposed Rating:
| 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 |
TokenTableau(Effigy container,
java.lang.String name)
Construct a new tableau for the model represented by the given effigy.
|
TokenTableau(Effigy container,
java.lang.String name,
TableauFrame frame)
Construct a new tableau for the model represented by the given effigy,
using the specified frame. |
|
Method Summary |
void |
append(java.util.List list)
Append the specified tokens to the display. |
void |
append(Token token)
Append the specified token to the display.
|
static boolean |
canDisplay(Token token)
Return true if this tableau can display the specified token. |
void |
clear()
Clear the display. |
void |
createFrame(TableauFrame frame)
Create a text editor frame to view the data. |
| 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.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 |
TokenTableau
public TokenTableau(Effigy container,
java.lang.String name)
throws IllegalActionException,
NameDuplicationException
- Construct a new tableau for the model represented by the given effigy.
This constructor creates a default editor frame, which is an instance
of TextEditor.
- 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.
TokenTableau
public TokenTableau(Effigy container,
java.lang.String name,
TableauFrame frame)
throws IllegalActionException,
NameDuplicationException
- Construct a new tableau for the model represented by the given effigy,
using the specified frame.
- Parameters:
container - The container.name - The name.frame - The frame to use.
- 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.
append
public void append(Token token)
- Append the specified token to the display.
If the display is not a TextEditor, do nothing.
Subclasses should override this with display-specific actions.
- Parameters:
token - The token to append.
append
public void append(java.util.List list)
- Append the specified tokens to the display.
- Parameters:
list - A list of tokens.
canDisplay
public static boolean canDisplay(Token token)
- Return true if this tableau can display the specified token.
- Parameters:
token - A candidate token to display.
- Returns:
- True, since this tableau can display any token.
clear
public void clear()
- Clear the display.
createFrame
public void createFrame(TableauFrame frame)
throws IllegalActionException
- Create a text editor frame to view the data. This can be overridden
in derived classes to create more specialized viewers/editors.
If the specified frame is not an instance of TextEditor, then
it is replaced with a text editor.
This is called in the constructor.
- Parameters:
frame - The frame to use, or null if none is specified.
- Throws:
IllegalActionException - If the frame cannot be created.