Class CvtGUI

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 CvtGUI
All Implemented Interfaces:
java.awt.event.ActionListener, java.awt.event.ItemListener, java.awt.event.WindowListener, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, java.util.EventListener, javax.accessibility.Accessible, javax.swing.RootPaneContainer, javax.swing.WindowConstants

public class CvtGUI
extends javax.swing.JFrame
implements java.awt.event.ItemListener, java.awt.event.ActionListener, java.awt.event.WindowListener

Class CvtGUI is used to create a popup GUI to run the converter.

 List of Methods
=================== CvtGUI() - Constructor initGUI() - create the popup GUI addMenuTree() - create pull down menus in menu bar for the GUI processGuiStateData() - Process data specified by the GUI state setCancelFlag() - set the Cancel flag value getCancelFlag() - get the Cancel flag value setEnableAssignButtonsAndMenus() - set Assign buttons & menus state setEnableProcessingButtonsAndMenus() - when are able to start processing state setEnableCancelButtonsAndMenus() - when are able to do processing state setEnableViewingButtonsAndMenus() - when can view processed HTML files state positionReportWindow() - position report window on the screen setShow() - set the show/hide popup status updateReportStatusLine() - clear text in popup window clearText() - clear text in popup window getReportText() - get the text from the Report popup window setReportText() - update text in popup window setGUItitle() - update title in popup window setSaveAsFile() - set SaveAs file default file name close() - close this popup and reset flags if needed testAndSetProjDir() - [DEPRICATE] test and set project directory cvt.userDir. actionPerformed() - Handle menu actions and button clicks printGuiFSM() - print GuiFSM if printFlag set printGuiFSMlf() - print GuiFSM if printFlag set followed by extra line feed getGuiFSM() - Get the GUI FSM state string. clearGuiProcessingState() - clear the GUI state setCancelFlag() - set the Cancel flag value getCancelFlag() - get the Cancel flag value setEnableAssignState() - set Assign buttons & menus state. setEnableProcessingState() - when are able to start processing state. setEnableCancelState() - when are able to do processing state. getListGeneratedHTMLfileNames() - list the generated HTML file names. pickGeneratedHTMLfileName() - list the generated HTML file names. quit() - closing down the window, get rid of the frame. itemStateChanged() - handle item state changed events viewHTMLfile() - popup browser on guiActiveHTMLfile file. windowClosing() - closing down the window, get rid of the frame.

This code is available at the HTMLtools project on SourceForge at http://htmltools.sourceforge.org/ under the "Common Public License Version 1.0" http://www.opensource.org/licenses/cpl1.0.php.

