javawrapper.TreeSetup Class Reference

Dialog allowing the user to set up basic tree information. More...

List of all members.

Public Member Functions

 TreeSetup (JFrame jParent, TreePopulation oPop)
 Constructor.
void actionPerformed (ActionEvent oEvent)
 Controls actions for this window.

Protected Member Functions

void AddSpecies ()
 Performs a species add in response to the Add button click.
void RemoveSpecies ()
 Removes a species.
void RenameSpecies ()
 Puts a species to rename in the list of renamed species, and updates the species list.
int UpdateTreePopulation () throws ModelException
 Updates the TreePopulation object with the accumulated changes.
void WriteTreeMap () throws ModelException
 Writes the tree map trees to a tab-delimited text file.

Protected Attributes

TreePopulation m_oPop
 TreePopulation object that data changes will be communicated to.
DefaultListModel m_jSpeciesListModel
 List model for species.
DefaultListModel m_jSizeClassListModel
 List model for size classes.
JList m_jSpeciesList
 List displaying the species.
java.util.Vector mp_oRenameSpecies = new java.util.Vector(0)
 Vector of RenamePair objects, one for each species the user has asked to rename.
java.util.Vector mp_oCopySpecies = new java.util.Vector(0)
 Vector of RenamePair objects, one for each species the user has asked to copy.
JTextField m_jNewSpecies
 Field for entering a new species name.
JButton m_jClearTreeMap
 Button for clearing tree map trees.
JButton m_jWriteTreeMap
 Button for writing a tree map as tab-delimited text.

Private Member Functions

void MoveUp ()
 Moves selected species up.
void MoveDown ()
 Moves selected species down.

Private Attributes

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

Classes

class  CopySpeciesEditor
 This class creates an interface for copying species. More...
class  SizeClassEditor
 Displays dialog for entering size class data. More...


Detailed Description

Dialog allowing the user to set up basic tree information.

This includes the species list and initial density size classes.

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)
June 21, 2004: Added support to write tree maps as tab-delimited text (LEM)
November 3, 2005: Added a "Rename" button for species (LEM)
January 11, 2007: Added a "Copy" button for species (LEM)


Constructor & Destructor Documentation

javawrapper.TreeSetup.TreeSetup ( JFrame  jParent,
TreePopulation  oPop 
)

Constructor.

Constructs and displays the GUI.

Parameters:
jParent Parent window in which to display this dialog.
oPop TreePopulation object.

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


Member Function Documentation

void javawrapper.TreeSetup.MoveUp (  )  [private]

Moves selected species up.

void javawrapper.TreeSetup.MoveDown (  )  [private]

Moves selected species down.

void javawrapper.TreeSetup.AddSpecies (  )  [protected]

Performs a species add in response to the Add button click.


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

void javawrapper.TreeSetup.RemoveSpecies (  )  [protected]

Removes a species.

This verifiies the remove operation. Then, if valid, removes the species. This will also make sure that any rename or copy pairs featuring the removed species are also removed.

void javawrapper.TreeSetup.RenameSpecies (  )  [protected]

Puts a species to rename in the list of renamed species, and updates the species list.

int javawrapper.TreeSetup.UpdateTreePopulation (  )  throws ModelException [protected]

Updates the TreePopulation object with the accumulated changes.

Exceptions:
ModelException if there are no species present.
Returns:
int; if 0, close the window. If anything else, don't.

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

void javawrapper.TreeSetup.actionPerformed ( ActionEvent  oEvent  ) 

Controls actions for this window.

Parameters:
oEvent ActionEvent.

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

void javawrapper.TreeSetup.WriteTreeMap (  )  throws ModelException [protected]

Writes the tree map trees to a tab-delimited text file.

It first displays to the user a dialog for specifying the file name. It then organizes a 2-D array of strings for all possible tree data members that have been defined. Each tree contributes its applicable values to the table. Then the table is written out.

Exceptions:
ModelException if the file cannot be written.


Member Data Documentation

TreePopulation javawrapper.TreeSetup.m_oPop [protected]

TreePopulation object that data changes will be communicated to.

DefaultListModel javawrapper.TreeSetup.m_jSpeciesListModel [protected]

List model for species.

DefaultListModel javawrapper.TreeSetup.m_jSizeClassListModel [protected]

List model for size classes.

JList javawrapper.TreeSetup.m_jSpeciesList [protected]

List displaying the species.

java.util.Vector javawrapper.TreeSetup.mp_oRenameSpecies = new java.util.Vector(0) [protected]

Vector of RenamePair objects, one for each species the user has asked to rename.

java.util.Vector javawrapper.TreeSetup.mp_oCopySpecies = new java.util.Vector(0) [protected]

Vector of RenamePair objects, one for each species the user has asked to copy.

JTextField javawrapper.TreeSetup.m_jNewSpecies [protected]

Field for entering a new species name.

JButton javawrapper.TreeSetup.m_jClearTreeMap [protected]

Button for clearing tree map trees.

JButton javawrapper.TreeSetup.m_jWriteTreeMap [protected]

Button for writing a tree map as tab-delimited text.

String javawrapper.TreeSetup.m_sHelpID = "windows.tree_setup_window" [private]

Help ID string.


The documentation for this class was generated from the following file:
Generated on Fri Feb 1 10:52:17 2008 for SORTIE Java Interface by  doxygen 1.5.2