org.opensourcephysics.controls
Class SimulationControl

java.lang.Object
  extended by java.awt.Component
      extended by java.awt.Container
          extended by java.awt.Window
              extended by java.awt.Frame
                  extended by javax.swing.JFrame
                      extended by org.opensourcephysics.display.OSPFrame
                          extended by org.opensourcephysics.controls.ControlFrame
                              extended by org.opensourcephysics.controls.OSPControl
                                  extended by org.opensourcephysics.controls.AnimationControl
                                      extended by org.opensourcephysics.controls.SimulationControl
All Implemented Interfaces:
java.awt.image.ImageObserver, java.awt.MenuContainer, java.beans.PropertyChangeListener, java.io.Serializable, java.util.EventListener, javax.accessibility.Accessible, javax.swing.RootPaneContainer, javax.swing.WindowConstants, Control, MainFrame, SimControl, AppFrame, Hidable

public class SimulationControl
extends AnimationControl
implements SimControl

An AnimationControl that controls the editing of parameters.

Version:
1.0
Author:
Wolfgang Christian
See Also:
Serialized Form

Nested Class Summary
 
Nested classes/interfaces inherited from class javax.swing.JFrame
javax.swing.JFrame.AccessibleJFrame
 
Nested classes/interfaces inherited from class java.awt.Frame
java.awt.Frame.AccessibleAWTFrame
 
Nested classes/interfaces inherited from class java.awt.Window
java.awt.Window.AccessibleAWTWindow
 
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.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy
 
Field Summary
 
Fields inherited from class org.opensourcephysics.controls.ControlFrame
clearItem, copyItem, displayMenu, editMenu, fileMenu, inspectItem, languageItems, languageMenu, logToFileItem, model, ospApp, printFrameItem, readItem, saveAsItem, saveFrameAsEPSItem, sizeDownItem, sizeUpItem, xmlDefault
 
Fields inherited from class org.opensourcephysics.display.OSPFrame
animated, autoclear, buttonPanel, childFrames, constructorThreadGroup, customButtons, keepHidden, strategy
 
Fields inherited from class javax.swing.JFrame
accessibleContext, EXIT_ON_CLOSE, rootPane, rootPaneCheckingEnabled
 
Fields inherited from class java.awt.Frame
CROSSHAIR_CURSOR, DEFAULT_CURSOR, E_RESIZE_CURSOR, HAND_CURSOR, ICONIFIED, MAXIMIZED_BOTH, MAXIMIZED_HORIZ, MAXIMIZED_VERT, MOVE_CURSOR, N_RESIZE_CURSOR, NE_RESIZE_CURSOR, NORMAL, NW_RESIZE_CURSOR, S_RESIZE_CURSOR, SE_RESIZE_CURSOR, SW_RESIZE_CURSOR, TEXT_CURSOR, W_RESIZE_CURSOR, WAIT_CURSOR
 
Fields inherited from class java.awt.Component
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
 
Fields inherited from interface org.opensourcephysics.controls.Control
NOT_EDITABLE_BACKGROUND
 
Fields inherited from interface javax.swing.WindowConstants
DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, HIDE_ON_CLOSE
 
Fields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
 
Constructor Summary
SimulationControl(Simulation animation)
          Constructs a SIPAnimationControl for the given animation.
 
Method Summary
static SimulationControl createApp(Simulation model)
          Creates a SIP animation control and establishes communication between the control and the model.
static SimulationControl createApp(Simulation model, java.lang.String[] xml)
          Creates a simulation control and establishes communication between the control and the model.
