org.ascape.view.vis.control
Class ControlBarView

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JPanel
                  org.ascape.view.vis.PanelView
                      org.ascape.view.vis.ScapeTransitionPanelView
                          org.ascape.view.vis.control.ControlActionView
                              org.ascape.view.vis.control.ControlBarView

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Externalizable, java.io.Serializable, java.lang.Cloneable, java.util.EventListener, javax.accessibility.Accessible, ScapeListener, RecorderListener, HasName, ComponentView

public class ControlBarView
extends ControlActionView

A class providing a control bar for controlling a model. Provides start, stop, restart, pause, resume, quit, info, status, and new charts. Control views can be attached to any scape, and controls will typically affect the model (entire collection of scapes) as a whole.s Use SimpleControlView if Swing is not available or if simple buttons are preferred to image buttons with tool-tips. Requires Swing.

Since:

1.0

Version:

3.0

Author:

Miles Parker

See Also:

Serialized Form

Nested Class Summary

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

javax.swing.JPanel.AccessibleJPanel

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

javax.swing.JComponent.AccessibleJComponent

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 javax.swing.JButton	addHistButton The add hist button.
protected javax.swing.JButton	addPieButton The add pie button.
protected javax.swing.JButton	addTSButton The add TS button.
protected javax.swing.JToolBar	fileBar The file bar.
protected javax.swing.JButton	infoButton The info button.
protected javax.swing.JToolBar	optionsBar The options bar.
protected javax.swing.JButton	quitButton The quit button.
protected javax.swing.JToolBar	runControlBar The run control bar.

Fields inherited from class org.ascape.view.vis.control.ControlActionView

recordedView, recorder

Fields inherited from class org.ascape.view.vis.ScapeTransitionPanelView

lastScapeAppearsPaused

Fields inherited from class org.ascape.view.vis.PanelView

delegate, iterationsPerRedraw, name, scape

Fields inherited from class javax.swing.JComponent

accessibleContext, listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

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

ControlBarView()
Constructs the control view, creating and laying out its components.

ControlBarView(java.lang.String name)
Constructs the control view, creating and laying out its components.

Method Summary

java.awt.Component	add(java.lang.String name, java.awt.Component c)
void	build() Constructs the tool bar buttons and actions, and places them within the toolbar.
void	buildFrameList() Builds the frame list.
void	changeInFullScreen() Change in full screen.
void	environmentNowNoScape() Environment now no scape.
void	environmentNowScape() Environment now scape.
javax.swing.JToolBar	getFileBar() Gets the file bar.
javax.swing.JComboBox	getFrameList() Gets the frame list.
javax.swing.JToolBar	getOptionsBar() Gets the options bar.
javax.swing.JToolBar	getRunControlBar() Gets the run control bar.
void	recordingCreated() Called by the recorder when it has been properly initialized
void	recordingStopped() Called by the recorder when all recording has stopped.
void	scapeAdded(ScapeEvent scapeEvent) Called on interation; delays models return by delay slider setting.
void	scapeClosing(ScapeEvent scapeEvent) Method called when the scape is closed.
void	scapeNowPaused() Scape now paused.
void	scapeNowResumed() Scape now resumed.
void	scapeNowRunning() Scape now running.
void	scapeNowStepping() Scape now stepping.
void	scapeNowStopped() Scape now stopped.
void	setFrameSelection(java.lang.Object o) Sets the frame selection.
void	setIgnoreFrameSelection(boolean ignore) Sets the ignore frame selection.
void	updateScapeGraphics() Update the components.

Methods inherited from class org.ascape.view.vis.control.ControlActionView

getAddHistAction, getAddPieAction, getAddTSAction, getCaptureDeskAction, getCloseAction, getFullWindowAction, getInfoAction, getName, getNormalWindowAction, getOpenAction, getOpenSavedAction, getPauseResumeAction, getQuitAction, getRecordStartAction, getRecordStopAction, getSaveAction, getSearchAction, getSettingsAction, getStartRestartAction, getStepAction, getStopAction, newChart, recordingCancelStop, recordingStarted, scapeDeserialized, scapeNotification, scapeNowSteppable, scapeStarted, setName, toString

Methods inherited from class org.ascape.view.vis.ScapeTransitionPanelView

addNotify, isLifeOfScape, scapeRemoved

Methods inherited from class org.ascape.view.vis.PanelView

clone, environmentQuiting, forceScapeNotify, getDelegate, getIcon, getIterationsPerRedraw, getPreferredSizeWithin, getScape, getViewFrame, iconUpdated, isGraphic, notifyScapeUpdated, onChangeIterationsPerRedraw, paintComponent, readExternal, scapeInitialized, scapeIterated, scapeSetup, scapeStopped, setDelegate, setIterationsPerRedraw, setMovieRecorder, setViewFrame, writeExternal

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, 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, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setSize, setSize, show, show, size, transferFocus, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Field Detail

