Package ptolemy.actor.gt

Class ModelView

java.lang.Object

ptolemy.kernel.util.NamedObj

ptolemy.kernel.InstantiableNamedObj

ptolemy.kernel.Entity<T>

ptolemy.kernel.ComponentEntity<T>

ptolemy.actor.AtomicActor<TypedIOPort>

ptolemy.actor.TypedAtomicActor

ptolemy.actor.gt.ModelView

All Implemented Interfaces:

java.awt.event.WindowListener, java.lang.Cloneable, java.util.EventListener, Actor, Executable, FiringsRecordable, Initializable, TypedActor, Changeable, Debuggable, DebugListener, Derivable, Instantiable, ModelErrorHandler, MoMLExportable, Moveable, Nameable

public class ModelView
extends TypedAtomicActor
implements java.awt.event.WindowListener

An actor to open a window to display the input models. If inputs are provided, they are expected to be MoML strings that are to be applied to the model. This can be used, for example, to create animations.

Since:

Ptolemy II 6.0

Version:

$Id$

Author:

Thomas Huining Feng

Pt.AcceptedRating:

Red (cxh)

Pt.ProposedRating:

Yellow (eal)

Nested Class Summary

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

Entity.ContainedObjectsIterator

Field Summary

Fields

Modifier and Type	Field	Description
TypedIOPort	input	The input port to receive models to be viewed.
Parameter	isPersistent	If the isPersistent parameter is false, then the user will not be prompted to save the model upon closing.
TypedIOPort	output	The output port to send the input models unchanged.
Parameter	reopenWindow	Whether the window should be reopened each time a new model is received in a token.
Parameter	screenLocation	Location of the window, or [-1, -1] if the location is to be determined automatically.
Parameter	screenSize	Size of the window, or [-1, -1] if the size is to be determined automatically.
PortParameter	title	Title of the window, or empty if the title is to be determined automatically.

Fields inherited from class ptolemy.actor.TypedAtomicActor

_typesValid

Fields inherited from class ptolemy.actor.AtomicActor

_actorFiringListeners, _initializables, _notifyingActorFiring, _stopRequested

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

Fields inherited from interface ptolemy.actor.Executable

COMPLETED, NOT_READY, STOP_ITERATING

Constructor Summary

Constructors

Constructor	Description
ModelView(CompositeEntity container, java.lang.String name)	Construct an actor with the specified container and name.

Method Summary

Modifier and Type	Method	Description
void	fire()	Read the input, if there is any, and issue a change request to apply the MoML in the input to the displayed model.
void	initialize()	Initialize this actor.
void	windowActivated(java.awt.event.WindowEvent e)	Do nothing.
void	windowClosed(java.awt.event.WindowEvent e)	React to closing of the tableau by marking it closed.
void	windowClosing(java.awt.event.WindowEvent e)	Do nothing.
void	windowDeactivated(java.awt.event.WindowEvent e)	Do nothing.
void	windowDeiconified(java.awt.event.WindowEvent e)	Do nothing.
void	windowIconified(java.awt.event.WindowEvent e)	Do nothing.
void	windowOpened(java.awt.event.WindowEvent e)	Do nothing.

Methods inherited from class ptolemy.actor.TypedAtomicActor

_containedTypeConstraints, _customTypeConstraints, _defaultTypeConstraints, _fireAt, _fireAt, attributeTypeChanged, clone, clone, isBackwardTypeInferenceEnabled, newPort, typeConstraintList, typeConstraints

Methods inherited from class ptolemy.actor.AtomicActor

_actorFiring, _actorFiring, _declareDelayDependency, addActorFiringListener, addInitializable, connectionsChanged, createReceivers, declareDelayDependency, getCausalityInterface, getDirector, getExecutiveDirector, getManager, inputPortList, isFireFunctional, isStrict, iterate, newReceiver, outputPortList, postfire, prefire, preinitialize, pruneDependencies, recordFiring, removeActorFiringListener, removeDependency, removeInitializable, setContainer, stop, stopFire, terminate, wrapup

Methods inherited from class ptolemy.kernel.ComponentEntity

_adjustDeferrals, _checkContainer, _getContainedObject, _propagateExistence, getContainer, instantiate, isAtomic, isOpaque, moveDown, moveToFirst, moveToIndex, moveToLast, moveUp, propagateExistence, setName

Methods inherited from class ptolemy.kernel.Entity

_addPort, _description, _exportMoMLContents, _removePort, _validateSettables, connectedPortList, connectedPorts, containedObjectsIterator, getAttribute, getPort, getPorts, linkedRelationList, linkedRelations, portList, removeAllPorts, setClassDefinition, uniqueName

Methods inherited from class ptolemy.kernel.InstantiableNamedObj

