ptolemy.actor.gui
Class AbstractPlaceableActor
java.lang.Object
ptolemy.kernel.util.NamedObj
ptolemy.kernel.InstantiableNamedObj
ptolemy.kernel.Entity
ptolemy.kernel.ComponentEntity
ptolemy.actor.AtomicActor
ptolemy.actor.TypedAtomicActor
ptolemy.actor.gui.AbstractPlaceableActor
- All Implemented Interfaces:
- java.io.Serializable, java.lang.Cloneable, Actor, Executable, FiringsRecordable, Placeable, Initializable, TypedActor, Changeable, Debuggable, DebugListener, Derivable, Instantiable, ModelErrorHandler, MoMLExportable, Moveable, Nameable
- Direct Known Subclasses:
- Display, MatrixViewer, ModelDisplay
public abstract class AbstractPlaceableActor
- extends TypedAtomicActor
- implements Placeable
Base class for actors that implement the Placeable interface.
- Since:
- Ptolemy II 6.1
- Version:
- $Id: AbstractPlaceableActor.java 57040 2010-01-27 20:52:32Z cxh $
- Author:
- Edward A. Lee
- See Also:
- Serialized Form
- Accepted Rating:
- Proposed Rating:
Fields inherited from class ptolemy.kernel.util.NamedObj |
_changeListeners, _changeLock, _changeRequests, _debugging, _debugListeners, _elementName, _isPersistent, _verbose, _workspace, ATTRIBUTES, CLASSNAME, COMPLETE, CONTENTS, DEEP, FULLNAME, LINKS |
Method Summary |
protected void |
_exportMoMLContents(java.io.Writer output,
int depth)
Write a MoML description of the contents of this object. |
abstract void |
place(java.awt.Container container)
Specify the container into which this object should be placed. |
void |
setFrame(javax.swing.JFrame frame)
Specify the associated frame and set its properties (size, etc.) |
Methods inherited from class ptolemy.actor.AtomicActor |
_actorFiring, _actorFiring, addActorFiringListener, addInitializable, clone, connectionsChanged, createReceivers, declareDelayDependency, fire, getCausalityInterface, getDirector, getExecutiveDirector, getManager, initialize, 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 |
_description, _removePort, _validateSettables, connectedPortList, connectedPorts, containedObjectsIterator, getAttribute, getPort, getPorts, linkedRelationList, linkedRelations, portList, removeAllPorts, setClassDefinition, uniqueName |
Methods inherited from class ptolemy.kernel.util.NamedObj |
_addAttribute, _adjustOverride, _attachText, _cloneFixAttributeFields, _debug, _debug, _debug, _debug, _debug, _getIndentPrefix, _isMoMLSuppressed, _markContentsDerived, _propagateValue, _recordDecoratedAttributes, _removeAttribute, _splitName, _stripNumericSuffix, addChangeListener, addDebugListener, attributeChanged, attributeList, attributeList, 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, propagateValue, propagateValues, removeChangeListener, removeDebugListener, 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 |
_frame
protected javax.swing.JFrame _frame
- The associated frame.
_paneSize
protected SizeAttribute _paneSize
- A specification of the size of the pane if it's in its own window.
_windowProperties
protected WindowPropertiesAttribute _windowProperties
- A specification for the window properties of the frame.
AbstractPlaceableActor
public AbstractPlaceableActor(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.
place
public abstract void place(java.awt.Container container)
- Specify the container into which this object should be placed.
Obviously, this method needs to be called before the object
is actually placed in a container. Otherwise, the object will be
expected to create its own frame into which to place itself.
For actors, this method should be called before initialize().
- Specified by:
place
in interface Placeable
- Parameters:
container
- The container in which to place the object, or
null to specify that there is no current container.
setFrame
public void setFrame(javax.swing.JFrame frame)
- Specify the associated frame and set its properties (size, etc.)
to match those stored in the _windowProperties attribute.
- Parameters:
frame
- The associated frame.
_exportMoMLContents
protected void _exportMoMLContents(java.io.Writer output,
int depth)
throws java.io.IOException
- Write a MoML description of the contents of this object. This
overrides the base class to make sure that the current frame
properties, if there is a frame, are recorded.
- Overrides:
_exportMoMLContents
in class Entity
- Parameters:
output
- The output stream to write to.depth
- The depth in the hierarchy, to determine indenting.
- Throws:
java.io.IOException
- If an I/O error occurs.- See Also:
NamedObj.exportMoML(Writer, int)