javawrapper.DetailedOutputGridSetup Class Reference

Window the user uses to set up detailed output options for grids. More...

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

List of all members.

Public Member Functions

 DetailedOutputGridSetup (JDialog oParent, OutputBehaviors oOutput) throws ModelException
 Constructor.
void SaveAll ()
 Causes all possible grids and grid members to be saved for the run.
void actionPerformed (ActionEvent oEvent)
 Responds to button clicks.

Protected Member Functions

void DoRemove ()
 Removes the data members for a grid from the list of settings.
void DoAdd ()
 Adds the data members for a grid to the list of settings.
void jbInit () throws Exception
 Creates the window.
void LoadSettings ()
 Loads the settings from output into this form's temp array for display.
void UpdateSaves ()
 Displays what's being saved in each save list based on what's in mp_oDetailedTreeSaveSettings.

Protected Attributes

OutputBehaviors m_oOutputBehaviors
 OutputBehaviors object to exchange data with.
Vector< DetailedGridSettingsmp_oDetailedGridSaveSettings = new Vector<DetailedGridSettings>(0)
 For detailed output - collection of DetailedGridSettings objects representing the temp settings that changes will be made to.
Grid[] mp_oGridList
 List of grids to display.

Package Attributes

SORTIEComboBox m_jGridListCombo = new SORTIEComboBox()
 Combo box for displaying grid list.
JButton jAddButton = new JButton()
 Add button.
DefaultListModel jDataMemberListModel = new DefaultListModel()
 List for data members.
DefaultListModel jSaveListModel = new DefaultListModel()
 List for saving changes.
JTextField jTimestepsEdit = new JTextField()
 For getting the timestep saving interval.
JList jSavedList = new JList(jSaveListModel)
 List for saving changes.
GridBagLayout gridBagLayout1 = new GridBagLayout()
 Window layout.
JButton jRemoveButton = new JButton()
 Remove button.
JList jDataMemberList = new JList(jDataMemberListModel)
 List of grid data members.

Static Package Attributes

static final long serialVersionUID = 1

Private Attributes

String m_sHelpID = "windows.detailed_output_grid_setup"
 Help ID string.


Detailed Description

Window the user uses to set up detailed output options for grids.

A combo box displays a list of all grids set up by BehaviorTypeBase-descended objects. When the user chooses one of these grids, a list of all its data members and package data members appears so the user can choose what to save.

We have to have a way to tell the regular data members from the package data members. They are all displayed together, not in separate boxes; so we append a "(p)" flag to the beginning of package data member display names. A custom renderer splits it back off for display so the user doesn't see it; and it will also be split off before notifying the DetailedGridSettings object that it's been picked.

Copyright: Copyright (c) Charles D. Canham 2003

Company: Institute of Ecosystem Studies

Author:
Lora E. Murphy
Version:
1.0

Edit history:
------------------
April 28, 2004: Submitted in beta version (LEM)
January 17, 2007: Updated this to use both display names and code names of data members better (LEM)
February 4, 2008: Updated to conform to Java 6 compliance (LEM)

Constructor & Destructor Documentation

javawrapper.DetailedOutputGridSetup.DetailedOutputGridSetup ( JDialog  oParent,
OutputBehaviors  oOutput 
) throws ModelException

Constructor.

Builds the GUI.

Parameters:
oParent Parent dialog in which to display this dialog.
oOutput OutputBehaviors object, to draw data from to display and to send changes to
Exceptions:
ModelException passed through from underlying methods

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


Member Function Documentation

void javawrapper.DetailedOutputGridSetup.SaveAll (  ) 

Causes all possible grids and grid members to be saved for the run.

This can be called without the window's being visible. Its results are immediately applied to the output behavior - so this is not subject to a Cancel button.

Exceptions:
ModelException passed through from called methods.

void javawrapper.DetailedOutputGridSetup.actionPerformed ( ActionEvent  oEvent  ) 

Responds to button clicks.

Parameters:
oEvent The event telling us what button was clicked.

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

void javawrapper.DetailedOutputGridSetup.DoRemove (  )  [protected]

Removes the data members for a grid from the list of settings.


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

void javawrapper.DetailedOutputGridSetup.DoAdd (  )  [protected]

Adds the data members for a grid to the list of settings.


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

void javawrapper.DetailedOutputGridSetup.jbInit (  )  throws Exception [protected]

Creates the window.

Auto-generated except for tweaks by me.

Exceptions:
java.lang.Exception if something goes wrong with the window building.

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

void javawrapper.DetailedOutputGridSetup.LoadSettings (  )  [protected]

Loads the settings from output into this form's temp array for display.


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

void javawrapper.DetailedOutputGridSetup.UpdateSaves (  )  [protected]

Displays what's being saved in each save list based on what's in mp_oDetailedTreeSaveSettings.


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


Member Data Documentation

final long javawrapper.DetailedOutputGridSetup.serialVersionUID = 1 [static, package]

OutputBehaviors object to exchange data with.

For detailed output - collection of DetailedGridSettings objects representing the temp settings that changes will be made to.

Combo box for displaying grid list.

JButton javawrapper.DetailedOutputGridSetup.jAddButton = new JButton() [package]

Add button.

DefaultListModel javawrapper.DetailedOutputGridSetup.jDataMemberListModel = new DefaultListModel() [package]

List for data members.

DefaultListModel javawrapper.DetailedOutputGridSetup.jSaveListModel = new DefaultListModel() [package]

List for saving changes.

JTextField javawrapper.DetailedOutputGridSetup.jTimestepsEdit = new JTextField() [package]

For getting the timestep saving interval.

List for saving changes.

GridBagLayout javawrapper.DetailedOutputGridSetup.gridBagLayout1 = new GridBagLayout() [package]

Window layout.

List of grids to display.

JButton javawrapper.DetailedOutputGridSetup.jRemoveButton = new JButton() [package]

Remove button.

List of grid data members.

String javawrapper.DetailedOutputGridSetup.m_sHelpID = "windows.detailed_output_grid_setup" [private]

Help ID string.


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

Generated on Wed Oct 28 14:01:19 2009 for SORTIE Java Interface by  doxygen 1.5.6