_setParent, exportMoML, getChildren, getElementName, getParent, getPrototypeList, isClassDefinition, isWithinClassDefinition

Methods inherited from class ptolemy.kernel.util.NamedObj

_addAttribute, _adjustOverride, _attachText, _cloneFixAttributeFields, _containedDecorators, _copyChangeRequestList, _debug, _debug, _debug, _debug, _debug, _executeChangeRequests, _getIndentPrefix, _isMoMLSuppressed, _markContentsDerived, _notifyHierarchyListenersAfterChange, _notifyHierarchyListenersBeforeChange, _propagateValue, _removeAttribute, _splitName, _stripNumericSuffix, addChangeListener, addDebugListener, addHierarchyListener, attributeChanged, attributeDeleted, attributeList, attributeList, 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.actor.Actor

createReceivers, getCausalityInterface, getDirector, getExecutiveDirector, getManager, inputPortList, newReceiver, outputPortList

Methods inherited from interface ptolemy.kernel.util.Derivable

getDerivedLevel, getDerivedList, propagateValue

Methods inherited from interface ptolemy.actor.Executable

isFireFunctional, isStrict, iterate, postfire, prefire, stop, stopFire, terminate

Methods inherited from interface ptolemy.actor.Initializable

addInitializable, preinitialize, removeInitializable, wrapup

Methods inherited from interface ptolemy.kernel.util.Nameable

description, getContainer, getDisplayName, getFullName, getName, getName, setName

Field Detail

input

public TypedIOPort input

The input port to receive models to be viewed.

output

public TypedIOPort output

The output port to send the input models unchanged.

isPersistent

public Parameter isPersistent

If the isPersistent parameter is false, then the user will not be prompted to save the model upon closing. Models in the test suite might want to have this parameter set to false so as to avoid a dialog asking if the user wants to save the model. The default is a boolean with a value of false, indicating that the user will not be prompted to save the model if the model has changed.

reopenWindow

public Parameter reopenWindow

Whether the window should be reopened each time a new model is received in a token.

screenLocation

public Parameter screenLocation

Location of the window, or [-1, -1] if the location is to be determined automatically.

screenSize

public Parameter screenSize

Size of the window, or [-1, -1] if the size is to be determined automatically.

title

public PortParameter title

Title of the window, or empty if the title is to be determined automatically.

Constructor Detail

ModelView

public ModelView(CompositeEntity container,
                 java.lang.String name)
          throws IllegalActionException,
                 NameDuplicationException

Construct an actor with the specified container and name.

Parameters:

container - The container.

name - The name of this actor.

Throws:

IllegalActionException - If the entity cannot be contained by the proposed container.

NameDuplicationException - If the container already has an actor with this name.

Method Detail

fire

public void fire()
          throws IllegalActionException

Read the input, if there is any, and issue a change request to apply the MoML in the input to the displayed model.

Specified by:

fire in interface Executable

Overrides:

fire in class AtomicActor<TypedIOPort>

Throws:

IllegalActionException - If there is an error reading the input.

initialize

public void initialize()
                throws IllegalActionException

Initialize this actor. Close the existing tableau if there is one opened by the previous execution.

Specified by:

initialize in interface Initializable

Overrides:

initialize in class AtomicActor<TypedIOPort>

Throws:

IllegalActionException - If thrown by the superclass.

windowActivated

public void windowActivated(java.awt.event.WindowEvent e)

Do nothing.

Specified by:

windowActivated in interface java.awt.event.WindowListener

Parameters:

e - The event.

windowClosed

public void windowClosed(java.awt.event.WindowEvent e)

React to closing of the tableau by marking it closed.

Specified by:

windowClosed in interface java.awt.event.WindowListener

Parameters:

e - The event.

windowClosing

public void windowClosing(java.awt.event.WindowEvent e)

Do nothing.

Specified by:

windowClosing in interface java.awt.event.WindowListener

Parameters:

e - The event.

windowDeactivated

public void windowDeactivated(java.awt.event.WindowEvent e)

Do nothing.

Specified by:

windowDeactivated in interface java.awt.event.WindowListener

Parameters:

e - The event.

windowDeiconified

public void windowDeiconified(java.awt.event.WindowEvent e)

Do nothing.

Specified by:

windowDeiconified in interface java.awt.event.WindowListener

Parameters:

e - The event.

windowIconified

public void windowIconified(java.awt.event.WindowEvent e)

Do nothing.

Specified by:

windowIconified in interface java.awt.event.WindowListener

Parameters:

e - The event.

windowOpened

public void windowOpened(java.awt.event.WindowEvent e)

Do nothing.

Specified by:

windowOpened in interface java.awt.event.WindowListener

Parameters:

e - The event.