javawrapper.TreeSpeciesSetup Class Reference

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

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

List of all members.

Public Member Functions

 TreeSpeciesSetup (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.

Protected Attributes

TreePopulation m_oPop
 TreePopulation object that data changes will be communicated to.
DefaultListModel m_jSpeciesListModel
 List model for species.
JList m_jSpeciesList
 List displaying the species.
Vector< RenamePairmp_oRenameSpecies = new Vector<RenamePair>(0)
 Vector of RenamePair objects, one for each species the user has asked to rename.
Vector< RenamePairmp_oCopySpecies = new Vector<RenamePair>(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.

Private Member Functions

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

Private Attributes

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

Classes

class  CopySpeciesEditor
 This class creates an interface for copying species. 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)
February 4, 2008: Updated to conform to Java 6 compliance (LEM)

Constructor & Destructor Documentation

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

Constructor.

Constructs and displays the GUI.

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


Member Function Documentation

void javawrapper.TreeSpeciesSetup.MoveUp (  )  [private]

Moves selected species up.

void javawrapper.TreeSpeciesSetup.MoveDown (  )  [private]

Moves selected species down.

void javawrapper.TreeSpeciesSetup.AddSpecies (  )  [protected]

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

void javawrapper.TreeSpeciesSetup.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.TreeSpeciesSetup.RenameSpecies (  )  [protected]

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

int javawrapper.TreeSpeciesSetup.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.

void javawrapper.TreeSpeciesSetup.actionPerformed ( ActionEvent  oEvent  ) 

Controls actions for this window.

Parameters:
oEvent ActionEvent.


Member Data Documentation

TreePopulation object that data changes will be communicated to.

List model for species.

List displaying the species.

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

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

Field for entering a new species name.

String javawrapper.TreeSpeciesSetup.m_sHelpID = "windows.edit_species_list_window" [private]

Help ID string.


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

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