org.ascape.view.vis.control
Class ControlActionView

java.lang.Object
  extended by java.awt.Component
      extended by java.awt.Container
          extended by javax.swing.JComponent
              extended by javax.swing.JPanel
                  extended by org.ascape.view.vis.PanelView
                      extended by org.ascape.view.vis.ScapeTransitionPanelView
                          extended by org.ascape.view.vis.control.ControlActionView
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
Direct Known Subclasses:
ControlBarView, MenuBarView

public class ControlActionView
extends ScapeTransitionPanelView
implements RecorderListener

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

Since:
2.9
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 static ComponentView recordedView
          The recorded view.
protected  MovieRecorder recorder
          The 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
ControlActionView()
          Constructs the control view, creating and laying out its components.
ControlActionView(java.lang.String name)
          Constructs the control view, creating and laying out its components.
 
Method Summary
 void changeInFullScreen()
          Change in full screen.
 void environmentNowNoScape()
          Environment now no scape.
 void environmentNowScape()
          Environment now scape.
 javax.swing.Action getAddHistAction()
          Gets the add hist action.
 javax.swing.Action getAddPieAction()
          Gets the add pie action.
 javax.swing.Action getAddTSAction()
          Gets the add TS action.
 javax.swing.Action getCaptureDeskAction()
          Gets the capture desk action.
 javax.swing.Action getCloseAction()
          Gets the close action.
 javax.swing.Action getFullWindowAction()
          Gets the full window action.
 javax.swing.Action getInfoAction()
          Gets the info action.
 java.lang.String getName()
          Returns a name for the view as defined by set name.
 javax.swing.Action getNormalWindowAction()
          Gets the normal window action.
 javax.swing.Action getOpenAction()
          Gets the open action.
 javax.swing.Action getOpenSavedAction()
          Gets the open saved action.
 javax.swing.Action getPauseResumeAction()
          Gets the pause resume action.
 javax.swing.Action getQuitAction()
          Gets the quit action.
 javax.swing.Action getRecordStartAction()
          Gets the record start action.
 javax.swing.Action getRecordStopAction()
          Gets the record stop action.
 javax.swing.Action getSaveAction()
          Gets the save action.
 javax.swing.Action getSearchAction()
          Gets the search action.
 javax.swing.Action getSettingsAction()
          Gets the settings action.
 javax.swing.Action getStartRestartAction()
          Gets the start restart action.
 javax.swing.Action getStepAction()
          Gets the step action.
 javax.swing.Action getStopAction()
          Gets the stop action.
protected  void newChart(int chartType)
          New chart.
protected  void recordingCancelStop()
          Called to stop or cancel recording.
 void recordingCreated()
          Called by the recorder when it has been properly initialized
 void recordingStarted()
          Called by the recorder when recording has begun, and we are waiting for the next frame.
 void recordingStopped()
          Called by the recorder when all recording has stopped.
 void scapeDeserialized(ScapeEvent scapeEvent)
          Method called once a model is deserialized.
 void scapeNotification(ScapeEvent scapeEvent)
          Notifies this view that something has happened on the scape.
 void scapeNowPaused()
          Scape now paused.
 void scapeNowResumed()
          Scape now resumed.
 void scapeNowRunning()
          Scape now running.
 void scapeNowSteppable()
          Scape now steppable.
 void scapeNowStepping()
          Scape now stepping.
 void scapeNowStopped()
          Scape now stopped.
 void scapeStarted(ScapeEvent scapeEvent)
          Method called when the scape is started.
 void setName(java.lang.String name)
          Sets the name of this view.
 java.lang.String toString()
          Returns a short description of this view.
 
Methods inherited from class org.ascape.view.vis.ScapeTransitionPanelView
addNotify, build, isLifeOfScape, scapeAdded, scapeRemoved, updateScapeGraphics
 
Methods inherited from class org.ascape.view.vis.PanelView
clone, environmentQuiting, forceScapeNotify, getDelegate, getIcon, getIterationsPerRedraw, getPreferredSizeWithin, getScape, getViewFrame, iconUpdated, isGraphic, notifyScapeUpdated, onChangeIterationsPerRedraw, paintComponent, readExternal, scapeClosing, 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, 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

recorder

protected MovieRecorder recorder
The recorder.


recordedView

protected static ComponentView recordedView
The recorded view.

Constructor Detail

ControlActionView

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


ControlActionView

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

Parameters:
name - the name
Method Detail

scapeDeserialized

public void scapeDeserialized(ScapeEvent scapeEvent)
Method called once a model is deserialized.

Specified by:
scapeDeserialized in interface ScapeListener
Overrides:
scapeDeserialized in class PanelView
Parameters:
scapeEvent - the scape event

scapeStarted

public void scapeStarted(ScapeEvent scapeEvent)
Description copied from class: PanelView
Method called when the scape is started.

Specified by:
scapeStarted in interface ScapeListener
Overrides:
scapeStarted in class PanelView
Parameters:
scapeEvent - the scape event

scapeNowRunning

public void scapeNowRunning()
Description copied from class: ScapeTransitionPanelView
Scape now running.

Overrides:
scapeNowRunning in class ScapeTransitionPanelView

scapeNowStopped

