org.generation5.swing
Class VisStepApplet

java.lang.Object
  java.awt.Component
      java.awt.Container
          java.awt.Panel
              java.applet.Applet
                  javax.swing.JApplet
                      org.generation5.swing.VisStepApplet

All Implemented Interfaces:

javax.accessibility.Accessible, java.awt.event.ActionListener, java.util.EventListener, java.awt.image.ImageObserver, java.awt.MenuContainer, javax.swing.RootPaneContainer, java.io.Serializable

public abstract class VisStepApplet

extends javax.swing.JApplet

implements java.awt.event.ActionListener

VisStepApplet is meant for visualizable and steppable demonstration applets.

See Also:

Serialized Form

Nested Class Summary

protected class	VisStepApplet.DefaultActions These are the default actions for VisStepApplets.
protected class	VisStepApplet.NullVisualizable This class is the default visualization.

Nested classes inherited from class javax.swing.JApplet

javax.swing.JApplet.AccessibleJApplet

Nested classes inherited from class java.applet.Applet

java.applet.Applet.AccessibleApplet

Nested classes inherited from class java.awt.Panel

java.awt.Panel.AccessibleAWTPanel

Nested classes inherited from class java.awt.Container

java.awt.Container.AccessibleAWTContainer

Nested classes inherited from class java.awt.Component

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

Field Summary

protected VisStepListener	actions The actions for this applet for the start, step, reset and timer actions.
protected boolean	allowMouseInteraction Denotes whether the applet allows for mouse interaction.
protected javax.swing.Timer	animTimer The animation/control timer.
protected java.awt.Color	clrBackground The background color.
protected boolean	isRunning Denotes whether the applet is running.
protected javax.swing.JButton	resetButton
protected javax.swing.JButton	startButton
protected javax.swing.JButton	stepButton
protected Steppable	steppable The steppable content.
protected javax.swing.JPanel	toolbarPanel
protected Visualizable	visualizable The visualizable content.
protected VisualizationPanel	visualizationPanel

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

VisStepApplet()
Create a new instance of VisStepApplet.

Method Summary

void	actionPerformed(java.awt.event.ActionEvent e) Called when the animation timer is triggered.
protected boolean	getBoolParameter(java.lang.String param, boolean defaultParameter) Retrieves a boolean parameter, with a default setting if the parameter is null.
protected double	getDblParameter(java.lang.String param, double defaultParameter) Retrieves a double parameter, with a default setting if the parameter is null.
protected int	getIntParameter(java.lang.String param, int defaultParameter) Retrieves an integer parameter, with a default setting if the parameter is null.
protected int	getIntParameter(java.lang.String param, int defaultParameter, int radix) Retrieves an integer parameter, with a default setting if the parameter is null.
protected java.lang.String	getStrParameter(java.lang.String param, java.lang.String defaultParameter) Retrieves a string parameter, with a default setting if the parameter is null.
void	init() Initializes the applet.
void	setStartStop(boolean runningNow) Start or stop the animation timer.
void	setSteppable(Steppable step) Set the steppable data.
void	setVisualizable(Visualizable viz) Set the visualizable data.

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

destroy, getAppletContext, getAppletInfo, getAudioClip, getAudioClip, getCodeBase, getDocumentBase, getImage, getImage, getLocale, getParameter, getParameterInfo, isActive, newAudioClip, play, play, resize, resize, setStub, showStatus, start, stop

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, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getInsets, getLayout, getListeners, getMaximumSize, getMinimumSize, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paint, paintComponents, preferredSize, print, printComponents, processContainerEvent, processEvent, remove, removeAll, removeContainerListener, removeNotify, setFocusCycleRoot, setFocusTraversalKeys, setFocusTraversalPolicy, 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, 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, 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, isOpaque, 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, setName, 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

resetButton

protected javax.swing.JButton resetButton

startButton

protected javax.swing.JButton startButton

stepButton

protected javax.swing.JButton stepButton

toolbarPanel

protected javax.swing.JPanel toolbarPanel

visualizationPanel

protected VisualizationPanel visualizationPanel

isRunning

protected boolean isRunning

Denotes whether the applet is running. This is controlled by an animation timer.

allowMouseInteraction

protected boolean allowMouseInteraction

Denotes whether the applet allows for mouse interaction. This is automatically set if the toolbar is hidden. A double-click starts or stops the applet, a right- click will advance the demonstration one timestep.

animTimer

protected javax.swing.Timer animTimer

The animation/control timer. The timer will fire the desired number of frames per second, calling both the doStep method and the repaint method of the visualization panel.

See Also:

Steppable.doStep()

clrBackground

protected java.awt.Color clrBackground

The background color. This is used as the background of the toolbar and the visualization panel.

steppable

protected Steppable steppable

The steppable content.

visualizable

protected Visualizable visualizable

The visualizable content.

actions

protected VisStepListener actions

The actions for this applet for the start, step, reset and timer actions.

Constructor Detail

VisStepApplet

public VisStepApplet()

Create a new instance of VisStepApplet.

Method Detail

getIntParameter

protected int getIntParameter(java.lang.String param,
                              int defaultParameter,
                              int radix)

Retrieves an integer parameter, with a default setting if the parameter is null. This method also allows the radix to be passed so hexadecimal and similar can be parsed and returned.

Parameters:

param - the parameter name.

defaultParameter - the default parameter.

radix - the radix.

Returns:

the integer retrieved, if parameter is not null, otherwise the default parameter.

getIntParameter

protected int getIntParameter(java.lang.String param,
                              int defaultParameter)

Retrieves an integer parameter, with a default setting if the parameter is null.

Parameters:

param - the parameter name.

defaultParameter - the default parameter.

Returns:

the integer retrieved, if parameter is not null, otherwise the default parameter.

getBoolParameter

protected boolean getBoolParameter(java.lang.String param,
                                   boolean defaultParameter)

Retrieves a boolean parameter, with a default setting if the parameter is null.

Parameters:

param - the parameter name.

defaultParameter - the default parameter.

Returns:

the boolean retrieved, if parameter is not null, otherwise the default parameter.

getDblParameter

protected double getDblParameter(java.lang.String param,
                                 double defaultParameter)

Retrieves a double parameter, with a default setting if the parameter is null.

Parameters:

param - the parameter name.

defaultParameter - the default parameter.

Returns:

the double retrieved, if parameter is not null, otherwise the default parameter.

getStrParameter

protected java.lang.String getStrParameter(java.lang.String param,
                                           java.lang.String defaultParameter)

Retrieves a string parameter, with a default setting if the parameter is null.

Parameters:

param - the parameter name.

defaultParameter - the default parameter.

Returns:

the string retrieved, if parameter is not null, otherwise the default parameter.

init

public void init()

Initializes the applet.

setSteppable

public void setSteppable(Steppable step)

Set the steppable data.

Parameters:

step - the steppable data.

setVisualizable

public void setVisualizable(Visualizable viz)

Set the visualizable data.

Parameters:

viz - the visualizable data.

setStartStop

public void setStartStop(boolean runningNow)

Start or stop the animation timer. This function controls the toolbar buttons, as well as maintaining isRunning.

Parameters:

runningNow - is the applet to be running now?

actionPerformed

public void actionPerformed(java.awt.event.ActionEvent e)

Called when the animation timer is triggered. Advances the Steppable class, and repaints the VisualizationPanel.

Specified by:

actionPerformed in interface java.awt.event.ActionListener

Parameters:

e - not used.