ptolemy.actor.gui
Class MoMLApplet

java.lang.Object
  java.awt.Component
      java.awt.Container
          java.awt.Panel
              java.applet.Applet
                  javax.swing.JApplet
                      ptolemy.gui.BasicJApplet
                          ptolemy.actor.gui.PtolemyApplet
                              ptolemy.actor.gui.MoMLApplet

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible, javax.swing.RootPaneContainer, ExecutionListener

Direct Known Subclasses:

MoMLViewerApplet

public class MoMLApplet
extends PtolemyApplet

This is an applet that constructs a Ptolemy II model from a MoML file. "MoML" stands for "Modeling Markup Language." It is an XML schema for constructing Ptolemy II models.

This class offers a number of alternatives that control the visual appearance of the applet. By default, the applet places on the screen a set of control buttons that can be used to start, stop, pause, and resume the model. Below those buttons, it places the visual elements of any actors in the model that implement the Placeable interface, such as plotters or textual output.

The applet parameters are:

• background: The background color, typically given as a hex number of the form "#rrggbb" where rr gives the red component, gg gives the green component, and bb gives the blue component.
• controls: This gives a comma-separated list of any subset of the words "buttons", "topParameters", and "directorParameters" (case insensitive), or the word "none". If this parameter is not given, then it is equivalent to giving "buttons", and only the control buttons mentioned above will be displayed. If the parameter is given, and its value is "none", then no controls are placed on the screen. If the word "topParameters" is included in the comma-separated list, then controls for the top-level parameters of the model are placed on the screen, below the buttons. If the word "directorParameters" is included, then controls for the director parameters are also included.
• modelURL: The name of a URI (or URL) containing the MoML file that defines the model.
• orientation: This can have value "horizontal", "vertical", or "controls_only" (case insensitive). If it is "vertical", then the controls are placed above the visual elements of the Placeable actors. This is the default. If it is "horizontal", then the controls are placed to the left of the visual elements. If it is "controls_only" then no visual elements are placed.

To create a model in a different way, say without a modelClass applet parameter, you may extend this class and override the protected method _createModel(). If you wish to alter the way that the model is represented on the screen, you can extend this class an override the _createView() method. The rendition in this class is an instance of ModelPane.

Since:

Ptolemy II 0.4

Version:

$Id: MoMLApplet.java 57040 2010-01-27 20:52:32Z cxh $

Author:

Edward A. Lee, Christopher Hylands

See Also:

Serialized Form

Accepted Rating:

Red (eal)

Proposed Rating:

Yellow (eal)

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JApplet

javax.swing.JApplet.AccessibleJApplet

Nested classes/interfaces inherited from class java.applet.Applet

java.applet.Applet.AccessibleApplet

Nested classes/interfaces inherited from class java.awt.Panel

java.awt.Panel.AccessibleAWTPanel

Nested classes/interfaces inherited from class java.awt.Container

java.awt.Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

protected java.lang.String	_fragment The fragment of the modelURL, if any.
protected java.lang.String	_modelURL The modelURL.

Fields inherited from class ptolemy.actor.gui.PtolemyApplet

_manager, _setupOK, _toplevel, _workspace

Fields inherited from class ptolemy.gui.BasicJApplet

_background

Fields inherited from class javax.swing.JApplet

accessibleContext, rootPane, rootPaneCheckingEnabled

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

MoMLApplet()

Method Summary

protected NamedObj	_createModel(Workspace workspace) Read the model from the modelURL applet parameter and filter out any graphical classes that might require us to have diva.jar in the classpath.
protected NamedObj	_createModel(Workspace workspace, boolean filterGraphicalClasses) Read the model from the modelURL applet parameter.
protected java.lang.String	_readModelURLParameter() Read the modelURL applet parameter.
java.lang.String	getAppletInfo() Return applet information.
java.lang.String[][]	getParameterInfo() Describe the applet parameters.

Methods inherited from class ptolemy.actor.gui.PtolemyApplet

_createRunControls, _createView, _go, _stop, destroy, executionError, executionFinished, init, managerStateChanged, start, stop

Methods inherited from class ptolemy.gui.BasicJApplet

_concatStringArrays, _getBackground, _stackTraceToString, report, report, report

Methods inherited from class javax.swing.JApplet

addImpl, createRootPane, getAccessibleContext, getContentPane, getGlassPane, getJMenuBar, getLayeredPane, getRootPane, isRootPaneCheckingEnabled, paramString, remove, setContentPane, setGlassPane, setJMenuBar, setLayeredPane, setLayout, setRootPane, setRootPaneCheckingEnabled, update

Methods inherited from class java.applet.Applet

getAppletContext, getAudioClip, getAudioClip, getCodeBase, getDocumentBase, getImage, getImage, getLocale, getParameter, isActive, newAudioClip, play, play, resize, resize, setStub, showStatus

Methods inherited from class java.awt.Panel

addNotify

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getInsets, getLayout, getListeners, getMaximumSize, getMinimumSize, getMousePosition, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paint, paintComponents, preferredSize, print, printComponents, processContainerEvent, processEvent, remove, removeAll, removeContainerListener, removeNotify, setComponentZOrder, setFocusCycleRoot, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, transferFocusBackward, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphics, getGraphicsConfiguration, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getToolkit, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, printAll, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, reshape, setBackground, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setMaximumSize, setMinimumSize, setName, setPreferredSize, setSize, setSize, setVisible, show, show, size, toString, transferFocus, transferFocusUpCycle

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

_fragment

protected java.lang.String _fragment

The fragment of the modelURL, if any. This field is set after _readMoMLAppletParameter() is called.

_modelURL

protected java.lang.String _modelURL

The modelURL. This field is set after _readMoMLAppletParameter() is called.

Constructor Detail

MoMLApplet

public MoMLApplet()

Method Detail

getAppletInfo

public java.lang.String getAppletInfo()

Return applet information. If the top-level model element contains a doc element, then the contents of that element is included in the applet information.

Overrides:

getAppletInfo in class PtolemyApplet

Returns:

A string giving information about the applet.

getParameterInfo

public java.lang.String[][] getParameterInfo()

Describe the applet parameters.

Overrides:

getParameterInfo in class PtolemyApplet

Returns:

An array describing the applet parameters.

_createModel

protected NamedObj _createModel(Workspace workspace)
                         throws java.lang.Exception

Read the model from the modelURL applet parameter and filter out any graphical classes that might require us to have diva.jar in the classpath.

Overrides:

_createModel in class PtolemyApplet

Parameters:

workspace - The workspace in which to create the model.

Returns:

A model.

Throws:

java.lang.Exception - If something goes wrong.

_createModel

protected NamedObj _createModel(Workspace workspace,
                                boolean filterGraphicalClasses)
                         throws java.lang.Exception

Read the model from the modelURL applet parameter.

Parameters:

workspace - The workspace in which to create the model.

filterGraphicalClasses - If true, then filter out graphical classes that might require diva.jar to be in the classpath

Returns:

A model.

Throws:

java.lang.Exception - If something goes wrong.

_readModelURLParameter

protected java.lang.String _readModelURLParameter()
                                           throws java.lang.Exception

Read the modelURL applet parameter. If the modelURL applet parameter does not exist, then read the model applet parameter. As a side effect, the _fragment field is set with any text after a "#".

Returns:

the value of the modelURL or model parameter.

Throws:

java.lang.Exception - Thrown if there is no modelURL or model applet parameter.