static XML.ObjectLoader getLoader()
          Returns an XML.ObjectLoader to save and load data for this object.
 boolean isParamterFixed(java.lang.String name)
          Determines if the given parameter is fixed and can only be changed during initialization.
 void removeParameter(java.lang.String name)
          Removes a parameter from this control.
 void setAdjustableValue(java.lang.String name, boolean val)
          Stores a boolean in the control that can be edited after initialization.
 void setAdjustableValue(java.lang.String name, double val)
          Stores a double in the control that can be edited after initialization.
 void setAdjustableValue(java.lang.String name, int val)
          Stores an integer in the control that can be edited after initialization.
 void setAdjustableValue(java.lang.String name, java.lang.Object val)
          Stores an object in the control that can be edited after initialization.
 void setParameterToFixed(java.lang.String name, boolean fixed)
          Sets the fixed property of the given parameter.
 void setValue(java.lang.String name, boolean val)
          Stores a name and a boolean value in the control that can only be edited when the control is in initialization mode.
 void setValue(java.lang.String name, double val)
          Stores a name and a double value in the control that can only be edited when the control is in initialization mode.
 void setValue(java.lang.String name, int val)
          Stores a name and an integer value in the control that can only be edited when the control is in initialization mode.
 void setValue(java.lang.String name, java.lang.Object val)
          Stores an object in the control that can only be edited when the control is in initialization mode.
 
Methods inherited from class org.opensourcephysics.controls.AnimationControl
calculationDone, createApp, createApp, dispose, refreshGUI
 
Methods inherited from class org.opensourcephysics.controls.OSPControl
addButton, addButton, addControlListener, addControlListener, clearMessages, clearValues, createApp, getBoolean, getDouble, getInt, getMainFrame, getModel, getObject, getPropertyNames, getString, init, loadDisplayMenu, print, println, println, propertyChange, setDividerLocation, setEditable, setLockValues, toString
 
Methods inherited from class org.opensourcephysics.controls.ControlFrame
copy, getOSPApp, inspectXML, loadXML, loadXML, loadXML, loadXML, readParameters, save, saveXML
 
Methods inherited from class org.opensourcephysics.display.OSPFrame
addButton, addChildFrame, bufferStrategyShow, clearChildFrames, clearData, clearDataAndRepaint, createBufferStrategy, getChildFrames, getChooser, getConstructorThreadGroup, getMenu, invalidateImage, isAnimated, isAutoclear, isIconified, isKeepHidden, loadToolsMenu, parseXMLMenu, parseXMLMenu, removeMenu, removeMenuItem, render, setAnimated, setAutoclear, setDefaultCloseOperation, setFontLevel, setKeepHidden, setSize, setTitle, setVisible, show, wishesToExit
 
Methods inherited from class javax.swing.JFrame
addImpl, createRootPane, frameInit, getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getGraphics, getJMenuBar, getLayeredPane, getRootPane, getTransferHandler, isDefaultLookAndFeelDecorated, isRootPaneCheckingEnabled, paramString, processWindowEvent, remove, repaint, setContentPane, setDefaultLookAndFeelDecorated, setGlassPane, setIconImage, setJMenuBar, setLayeredPane, setLayout, setRootPane, setRootPaneCheckingEnabled, setTransferHandler, update
 
Methods inherited from class java.awt.Frame
addNotify, getCursorType, getExtendedState, getFrames, getIconImage, getMaximizedBounds, getMenuBar, getState, getTitle, isResizable, isUndecorated, remove, removeNotify, setCursor, setExtendedState, setMaximizedBounds, setMenuBar, setResizable, setState, setUndecorated
 
Methods inherited from class java.awt.Window
addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getGraphicsConfiguration, getIconImages, getInputContext, getListeners, getLocale, getModalExclusionType, getMostRecentFocusOwner, getOwnedWindows, getOwner, getOwnerlessWindows, getToolkit, getWarningString, getWindowFocusListeners, getWindowListeners, getWindows, getWindowStateListeners, hide, isActive, isAlwaysOnTop, isAlwaysOnTopSupported, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isShowing, pack, paint, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, reshape, setAlwaysOnTop, setBounds, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setIconImages, setLocationByPlatform, setLocationRelativeTo, setMinimumSize, setModalExclusionType, setSize, toBack, toFront
 
Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getMousePosition, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, setComponentZOrder, 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, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isPreferredSizeSet, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, prepareImage, prepareImage, printAll, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resize, resize, setBackground, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setMaximumSize, setName, setPreferredSize, show, size, transferFocus, transferFocusUpCycle
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface org.opensourcephysics.controls.Control
calculationDone, clearMessages, clearValues, getBoolean, getDouble, getInt, getObject, getPropertyNames, getString, print, println, println, setLockValues
 
