gcspy.vis
Class MainFrame

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 gcspy.vis.utils.AbstractFrame
                          extended by gcspy.vis.MainFrame
All Implemented Interfaces:
EventListener, PauseListener, EventFilterListener, SpaceManagerInterface, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible, javax.swing.RootPaneContainer, javax.swing.WindowConstants

public class MainFrame
extends AbstractFrame
implements SpaceManagerInterface, EventListener, PauseListener, EventFilterListener

Main frame of the visualiser

Author:
Tony Printezis, Richard Jones
See Also:
Serialized Form

Nested Class Summary
 
Nested classes/interfaces inherited from class gcspy.vis.utils.AbstractFrame
AbstractFrame.Position
 
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.BltBufferStrategy, java.awt.Component.FlipBufferStrategy
 
Field Summary
 
Fields inherited from class gcspy.vis.utils.AbstractFrame
bgHeight, bgWidth, BORDER_PADDING, TITLE_PADDING
 
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 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
MainFrame(java.lang.String host, int port, boolean small, boolean tiny, boolean pauseAtStart, boolean doConnect)
          Construct a new MainFrame
 
Method Summary
 void addDisconnectListener(DisconnectListener listener)
          Add a disconnect listener
 void addMagManagers(TileManager small, TileManager large)
          Add a magnification manager
 void addView(java.lang.Object obj)
          Add a view
 void clearViews()
          Clear all the views
 void event(int event, int elapsedTime, int compensationTime)
          Respond to an EVENT command from the server
 void eventFilterUpdated()
          An event filter has been updated
 java.util.List<PluginListener> getPluginListeners()
          Get the plugin's listeners for this space
 void pause()
          Handle a pause command
 void setActive(SpaceManager spaceManager)
          Activate a space
 void setActiveView(int streamID)
          Set the active stream
 void setBlockInfo(java.lang.String text)
          Set the block information
 void setVisible(boolean visible)
           
 void validateContainer()
          Validate the space manager's GUI
 
Methods inherited from class gcspy.vis.utils.AbstractFrame
destroy, placeIt, placeIt, setPositionalComponent, setResizable, showWarning, sufficientlyOffRight
 
Methods inherited from class javax.swing.JFrame
addImpl, createRootPane, frameInit, getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getJMenuBar, getLayeredPane, getRootPane, isDefaultLookAndFeelDecorated, isRootPaneCheckingEnabled, paramString, processWindowEvent, remove, setContentPane, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setIconImage, setJMenuBar, setLayeredPane, setLayout, setRootPane, setRootPaneCheckingEnabled, update
 
Methods inherited from class java.awt.Frame
addNotify, finalize, getCursorType, getExtendedState, getFrames, getIconImage, getMaximizedBounds, getMenuBar, getState, getTitle, isResizable, isUndecorated, remove, removeNotify, setCursor, setExtendedState, setMaximizedBounds, setMenuBar, setState, setTitle, setUndecorated
 
Methods inherited from class java.awt.Window
addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getGraphicsConfiguration, getInputContext, getListeners, getLocale, getMostRecentFocusOwner, getOwnedWindows, getOwner, getToolkit, getWarningString, getWindowFocusListeners, getWindowListeners, getWindowStateListeners, hide, isActive, isAlwaysOnTop, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isShowing, pack, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, setAlwaysOnTop, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setLocationByPlatform, setLocationRelativeTo, show, 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, paint, 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, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphics, 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, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, reshape, resize, resize, setBackground, setBounds, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setMaximumSize, setMinimumSize, setName, setPreferredSize, setSize, setSize, show, size, toString, transferFocus, transferFocusUpCycle
 
Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface java.awt.MenuContainer
getFont, postEvent
 

Constructor Detail

MainFrame

public MainFrame(java.lang.String host,
                 int port,
                 boolean small,
                 boolean tiny,
                 boolean pauseAtStart,
                 boolean doConnect)
Construct a new MainFrame

Parameters:
host - the server's hostname
port - The port on which to connect
small - True if small tiles are to be used
tiny - True if tiny tiles are to be used
pauseAtStart - true if the server is to pause at the start
doConnect - true if the visualiser is to connect
Method Detail

addDisconnectListener

public void addDisconnectListener(DisconnectListener listener)
Add a disconnect listener

Parameters:
listener - the listener

setVisible

public void setVisible(boolean visible)
Overrides:
setVisible in class AbstractFrame

setActive

public void setActive(SpaceManager spaceManager)
Description copied from interface: SpaceManagerInterface
Activate a space

Specified by:
setActive in interface SpaceManagerInterface
Parameters:
spaceManager - The space's manager

setBlockInfo

public void setBlockInfo(java.lang.String text)
Description copied from interface: SpaceManagerInterface
Set the block information

Specified by:
setBlockInfo in interface SpaceManagerInterface
Parameters:
text - The text for the block information

clearViews

public void clearViews()
Description copied from interface: SpaceManagerInterface
Clear all the views

Specified by:
clearViews in interface SpaceManagerInterface

addView

public void addView(java.lang.Object obj)
Description copied from interface: SpaceManagerInterface
Add a view

Specified by:
addView in interface SpaceManagerInterface
Parameters:
obj - The object to add to the views combo box

setActiveView

public void setActiveView(int streamID)
Description copied from interface: SpaceManagerInterface
Set the active stream

Specified by:
setActiveView in interface SpaceManagerInterface
Parameters:
streamID - the ID of the stream

addMagManagers

public void addMagManagers(TileManager small,
                           TileManager large)
Description copied from interface: SpaceManagerInterface
Add a magnification manager

Specified by:
addMagManagers in interface SpaceManagerInterface
Parameters:
small - The tile manager for the row of small tiles
large - The tile manager for the row of large tiles

eventFilterUpdated

public void eventFilterUpdated()
An event filter has been updated

Specified by:
eventFilterUpdated in interface EventFilterListener

event

public void event(int event,
                  int elapsedTime,
                  int compensationTime)
Description copied from interface: EventListener
Respond to an EVENT command from the server

Specified by:
event in interface EventListener
Parameters:
event - The event's ID
elapsedTime - the elapsed time for the event
compensationTime - The compensation time

pause

public void pause()
Description copied from interface: PauseListener
Handle a pause command

Specified by:
pause in interface PauseListener

validateContainer

public void validateContainer()
Description copied from interface: SpaceManagerInterface
Validate the space manager's GUI

Specified by:
validateContainer in interface SpaceManagerInterface

getPluginListeners

public java.util.List<PluginListener> getPluginListeners()
Description copied from interface: SpaceManagerInterface
Get the plugin's listeners for this space

Specified by:
getPluginListeners in interface SpaceManagerInterface
Returns:
a list of plugin listeners known to the space manager