sortie.tools.batchoutput.BatchOptionsDialog Class Reference

This class collects options needed for a data request for batch writing. More...

Inheritance diagram for sortie.tools.batchoutput.BatchOptionsDialog:

Public Member Functions
	BatchOptionsDialog (String sGraphName, OptionChoosingWindow oMaster, JPanel jPanel)
	Constructor. More...
void	actionPerformed (ActionEvent oEvent)
	Controls actions for this window. More...
String	getFilename ()
boolean	canceled ()
String	getGraphName ()
JPanel	getExtraOptionsPanel ()

Private Attributes
OptionChoosingWindow	m_oMaster
	Master calling window. More...
JPanel	m_jPanel
String	m_sGraphName
	Graph name string. More...
JTextField	m_jBatchFileEdit = new JTextField()
	Text field holding the root file path and name. More...
boolean	m_bCanceled = false
	Whether or not the user canceled the dialog. More...

Detailed Description

This class collects options needed for a data request for batch writing.

It accepts a panel of options so that a data request can add extra options to collect.

Constructor & Destructor Documentation

BatchOptionsDialog()

sortie.tools.batchoutput.BatchOptionsDialog.BatchOptionsDialog	(	String	sGraphName,
		OptionChoosingWindow	oMaster,
		JPanel	jPanel
	)

Constructor.

Creates the GUI that shows the user a request for a file name plus any optional additional controls.

Parameters

sGraphName	Graph name.
oMaster	Controlling window for this.
jPanel	Panel containing any extra controls (which should be named for later retrieval). Null is acceptable if there are no extra controls.

Member Function Documentation

actionPerformed()

void sortie.tools.batchoutput.BatchOptionsDialog.actionPerformed

(

ActionEvent

oEvent

)

Controls actions for this window.

This will not dispose of itself. That is up to the calling object.

Parameters

oEvent

ActionEvent.

canceled()

boolean sortie.tools.batchoutput.BatchOptionsDialog.canceled

(

)

getExtraOptionsPanel()

JPanel sortie.tools.batchoutput.BatchOptionsDialog.getExtraOptionsPanel

(

)

getFilename()

String sortie.tools.batchoutput.BatchOptionsDialog.getFilename

(

)

getGraphName()

String sortie.tools.batchoutput.BatchOptionsDialog.getGraphName

(

)

Member Data Documentation

m_bCanceled

boolean sortie.tools.batchoutput.BatchOptionsDialog.m_bCanceled = false

private

Whether or not the user canceled the dialog.

m_jBatchFileEdit

JTextField sortie.tools.batchoutput.BatchOptionsDialog.m_jBatchFileEdit = new JTextField()

private

Text field holding the root file path and name.

m_jPanel

JPanel sortie.tools.batchoutput.BatchOptionsDialog.m_jPanel

private

m_oMaster

OptionChoosingWindow sortie.tools.batchoutput.BatchOptionsDialog.m_oMaster

private

Master calling window.

m_sGraphName

String sortie.tools.batchoutput.BatchOptionsDialog.m_sGraphName

private

Graph name string.

---

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

• BatchOptionsDialog.java