javawrapper.BatchSetup Class Reference

Window for working with batch files. More...

Inherits javax::swing::JDialog, and java::awt::event::ActionListener.

List of all members.

Public Member Functions

 BatchSetup (JFrame jParent, GUIManager oManager)
 Constructor.
 BatchSetup (JFrame jParent, GUIManager oManager, String sBatchFile) throws ModelException
 Constructor.
void actionPerformed (ActionEvent oEvent)
 Controls actions for this window.
void AddParFile (String sParFileName, int iNumTimesToRun)
 Adds a new parameter file to the list for this batch.

Private Member Functions

void AddFile ()
 Adds a parameter file and number of times to the batch list.
void WriteFile () throws ModelException
 Writes the batch file.

Private Attributes

GUIManager m_oManager
 GUI Manager.
DefaultListModel m_jParFilesListModel
 List model of parameter files currently added to file.
JList m_jParFilesList
 List of parameter files currently added to file.
JTextField m_jParFileEdit = new JTextField()
 Text field holding a proposed parameter file path and name.
JTextField m_jBatchFileEdit = new JTextField()
 Text field holding the batch file path and name.
JTextField m_jNumTimesToRun = new JTextField()
 Holds number of times to run a parameter file.
String m_sHelpID = "windows.batch_setup_window"
 Help topic ID.


Detailed Description

Window for working with batch files.

Copyright: Copyright (c) Charles D. Canham 2005

Company: Institute of Ecosystem Studies

Author:
Lora E. Murphy
Version:
1.0
Edit history:
------------------
March 31, 2005: Created (LEM)
May 26, 2006: Improved - changed some things that annoyed me (LEM)
April 5, 2007: Support for multi-file select (LEM)
February 4, 2008: Updated to conform to Java 6 compliance (LEM)

Constructor & Destructor Documentation

javawrapper.BatchSetup.BatchSetup ( JFrame  jParent,
GUIManager  oManager 
)

Constructor.

Creates the window and displays it.

Parameters:
jParent JFrame Parent frame for this dialog.
oManager GUIManager object.

javawrapper.BatchSetup.BatchSetup ( JFrame  jParent,
GUIManager  oManager,
String  sBatchFile 
) throws ModelException

Constructor.

This reads an existing batch file in so it can be edited.

Parameters:
jParent JFrame Parent frame for this dialog.
oManager GUIManager object.
sBatchFile String Batch filename.
Exceptions:
ModelException Wrapping parse exceptions.


Member Function Documentation

void javawrapper.BatchSetup.actionPerformed ( ActionEvent  oEvent  ) 

Controls actions for this window.

Parameters:
oEvent ActionEvent.

Edit history:
------------------
April 28, 2004: Submitted in beta version (LEM)

void javawrapper.BatchSetup.AddFile (  )  [private]

Adds a parameter file and number of times to the batch list.

This alerts the user if anything's missing or the data cannot be understood.

void javawrapper.BatchSetup.WriteFile (  )  throws ModelException [private]

Writes the batch file.

Exceptions:
ModelException wrapping an IOException.

void javawrapper.BatchSetup.AddParFile ( String  sParFileName,
int  iNumTimesToRun 
)

Adds a new parameter file to the list for this batch.

Parameters:
sParFileName String Filename of new parameter file.
iNumTimesToRun int Number of times to run the file.


Member Data Documentation

GUI Manager.

DefaultListModel javawrapper.BatchSetup.m_jParFilesListModel [private]

List model of parameter files currently added to file.

List of parameter files currently added to file.

JTextField javawrapper.BatchSetup.m_jParFileEdit = new JTextField() [private]

Text field holding a proposed parameter file path and name.

JTextField javawrapper.BatchSetup.m_jBatchFileEdit = new JTextField() [private]

Text field holding the batch file path and name.

JTextField javawrapper.BatchSetup.m_jNumTimesToRun = new JTextField() [private]

Holds number of times to run a parameter file.

String javawrapper.BatchSetup.m_sHelpID = "windows.batch_setup_window" [private]

Help topic ID.


The documentation for this class was generated from the following file:

Generated on Tue Apr 19 13:59:36 2011 for SORTIE Java Interface by  doxygen 1.5.6