edu.harvard.mgh.purcell.gCLINE
Class StartFrame

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 edu.harvard.mgh.purcell.gCLINE.StartFrame
All Implemented Interfaces:
java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible, javax.swing.RootPaneContainer, javax.swing.WindowConstants
Direct Known Subclasses:
TestFrame

public abstract class StartFrame
extends javax.swing.JFrame

General main window for the generalized command line gui.

Author:
Kathe Todd-Brown
See Also:
Serialized Form

Nested Class Summary
 class StartFrame.Download
          Download a set of files from a remote directory.
 class StartFrame.Upload
          Upload a set of files to a remote directory.
 
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
 java.awt.event.ActionListener closing
          An ActionListener that closers the gui.
protected  java.util.Vector<java.lang.String> filesInTransit
          A Vector that stores the files currently being transmited.
protected  FileView fileViewer
          A panel that views the associated log files.
 FolderView folderViewer
          A panel to view the files in your project folder.
protected  boolean isBrowseOnly
           
private static org.apache.log4j.Logger logger
          Optionally log messages.
 ErrorManager messanger
          The error manager for this gui.
protected  OpView opViewer
          A panel to look at the operation tree.
 java.awt.event.WindowListener properClosing
          A WindowListener that closes the gui properly.
protected  javax.swing.JLabel statusBar
          A label that informs weather files are in transit from or to a remote directory, this is shown at the lower right hand side.
 java.lang.String version
          The version number assocated with this gui.
 
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
StartFrame(java.lang.String name)
          Create a GUI.
 
Method Summary
private  void changeTransitFile(java.lang.String[] files, boolean addFile)
          Tell the file transfur status that there is a change in the files being transfered.
 boolean getBrowseOnly()
           
 boolean inTransit(java.lang.String f)
          Check to see if the file is in transit.
abstract  void layoutPanels()
          Layout the panels; fileView, FolderView, OpView and add the file transfure status note.
abstract  void setBrowseOnly(boolean state)
           
 void setFileViewer(java.io.File givenFile)
          Set the log file viewer.
private  void setStatus(java.lang.String message)
          Set the file transet status message.
protected abstract  void setVersion()
          Set the version number.
 
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, setResizable, 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, setVisible, 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
 

Field Detail

logger

private static org.apache.log4j.Logger logger
Optionally log messages.


fileViewer

protected FileView fileViewer
A panel that views the associated log files.


folderViewer

public FolderView folderViewer
A panel to view the files in your project folder.


opViewer

protected OpView opViewer
A panel to look at the operation tree.


version

public java.lang.String version
The version number assocated with this gui.


messanger

public ErrorManager messanger
The error manager for this gui.


statusBar

protected javax.swing.JLabel statusBar
A label that informs weather files are in transit from or to a remote directory, this is shown at the lower right hand side.


filesInTransit

protected java.util.Vector<java.lang.String> filesInTransit
A Vector that stores the files currently being transmited.


closing

public java.awt.event.ActionListener closing
An ActionListener that closers the gui.


properClosing

public java.awt.event.WindowListener properClosing
A WindowListener that closes the gui properly.


isBrowseOnly

protected boolean isBrowseOnly
Constructor Detail

StartFrame

public StartFrame(java.lang.String name)
Create a GUI.

Parameters:
name - A String that is the GUI name.
Method Detail

setVersion

protected abstract void setVersion()
Set the version number.


layoutPanels

public abstract void layoutPanels()
Layout the panels; fileView, FolderView, OpView and add the file transfure status note.


setBrowseOnly

public abstract void setBrowseOnly(boolean state)

getBrowseOnly

public boolean getBrowseOnly()

setFileViewer

public void setFileViewer(java.io.File givenFile)
Set the log file viewer.

Parameters:
givenFile - A File that we want to look at through the log file viewer.

setStatus

private void setStatus(java.lang.String message)
Set the file transet status message.

Parameters:
message - The String that we wish to set the transit status message to.

changeTransitFile

private void changeTransitFile(java.lang.String[] files,
                               boolean addFile)
Tell the file transfur status that there is a change in the files being transfered.

Parameters:
files - A String array that is the files we wish to add or remove from our transit vector.
addFile - A boolean flag that is true if we wish to add a file and false if we want to remove it.

inTransit

public boolean inTransit(java.lang.String f)
Check to see if the file is in transit.

Parameters:
f - The file name in transit.
Returns:
true if it is in transit, false otherwise.