Methods inherited from interface org.opensourcephysics.controls.MainFrame
addChildFrame, clearChildFrames, getChildFrames, getOSPApp
 
Methods inherited from interface org.opensourcephysics.display.AppFrame
getDefaultCloseOperation
 
Methods inherited from interface java.awt.MenuContainer
getFont, postEvent
 

Constructor Detail

SimulationControl

public SimulationControl(Simulation animation)
Constructs a SIPAnimationControl for the given animation.

Parameters:
animation - Animation
Method Detail

setParameterToFixed

public void setParameterToFixed(java.lang.String name,
                                boolean fixed)
Sets the fixed property of the given parameter. Fixed parameters can only be changed before initialization.

Specified by:
setParameterToFixed in interface SimControl

isParamterFixed

public boolean isParamterFixed(java.lang.String name)
Determines if the given parameter is fixed and can only be changed during initialization.

Parameters:
name - String
Returns:
boolean

setValue

public void setValue(java.lang.String name,
                     java.lang.Object val)
Stores an object in the control that can only be edited when the control is in initialization mode.

Specified by:
setValue in interface Control
Overrides:
setValue in class OSPControl
Parameters:
name -
val -

setAdjustableValue

public void setAdjustableValue(java.lang.String name,
                               java.lang.Object val)
Stores an object in the control that can be edited after initialization.

Specified by:
setAdjustableValue in interface SimControl
Parameters:
name -
val -

setValue

public void setValue(java.lang.String name,
                     double val)
Stores a name and a double value in the control that can only be edited when the control is in initialization mode.

Specified by:
setValue in interface Control
Overrides:
setValue in class OSPControl
Parameters:
name -
val -

setAdjustableValue

public void setAdjustableValue(java.lang.String name,
                               double val)
Stores a double in the control that can be edited after initialization.

Specified by:
setAdjustableValue in interface SimControl
Parameters:
name -
val -

setValue

public void setValue(java.lang.String name,
                     int val)
Stores a name and an integer value in the control that can only be edited when the control is in initialization mode.

Specified by:
setValue in interface Control
Overrides:
setValue in class OSPControl
Parameters:
name -
val -

setAdjustableValue

public void setAdjustableValue(java.lang.String name,
                               int val)
Stores an integer in the control that can be edited after initialization.

Specified by:
setAdjustableValue in interface SimControl
Parameters:
name -
val -

setValue

public void setValue(java.lang.String name,
                     boolean val)
Stores a name and a boolean value in the control that can only be edited when the control is in initialization mode.

Specified by:
setValue in interface Control
Overrides:
setValue in class OSPControl
Parameters:
name -
val -

removeParameter

public void removeParameter(java.lang.String name)
Removes a parameter from this control.

Specified by:
removeParameter in interface SimControl
Overrides:
removeParameter in class OSPControl
Parameters:
name -

setAdjustableValue

public void setAdjustableValue(java.lang.String name,
                               boolean val)
Stores a boolean in the control that can be edited after initialization.

Specified by:
setAdjustableValue in interface SimControl
Parameters:
name -
val -

getLoader

public static XML.ObjectLoader getLoader()
Returns an XML.ObjectLoader to save and load data for this object.

Returns:
the object loader

createApp

public static SimulationControl createApp(Simulation model)
Creates a SIP animation control and establishes communication between the control and the model.

Parameters:
model - SIPAnimation
Returns:
AnimationControl

createApp

public static SimulationControl createApp(Simulation model,
                                          java.lang.String[] xml)
Creates a simulation control and establishes communication between the control and the model. Initial parameters are set using the xml data.

Parameters:
model - Simulation
xml - String[]
Returns:
SimulationControl