It was derived and refactored from the open source MAExplorer (http://maexplorer.sourceforge.org/), and Open2Dprot (http://Open2Dprot.sourceforge.net/) Table modules.

$Date: 2009/08/18 11:45:56 $ $Revision: 1.31 $
Copyright 2008, 2009 by Peter Lemkin E-Mail: lemkin@users.sourceforge.net http://lemkingroup.com/

See Also:
Serialized Form

Nested Class Summary
 
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
 javax.swing.JButton cancelButton
          button for "Cancel" button - may enable/disable button
 boolean cancelFlag
          "Cancel" the processing in the GUI
 boolean closeGuiFlag
          "Close" the GUI
 HTMLtools cvt
           
 boolean doneFlag
          "Done" processing data in the GUI
private  java.awt.Menu fileMenu
          "File" pull down Menu list
private  CvtGUI gui
          May need to define so can pass to InvokeLater methods
 java.lang.String guiActiveHTMLfile
           
 java.lang.String[] guiArgV
          Command line string array created to use when running the converter used by ProcessData
 java.lang.String guiBatchDoItFile
          GUI Converter -batch DoIt file
 java.lang.String guiFSMstate
          GUI FSM state
 java.lang.String guiParamsMapFile
          GUI Converter params map file
private  java.awt.Menu helpMenu
          "Help" pull down Menu list
private  java.awt.MenuBar mbar
          menu bar for the frame
private  MenuSupport ms
          Menu support functions using Hashtables to track what is active
private  int nCols
          # of character cols to show
private  int nRows
          # of character rows to show
 ProcessData pd
          Thread for converter processing
 boolean printFSMflag
          print FSM debug statements in printGuiFSM()
 javax.swing.JButton processButton
          button for "Process" button - may enable/disable button
 boolean processedOKflag
          "Process was ok" if true.
 boolean processFlag
          "Processing" data in the GUI
private  java.lang.String programName
          The name of the program
private  java.lang.String reportFile
          default SAVE AS .txt file for textReport data.
private  javax.swing.JButton resetButton
          button for "Reset" GUI button
static long serialVersionUID
           
 java.lang.String sGuiArgV
          Command line string created to use when running the converter used by ProcessData
 boolean showStatusFlag
           
private  javax.swing.JLabel statusLineLabel
          Status line label updated with UtilCM.updateReportStatusLine()
private  javax.swing.JTextArea textarea
          Text area GUI for main report
private  int textAreaFontSize
          font size
private  java.lang.String textFontFamily
          Text area font family
private  java.lang.String textReport
          copy of text in textArea
private  java.lang.String title
          string for title of frame
private  java.awt.CheckboxMenuItem verboseMCB
          Menu checkbox item
private  java.lang.String version
          version number of the program
private  java.awt.Choice viewHTMLchoice
           
 
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
CvtGUI(HTMLtools cvt, java.lang.String programName, java.lang.String version, java.lang.String textReport, int nRows, int nCols, java.lang.String title, java.lang.String reportFile, boolean showStatusFlag)
          CvtGUI() - Constructor
 
Method Summary
 void actionPerformed(java.awt.event.ActionEvent e)
          actionPerformed() - Handle menu actions and button clicks
private  void addMenuTree(java.awt.Frame f, java.awt.MenuBar mbar)
          addMenuTree() - create pull down menus in menu bar for the GUI
 void clearGuiProcessingState()
          clearGuiProcessingState() - clear the GUI state
 void clearText()
          clearText() - clear text in popup window
 void close()
          close() - close this popup and reset flags if needed
 boolean getCancelFlag()
          getCancelFlag() - get the Cancel flag value
 java.lang.String getGuiFSM()
          getGuiFSM() - Get the GUI FSM state string.
 java.lang.String getListGeneratedHTMLfileNames()
          getListGeneratedHTMLfileNames() - get string list the generated HTML file names.
 java.lang.String getReportText()
          getReportText() - get the text from the Report popup window
 boolean initGUI()
          initGUI() - create the popup GUI
 void itemStateChanged(java.awt.event.ItemEvent e)
          itemStateChanged() - handle item state changed events NOTE: need to implement radio groups here since AWT only implements radio groups for Checkboxes, and CheckboxMenuItems.
 java.lang.String pickGeneratedHTMLfileName(int rowNbr)
          pickGeneratedHTMLfileName() - list the generated HTML file names.
 void positionReportWindow()
          positionReportWindow() - position report window on the screen
 void printGuiFSM(java.lang.String preface, boolean printFlag)
          printGuiFSM() - print GuiFSM if printFlag set
 void printGuiFSMlf(java.lang.String preface, boolean printFlag)
          printGuiFSMlf() - print GuiFSM if printFlag set followed by extra line feed
private  boolean processGuiStateData()
          processGuiStateData() - Process data specified by the GUI state.
 void quit()
          quit() - closing down the window, get rid of the frame.
 void setCancelFlag(boolean flag)
          setCancelFlag() - set the Cancel flag value
 void setEnableAssignButtonsAndMenus()
          setEnableAssignButtonsAndMenus() - set Assign buttons & menus state.
 void setEnableAssignState()
          setEnableAssignState() - set Assign buttons & menus state.
 void setEnableCancelButtonsAndMenus(java.lang.String statusLabel)
          setEnableCancelButtonsAndMenus() - when are able to do processing state.
 void setEnableCancelState()
          setEnableCancelState() - when are able to do processing state.
 void setEnableProcessingButtonsAndMenus(java.lang.String statusLabel)
          setEnableProcessingButtonsAndMenus() - when able to start processing state.
 void setEnableProcessingState()
          setEnableProcessingState() - when are able to start processing state.
 void setEnableViewingButtonsAndMenus()
          setEnableViewingButtonsAndMenus() - when can view processed HTML files state.
 void setEnableViewingState()
          setEnableViewingState() - when can view processed HTML files state.
 void setGUItitle(java.lang.String title)
          setGUItitle() - update title in popup window
 void setReportText(java.lang.String newText)
          setReportText() - update text in popup window
 void setSaveAsFile(java.lang.String reportFile)
          setSaveAsFile() - set SaveAs file default file name
 void setShow(boolean showStatusFlag)
          setShow() - set the show/hide popup status
 java.lang.String testAndSetProjDir(java.lang.String testProjDir, boolean fatalFlag)
          testAndSetProjDir() - [DEPRICATE] test and set project directory cvt.userDir.
 void updateReportStatusLine(java.lang.String msg)
          updateReportStatusLine() - clear text in popup window
private  boolean viewHTMLfile()
          viewHTMLfile() - popup browser on guiActiveHTMLfile file.
 void windowActivated(java.awt.event.WindowEvent e)
           
 void windowClosed(java.awt.event.WindowEvent e)
           
 void windowClosing(java.awt.event.WindowEvent e)
          windowClosing() - closing down the window, get rid of the frame.
 void windowDeactivated(java.awt.event.WindowEvent e)
           
 void windowDeiconified(java.awt.event.WindowEvent e)
           
 void windowIconified(java.awt.event.WindowEvent e)
           
 void windowOpened(java.awt.event.WindowEvent e)
           
 
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

serialVersionUID

public static final long serialVersionUID
See Also:
Constant Field Values

gui

private CvtGUI gui
May need to define so can pass to InvokeLater methods


cvt

public HTMLtools cvt

title

private java.lang.String title
string for title of frame


programName

private java.lang.String programName
The name of the program


version

private java.lang.String version
version number of the program


mbar

private java.awt.MenuBar mbar
menu bar for the frame


fileMenu

private java.awt.Menu fileMenu
"File" pull down Menu list


helpMenu

private java.awt.Menu helpMenu
"Help" pull down Menu list


ms

private MenuSupport ms
Menu support functions using Hashtables to track what is active


verboseMCB

private java.awt.CheckboxMenuItem verboseMCB
Menu checkbox item


textReport

private java.lang.String textReport
copy of text in textArea


reportFile

private java.lang.String reportFile
default SAVE AS .txt file for textReport data.


showStatusFlag

public boolean showStatusFlag

textarea

private javax.swing.JTextArea textarea
Text area GUI for main report


textAreaFontSize

private int textAreaFontSize
font size


nRows

private int nRows
# of character rows to show


nCols

private int nCols
# of character cols to show


textFontFamily

private java.lang.String textFontFamily
Text area font family


processButton

public javax.swing.JButton processButton
button for "Process" button - may enable/disable button


cancelButton

public javax.swing.JButton cancelButton
button for "Cancel" button - may enable/disable button


resetButton

private javax.swing.JButton resetButton
button for "Reset" GUI button


viewHTMLchoice

private java.awt.Choice viewHTMLchoice

statusLineLabel

private javax.swing.JLabel statusLineLabel
Status line label updated with UtilCM.updateReportStatusLine()


pd

public ProcessData pd
Thread for converter processing


processFlag

public volatile boolean processFlag
"Processing" data in the GUI


processedOKflag

public volatile boolean processedOKflag
"Process was ok" if true. Set to false if any problems.


doneFlag

public volatile boolean doneFlag
"Done" processing data in the GUI


closeGuiFlag

public volatile boolean closeGuiFlag
"Close" the GUI


cancelFlag

public volatile boolean cancelFlag
"Cancel" the processing in the GUI


guiFSMstate

public volatile java.lang.String guiFSMstate
GUI FSM state


printFSMflag

public volatile boolean printFSMflag
print FSM debug statements in printGuiFSM()


guiBatchDoItFile

public volatile java.lang.String guiBatchDoItFile
GUI Converter -batch DoIt file


guiParamsMapFile

public volatile java.lang.String guiParamsMapFile
GUI Converter params map file


guiActiveHTMLfile

public volatile java.lang.String guiActiveHTMLfile

sGuiArgV

public volatile java.lang.String sGuiArgV
Command line string created to use when running the converter used by ProcessData


guiArgV

public volatile java.lang.String[] guiArgV
Command line string array created to use when running the converter used by ProcessData

Constructor Detail

CvtGUI

public CvtGUI(HTMLtools cvt,
              java.lang.String programName,
              java.lang.String version,
              java.lang.String textReport,
              int nRows,
              int nCols,
              java.lang.String title,
              java.lang.String reportFile,
              boolean showStatusFlag)
CvtGUI() - Constructor

Parameters:
cvt - is an instance of the HTMLtools class
programName - name of the program
version - - of program
textReport - is initial text string for buffer.
nRows - is maximum size of window
nCols, - is maximum size of window
title - of the window
String - reportFile is default SAVE AS .txt file. Default "log.txt"
showStatusFlag - to show (true), hide(false).
Method Detail

initGUI

public boolean initGUI()
initGUI() - create the popup GUI

Returns:
true if succeed

addMenuTree

private void addMenuTree(java.awt.Frame f,
                         java.awt.MenuBar mbar)
addMenuTree() - create pull down menus in menu bar for the GUI

Parameters:
f - is frame
mbar - is MenuBar

processGuiStateData

private boolean processGuiStateData()
processGuiStateData() - Process data specified by the GUI state. This is called from the "Process" event-handler for the button and menu handler.

Returns:
true if succeed, false if any problems after write err msg to window

setEnableAssignButtonsAndMenus

public void setEnableAssignButtonsAndMenus()
setEnableAssignButtonsAndMenus() - set Assign buttons & menus state. This sets the flags to the initial "Assign" data state.


setEnableProcessingButtonsAndMenus

public void setEnableProcessingButtonsAndMenus(java.lang.String statusLabel)
setEnableProcessingButtonsAndMenus() - when able to start processing state. This sets the flags to the "Process-enable" data state.

Parameters:
statusLabel - to use for Report status line.

setEnableCancelButtonsAndMenus

public void setEnableCancelButtonsAndMenus(java.lang.String statusLabel)
setEnableCancelButtonsAndMenus() - when are able to do processing state. This sets the flags to the "Process" data state. It also clears the list of generated HTML files.

Parameters:
statusLabel - to use for Report status line.

setEnableViewingButtonsAndMenus

public void setEnableViewingButtonsAndMenus()
setEnableViewingButtonsAndMenus() - when can view processed HTML files state. This sets the flags to the "Viewing-enable" data state.


positionReportWindow

public void positionReportWindow()
positionReportWindow() - position report window on the screen


setShow

public void setShow(boolean showStatusFlag)
setShow() - set the show/hide popup status

Parameters:
showStatusFlag - to show (true), hide(false).

updateReportStatusLine

public void updateReportStatusLine(java.lang.String msg)
updateReportStatusLine() - clear text in popup window

Parameters:
msg - to display

clearText

public void clearText()
clearText() - clear text in popup window


getReportText

public java.lang.String getReportText()
getReportText() - get the text from the Report popup window

Returns:
text report

setReportText

public void setReportText(java.lang.String newText)
setReportText() - update text in popup window

Parameters:
newText - is string to copy into text window

setGUItitle

public void setGUItitle(java.lang.String title)
setGUItitle() - update title in popup window

Parameters:
title - is new title.

setSaveAsFile

public void setSaveAsFile(java.lang.String reportFile)
setSaveAsFile() - set SaveAs file default file name

Parameters:
reportFile - is new reportFile.

close

public void close()
close() - close this popup and reset flags if needed


testAndSetProjDir

public java.lang.String testAndSetProjDir(java.lang.String testProjDir,
                                          boolean fatalFlag)
testAndSetProjDir() - [DEPRICATE] test and set project directory cvt.userDir. If valid, then save it in cvt.userDir. [TODO] need to [DEBUG]

Parameters:
testProjDir - project directory
Returns:
projDir if succeed in finding the project directory, else null

actionPerformed

public void actionPerformed(java.awt.event.ActionEvent e)
actionPerformed() - Handle menu actions and button clicks

Specified by:
actionPerformed in interface java.awt.event.ActionListener
Parameters:
e - is action evet

printGuiFSM

public void printGuiFSM(java.lang.String preface,
                        boolean printFlag)
printGuiFSM() - print GuiFSM if printFlag set


printGuiFSMlf

public void printGuiFSMlf(java.lang.String preface,
                          boolean printFlag)
printGuiFSMlf() - print GuiFSM if printFlag set followed by extra line feed


getGuiFSM

public java.lang.String getGuiFSM()
getGuiFSM() - Get the GUI FSM state string.

Returns:
the current state string

clearGuiProcessingState

public void clearGuiProcessingState()
clearGuiProcessingState() - clear the GUI state


setCancelFlag

public void setCancelFlag(boolean flag)
setCancelFlag() - set the Cancel flag value

Parameters:
flag - value to set the cancelFlag

getCancelFlag

public boolean getCancelFlag()
getCancelFlag() - get the Cancel flag value


setEnableAssignState

public void setEnableAssignState()
setEnableAssignState() - set Assign buttons & menus state. This sets the flags to the initial "Assign" data state.


setEnableProcessingState

public void setEnableProcessingState()
setEnableProcessingState() - when are able to start processing state. This sets the flags to the "Process-enable" data state.


setEnableCancelState

public void setEnableCancelState()
setEnableCancelState() - when are able to do processing state. This sets the flags to the "Process" data state. It also clears the list of generated HTML files.


setEnableViewingState

public void setEnableViewingState()
setEnableViewingState() - when can view processed HTML files state. This sets the flags to the "Viewing-enable" data state.


getListGeneratedHTMLfileNames

public java.lang.String getListGeneratedHTMLfileNames()
getListGeneratedHTMLfileNames() - get string list the generated HTML file names.

Returns:
printable string.

pickGeneratedHTMLfileName

public java.lang.String pickGeneratedHTMLfileName(int rowNbr)
pickGeneratedHTMLfileName() - list the generated HTML file names.

Parameters:
rowNbr - to select (start at 0). If -1, pick the first entry, if rowNbr > size of list, pick the last entry in the list.
Returns:
s.guiActiveHTMLfile if successful, else null

quit

public void quit()
quit() - closing down the window, get rid of the frame.

See Also:
close()

itemStateChanged

public void itemStateChanged(java.awt.event.ItemEvent e)
itemStateChanged() - handle item state changed events NOTE: need to implement radio groups here since AWT only implements radio groups for Checkboxes, and CheckboxMenuItems.

Specified by:
itemStateChanged in interface java.awt.event.ItemListener
Parameters:
e - is ItemEvent

viewHTMLfile

private boolean viewHTMLfile()
viewHTMLfile() - popup browser on guiActiveHTMLfile file.

Returns:
true if succeed

windowClosing

public void windowClosing(java.awt.event.WindowEvent e)
windowClosing() - closing down the window, get rid of the frame.

Specified by:
windowClosing in interface java.awt.event.WindowListener
Parameters:
e - is window closing event
See Also:
close()

windowOpened

public void windowOpened(java.awt.event.WindowEvent e)
Specified by:
windowOpened in interface java.awt.event.WindowListener

windowActivated

public void windowActivated(java.awt.event.WindowEvent e)
Specified by:
windowActivated in interface java.awt.event.WindowListener

windowClosed

public void windowClosed(java.awt.event.WindowEvent e)
Specified by:
windowClosed in interface java.awt.event.WindowListener

windowDeactivated

public void windowDeactivated(java.awt.event.WindowEvent e)
Specified by:
windowDeactivated in interface java.awt.event.WindowListener

windowDeiconified

public void windowDeiconified(java.awt.event.WindowEvent e)
Specified by:
windowDeiconified in interface java.awt.event.WindowListener

windowIconified

public void windowIconified(java.awt.event.WindowEvent e)
Specified by:
windowIconified in interface java.awt.event.WindowListener