public void scapeNowStopped()
Description copied from class: ScapeTransitionPanelView
Scape now stopped.

Overrides:
scapeNowStopped in class ScapeTransitionPanelView

scapeNowPaused

public void scapeNowPaused()
Description copied from class: ScapeTransitionPanelView
Scape now paused.

Overrides:
scapeNowPaused in class ScapeTransitionPanelView

scapeNowResumed

public void scapeNowResumed()
Description copied from class: ScapeTransitionPanelView
Scape now resumed.

Overrides:
scapeNowResumed in class ScapeTransitionPanelView

scapeNowStepping

public void scapeNowStepping()
Scape now stepping.


scapeNowSteppable

public void scapeNowSteppable()
Description copied from class: ScapeTransitionPanelView
Scape now steppable.

Overrides:
scapeNowSteppable in class ScapeTransitionPanelView

environmentNowScape

public void environmentNowScape()
Description copied from class: ScapeTransitionPanelView
Environment now scape.

Overrides:
environmentNowScape in class ScapeTransitionPanelView

environmentNowNoScape

public void environmentNowNoScape()
Description copied from class: ScapeTransitionPanelView
Environment now no scape.

Overrides:
environmentNowNoScape in class ScapeTransitionPanelView

newChart

protected void newChart(int chartType)
New chart.

Parameters:
chartType - the chart type

recordingStopped

public void recordingStopped()
Description copied from interface: RecorderListener
Called by the recorder when all recording has stopped.

Specified by:
recordingStopped in interface RecorderListener

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

recordingStarted

public void recordingStarted()
Description copied from interface: RecorderListener
Called by the recorder when recording has begun, and we are waiting for the next frame.

Specified by:
recordingStarted in interface RecorderListener

recordingCancelStop

protected void recordingCancelStop()
Called to stop or cancel recording.


changeInFullScreen

public void changeInFullScreen()
Change in full screen.


getName

public java.lang.String getName()
Returns a name for the view as defined by set name.

Specified by:
getName in interface HasName
Overrides:
getName in class PanelView
Returns:
the name

setName

public void setName(java.lang.String name)
Sets the name of this view.

Overrides:
setName in class PanelView
Parameters:
name - a user relevant name for this view

getAddHistAction

public javax.swing.Action getAddHistAction()
Gets the add hist action.

Returns:
the add hist action

getAddPieAction

public javax.swing.Action getAddPieAction()
Gets the add pie action.

Returns:
the add pie action

getAddTSAction

public javax.swing.Action getAddTSAction()
Gets the add TS action.

Returns:
the add TS action

getInfoAction

public javax.swing.Action getInfoAction()
Gets the info action.

Returns:
the info action

getCloseAction

public javax.swing.Action getCloseAction()
Gets the close action.

Returns:
the close action

getOpenAction

public javax.swing.Action getOpenAction()
Gets the open action.

Returns:
the open action

getOpenSavedAction

public javax.swing.Action getOpenSavedAction()
Gets the open saved action.

Returns:
the open saved action

getPauseResumeAction

public javax.swing.Action getPauseResumeAction()
Gets the pause resume action.

Returns:
the pause resume action

getQuitAction

public javax.swing.Action getQuitAction()
Gets the quit action.

Returns:
the quit action

getCaptureDeskAction

public javax.swing.Action getCaptureDeskAction()
Gets the capture desk action.

Returns:
the capture desk action

getRecordStartAction

public javax.swing.Action getRecordStartAction()
Gets the record start action.

Returns:
the record start action

getRecordStopAction

public javax.swing.Action getRecordStopAction()
Gets the record stop action.

Returns:
the record stop action

getSaveAction

public javax.swing.Action getSaveAction()
Gets the save action.

Returns:
the save action

getSettingsAction

public javax.swing.Action getSettingsAction()
Gets the settings action.

Returns:
the settings action

getSearchAction

public javax.swing.Action getSearchAction()
Gets the search action.

Returns:
the search action

getStartRestartAction

public javax.swing.Action getStartRestartAction()
Gets the start restart action.

Returns:
the start restart action

getStepAction

public javax.swing.Action getStepAction()
Gets the step action.

Returns:
the step action

getStopAction

public javax.swing.Action getStopAction()
Gets the stop action.

Returns:
the stop action

getFullWindowAction

public javax.swing.Action getFullWindowAction()
Gets the full window action.

Returns:
the full window action

getNormalWindowAction

public javax.swing.Action getNormalWindowAction()
Gets the normal window action.

Returns:
the normal window action

toString

public java.lang.String toString()
Returns a short description of this view. Sames as name unless overridden.

Overrides:
toString in class PanelView
Returns:
the string

scapeNotification

public void scapeNotification(ScapeEvent scapeEvent)
Description copied from class: ScapeTransitionPanelView
Notifies this view that something has happened on the scape. This view then has a chance to update itself, and this super method then notifies the scape that the view itself has been updated. By default, calls the onStart, updateScapeGraphics, or onStop method as appropriate, and then notifies scape.

Specified by:
scapeNotification in interface ScapeListener
Overrides:
scapeNotification in class ScapeTransitionPanelView
Parameters:
scapeEvent - a scape event update


Copyright © 1998-2008 The Brookings Institution, NuTech Solutions, Metascape, LLC All Rights Reserved.