ptolemy.actor.gui
Class MatrixTokenTableau

java.lang.Object
  extended byptolemy.kernel.util.NamedObj
      extended byptolemy.kernel.InstantiableNamedObj
          extended byptolemy.kernel.Entity
              extended byptolemy.kernel.ComponentEntity
                  extended byptolemy.kernel.CompositeEntity
                      extended byptolemy.actor.gui.Tableau
                          extended byptolemy.actor.gui.TokenTableau
                              extended byptolemy.actor.gui.MatrixTokenTableau
All Implemented Interfaces:
Changeable, java.lang.Cloneable, Debuggable, DebugListener, Derivable, Instantiable, ModelErrorHandler, MoMLExportable, Nameable, java.io.Serializable

public class MatrixTokenTableau
extends TokenTableau

A tableau representing matrix tokens in a top-level window with a table. This should be constructed using the provided factory, to ensure that the matrix pane is created.

Since:
Ptolemy II 2.1
Version:
$Id: MatrixTokenTableau.java,v 1.13 2004/04/13 05:12:04 cxh Exp $
Author:
Edward A. Lee
See Also:
TokenEffigy, Serialized Form
Accepted Rating:
Red (cxh)
Proposed Rating:
Yellow (eal)

Nested Class Summary
static class MatrixTokenTableau.Factory
          A factory that creates a matrix token tableau.
 
Nested classes inherited from class ptolemy.kernel.CompositeEntity
CompositeEntity.ContainedObjectsIterator
 
Field Summary
 
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
MatrixTokenTableau(Effigy container, java.lang.String name)
          Construct a new tableau for the model represented by the given effigy.
MatrixTokenTableau(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)
          Display the specified tokens.
 void append(Token token)
          Display the specified token.
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 matrix 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.ComponentEntity
_addPort, _checkContainer, _getContainedObject, _propagateExistence, getContainer, instantiate, newPort, propagateExistence, setName
 
Methods inherited from class ptolemy.kernel.Entity
_removePort, connectedPortList, connectedPorts, connectionsChanged, getPorts, linkedRelationList, linkedRelations, portList, removeAllPorts, setClassDefinition
 
Methods inherited from class ptolemy.kernel.InstantiableNamedObj
_setParent, exportMoML, getChildren, getElementName, getParent, getPrototypeList, isClassDefinition
 
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
 
Methods inherited from interface ptolemy.kernel.util.Derivable
getDerivedLevel, getDerivedList, propagateValue
 
Methods inherited from interface ptolemy.kernel.util.Nameable
description, getFullName, getName, getName
 

Constructor Detail

MatrixTokenTableau

public MatrixTokenTableau(Effigy container,
                          java.lang.String name)
                   throws IllegalActionException,
                          NameDuplicationException
Construct a new tableau for the model represented by the given effigy. Use setFrame() to specify the plot frame after construction.

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.

MatrixTokenTableau

public MatrixTokenTableau(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.
Method Detail

append

public void append(Token token)
Display the specified token. If the display is not a MatrixPane, or the token is not a MatrixToken, do nothing.

Overrides:
append in class TokenTableau
Parameters:
token - The token to append.

append

public void append(java.util.List list)
Display the specified tokens. If the display is not a MatrixPane, or the tokens are not instances of MatrixToken, do nothing.

Overrides:
append in class TokenTableau
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 if the argument is a MatrixToken.

clear

public void clear()
Clear the display.

Overrides:
clear in class TokenTableau

createFrame

public void createFrame(TableauFrame frame)
                 throws IllegalActionException
Create a matrix frame to view the data. If the argument is null, then a new TableauFrame is created. This is called in the constructor.

Overrides:
createFrame in class TokenTableau
Parameters:
frame - The frame to use, or null if none is specified.
Throws:
IllegalActionException - If the frame cannot be created.
See Also:
MatrixPane