infoButton

protected javax.swing.JButton infoButton

The info button.

quitButton

protected javax.swing.JButton quitButton

The quit button.

addTSButton

protected javax.swing.JButton addTSButton

The add TS button.

addHistButton

protected javax.swing.JButton addHistButton

The add hist button.

addPieButton

protected javax.swing.JButton addPieButton

The add pie button.

optionsBar

protected javax.swing.JToolBar optionsBar

The options bar.

fileBar

protected javax.swing.JToolBar fileBar

The file bar.

runControlBar

protected javax.swing.JToolBar runControlBar

The run control bar.

Constructor Detail

ControlBarView

public ControlBarView()

Constructs the control view, creating and laying out its components.

ControlBarView

public ControlBarView(java.lang.String name)

Constructs the control view, creating and laying out its components.

Parameters:

name - a user relevant name for this view

Method Detail

add

public java.awt.Component add(java.lang.String name,
                              java.awt.Component c)

Overrides:

add in class java.awt.Container

build

public void build()

Constructs the tool bar buttons and actions, and places them within the toolbar.

Specified by:

build in interface ComponentView

Overrides:

build in class ScapeTransitionPanelView

buildFrameList

public void buildFrameList()

Builds the frame list.

scapeAdded

public void scapeAdded(ScapeEvent scapeEvent)
                throws java.util.TooManyListenersException

Called on interation; delays models return by delay slider setting.

Specified by:

scapeAdded in interface ScapeListener

Overrides:

scapeAdded in class ScapeTransitionPanelView

Parameters:

scapeEvent - the scape event

Throws:

java.util.TooManyListenersException - the too many listeners exception

updateScapeGraphics

public void updateScapeGraphics()

Update the components. Ensures that the state of all buttons matchhes the state of the observed scape.

Specified by:

updateScapeGraphics in interface ComponentView

Overrides:

updateScapeGraphics in class ScapeTransitionPanelView

scapeNowRunning

public void scapeNowRunning()

Description copied from class: ScapeTransitionPanelView

Scape now running.

Overrides:

scapeNowRunning in class ControlActionView

scapeNowStopped

public void scapeNowStopped()

Description copied from class: ScapeTransitionPanelView

Scape now stopped.

Overrides:

scapeNowStopped in class ControlActionView

scapeNowPaused

public void scapeNowPaused()

Description copied from class: ScapeTransitionPanelView

Scape now paused.

Overrides:

scapeNowPaused in class ControlActionView

scapeNowResumed

public void scapeNowResumed()

Description copied from class: ScapeTransitionPanelView

Scape now resumed.

Overrides:

scapeNowResumed in class ControlActionView

scapeNowStepping

public void scapeNowStepping()

Description copied from class: ControlActionView

Scape now stepping.

Overrides:

scapeNowStepping in class ControlActionView

environmentNowScape

public void environmentNowScape()

Description copied from class: ScapeTransitionPanelView

Environment now scape.

Overrides:

environmentNowScape in class ControlActionView

environmentNowNoScape

public void environmentNowNoScape()

Description copied from class: ScapeTransitionPanelView

Environment now no scape.

Overrides:

environmentNowNoScape in class ControlActionView

changeInFullScreen

public void changeInFullScreen()

Description copied from class: ControlActionView

Change in full screen.

Overrides:

changeInFullScreen in class ControlActionView

recordingStopped

public void recordingStopped()

Description copied from interface: RecorderListener

Called by the recorder when all recording has stopped.

Specified by:

recordingStopped in interface RecorderListener

Overrides:

recordingStopped in class ControlActionView

recordingCreated

public void recordingCreated()

Description copied from interface: RecorderListener

Called by the recorder when it has been properly initialized

Specified by:

recordingCreated in interface RecorderListener

Overrides:

recordingCreated in class ControlActionView

setFrameSelection

public void setFrameSelection(java.lang.Object o)

Sets the frame selection.

Parameters:

o - the new frame selection

scapeClosing

public void scapeClosing(ScapeEvent scapeEvent)

Method called when the scape is closed.

Specified by:

scapeClosing in interface ScapeListener

Overrides:

scapeClosing in class PanelView

Parameters:

scapeEvent - the scape event

setIgnoreFrameSelection

public void setIgnoreFrameSelection(boolean ignore)

Sets the ignore frame selection.

Parameters:

ignore - the new ignore frame selection

getFrameList

public javax.swing.JComboBox getFrameList()

Gets the frame list.

Returns:

the frame list

getOptionsBar

public javax.swing.JToolBar getOptionsBar()

Gets the options bar.

Returns:

the options bar

getFileBar

public javax.swing.JToolBar getFileBar()

Gets the file bar.

Returns:

the file bar

getRunControlBar

public javax.swing.JToolBar getRunControlBar()

Gets the run control bar.

Returns:

the run control bar