ptolemy.domains.de.lib
Class EventButton
java.lang.Object
ptolemy.kernel.util.NamedObj
ptolemy.kernel.InstantiableNamedObj
ptolemy.kernel.Entity
ptolemy.kernel.ComponentEntity
ptolemy.actor.AtomicActor
ptolemy.actor.TypedAtomicActor
ptolemy.actor.lib.Source
ptolemy.domains.de.lib.EventButton
- All Implemented Interfaces:
- java.io.Serializable, java.lang.Cloneable, Actor, Executable, FiringsRecordable, Placeable, Initializable, TypedActor, Changeable, Debuggable, DebugListener, Derivable, Instantiable, ModelErrorHandler, MoMLExportable, Moveable, Nameable
public class EventButton
- extends Source
- implements Placeable
Output a Token in response to a click of a button. This class is closely
related to the ButtonTime class in SR domain by Paul Whitaker.
- Since:
- Ptolemy II 2.0
- Version:
- $Id: EventButton.java 57040 2010-01-27 20:52:32Z cxh $
- Author:
- Winthrop Williams
- 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 |
Constructor Summary |
EventButton(CompositeEntity container,
java.lang.String name)
Construct an actor with an input multiport of type GENERAL. |
Method Summary |
private void |
_remove()
Remove the display from the current container, if there is one. |
void |
fire()
Fire the actor. |
java.awt.Color |
getBackground()
Get the background color. |
void |
initialize()
Create a button on the screen, if necessary. |
void |
place(java.awt.Container container)
An instance of JButton will be added to the specified container. |
boolean |
postfire()
Reset the state of the actor and return whatever the superclass
returns. |
void |
setBackground(java.awt.Color background)
Set the background color. |
void |
setContainer(CompositeEntity container)
Override the base class to remove the display from its graphical
container if the argument is null. |
Methods inherited from class ptolemy.actor.AtomicActor |
_actorFiring, _actorFiring, addActorFiringListener, addInitializable, clone, connectionsChanged, createReceivers, declareDelayDependency, getCausalityInterface, getDirector, getExecutiveDirector, getManager, inputPortList, isFireFunctional, isStrict, iterate, newReceiver, outputPortList, preinitialize, pruneDependencies, recordFiring, removeActorFiringListener, removeDependency, removeInitializable, 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, _exportMoMLContents, _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 |
text
public StringAttribute text
- The text to put on the button.
_button
private javax.swing.JButton _button
_buttonPressed
private boolean _buttonPressed
_container
private java.awt.Container _container
_frame
private javax.swing.JFrame _frame
_self
private EventButton _self
EventButton
public EventButton(CompositeEntity container,
java.lang.String name)
throws IllegalActionException,
NameDuplicationException
- Construct an actor with an input multiport of type GENERAL.
- 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.
fire
public void fire()
throws IllegalActionException
- Fire the actor.
- Specified by:
fire
in interface Executable
- Overrides:
fire
in class Source
- Throws:
IllegalActionException
- Not thrown in this base class.
getBackground
public java.awt.Color getBackground()
- Get the background color.
- Returns:
- The Color of the background.
- See Also:
setBackground(Color)
initialize
public void initialize()
throws IllegalActionException
- Create a button on the screen, if necessary. If a graphical
container has
not been specified, place the button into its own frame.
Otherwise, place it in the specified container.
- Specified by:
initialize
in interface Initializable
- Overrides:
initialize
in class AtomicActor
- Throws:
IllegalActionException
- If the parent class throws it.
place
public void place(java.awt.Container container)
- An instance of JButton will be added to the specified container.
This method needs to be called before the first call to initialize().
Otherwise, an instance of JButton will be placed in its own frame.
- Specified by:
place
in interface Placeable
- Parameters:
container
- The container into which to place the button.
postfire
public boolean postfire()
throws IllegalActionException
- Reset the state of the actor and return whatever the superclass
returns.
- Specified by:
postfire
in interface Executable
- Overrides:
postfire
in class AtomicActor
- Returns:
- True if execution can continue into the next iteration.
- Throws:
IllegalActionException
- If there is no director.
setBackground
public void setBackground(java.awt.Color background)
- Set the background color.
- Parameters:
background
- The background color.- See Also:
getBackground()
setContainer
public void setContainer(CompositeEntity container)
throws IllegalActionException,
NameDuplicationException
- Override the base class to remove the display from its graphical
container if the argument is null.
- Overrides:
setContainer
in class AtomicActor
- Parameters:
container
- The proposed container.
- Throws:
IllegalActionException
- If the base class throws it.
NameDuplicationException
- If the base class throws it.- See Also:
ComponentEntity.getContainer()
_remove
private void _remove()
- Remove the display from the current container, if there is one.