SORTIE Java Interface  1
Public Member Functions | Protected Member Functions | Protected Attributes | Private Attributes | List of all members
sortie.gui.harvepplant.PlantingDisplayWindow Class Reference

Displays planting events and allows for editing. More...

Inheritance diagram for sortie.gui.harvepplant.PlantingDisplayWindow:
sortie.gui.harvepplant.DisplayWindowBase

Public Member Functions

 PlantingDisplayWindow (JFrame oOwner, DisturbanceBehaviors oDisturbanceBehaviors, PlantingBehaviors oPlantBehaviors) throws ModelException
 Constructor. More...
 
void actionPerformed (ActionEvent oEvent)
 Responds to window events. More...
 
- Public Member Functions inherited from sortie.gui.harvepplant.DisplayWindowBase
 DisplayWindowBase (JFrame oOwner, DisturbanceBehaviors oDisturbanceBehaviors, PlantingBehaviors oPlantBehaviors, String sWindowTitle, windowType iWinType) throws ModelException
 Constructor. More...
 
void actionPerformed (ActionEvent oEvent)
 Responds to window events. More...
 
TreePopulation getTreePopulation ()
 Gets access to the tree population for benefit of child windows. More...
 
HelpBroker getHelpBroker ()
 Gets access to the HelpBroker object for benefit of child windows. More...
 

Protected Member Functions

void makeGUI () throws ModelException
 Draws the window. More...
 
void displayNextPlanting () throws ModelException
 Displays the next planting event when the ">>" button is pressed. More...
 
void displayPreviousPlanting () throws ModelException
 Displays the next plant event when the previous button is pressed. More...
 
void deletePlanting () throws ModelException
 Deletes the currently displayed planting. More...
 
void displayPlanting (PlantingData oPlanting) throws ModelException
 Causes a planting event to be displayed in the window. More...
 
void addFinishedData () throws ModelException
 Takes the final data and adds it back to the behavior groups. More...
 
- Protected Member Functions inherited from sortie.gui.harvepplant.DisplayWindowBase
void setUpCharting (windowType iWinType) throws ModelException
 Sets up the chart and displays any trees. More...
 
void replaceChart ()
 Replace the chart when it needs to be refreshed. More...
 
void makeTreeDatasetAndRenderer () throws ModelException
 Create the dataset and renderer for the trees. More...
 
void getPlotAndGridInfo (windowType iWinType) throws ModelException
 Gets information on the plot and the grids. More...
 
JPanel makeLegendPanel () throws ModelException
 Creates a legend panel. More...
 
JDialog sizeChildWindow (JDialog jChildWindow)
 Sizes a child window to fit within the bounds of this window. More...
 
void addFinishedData () throws ModelException
 Takes the final data and adds it back to the behavior groups. More...
 

Protected Attributes

float [] mp_fPlantInitialDiam10s
 Copy of the planting initial diameter at 10 cm values. More...
 
JLabel mp_jSpeciesPlantPercentages []
 Array of labels displaying species percentages for the current planting. More...
 
JLabel mp_jSpeciesPlantInitialDiam10 []
 Array of labels displaying the initial diam10 for each species for all plantings. More...
 
JLabel m_jTimestepLabel = new JLabel("N/A")
 Label that displays the timestep for the currently displayed planting. More...
 
JLabel m_jSpacingLabel = new JLabel("N/A")
 Label that displays the plant spacing for the currently displayed planting. More...
 
JLabel m_jAmountLabel = new JLabel("Density (#/ha):")
 Label that displays the plant amount label for the currently displayed planting. More...
 
JLabel m_jAmountValueLabel = new JLabel("N/A")
 Label that displays the plant amount value for the currently displayed planting. More...
 
JLabel m_jNumPlantingEvents = new JLabel("0")
 Label that displays number of planting events currently defined. More...
 
JLabel m_jPlantNumber = new JLabel("0")
 Label that displays the number of the current planting event. More...
 
- Protected Attributes inherited from sortie.gui.harvepplant.DisplayWindowBase
DefaultXYZDataset m_oTreeDataset = new DefaultXYZDataset()
 A dataset for trees, one series for each species. More...
 
XYTreeRenderer m_oTreeRenderer
 Renderer for displaying the trees along with episodic event data. More...
 
XYPlot m_oPlot = new XYPlot()
 Plot object for rendering events. More...
 
XYZSimpleDataset m_oDataset
 Dataset for displaying harvest events - controls which cells show up which color. More...
 
XYSimpleCellRenderer m_oRenderer = new XYSimpleCellRenderer()
 Renderer for displaying harvest events. More...
 
DisturbanceBehaviors m_oDisturbanceBehaviors
 DisturbanceBehaviors object to exchange data with. More...
 
PlantingBehaviors m_oPlantBehaviors
 PlantingBehaviors object to exchange data with. More...
 
ArrayList< HarvestDatamp_oHarvestData = new ArrayList<HarvestData>(0)
 Copy of harvest data to display. More...
 
ArrayList< HarvestDatamp_oMortEpisodeData = new ArrayList<HarvestData>(0)
 Copy of mortality episode data to display. More...
 
ArrayList< PlantingDatamp_oPlantingData = new ArrayList<PlantingData>(0)
 Copy of planting data to display. More...
 
JPanel m_jChartPanel = new JPanel()
 Panel displaying the chart. More...
 
Dimension m_jParentSize
 Size of the parent calling window - so we can make sure children fit within this. More...
 
float m_fLengthXCells
 Length of grid cells in the X direction. More...
 
float m_fLengthYCells
 Length of grid cells in the Y direction. More...
 
int m_iNumXCells
 Number of X cells in the grid. More...
 
int m_iNumYCells
 Number of Y cells in the grid. More...
 
int m_iPlotLengthX
 Length of the plot in the X direction, in meters. More...
 
int m_iPlotLengthY
 Length of the plot in the Y direction, in meters. More...
 
int m_iNumSpecies
 Number of species. More...
 

Private Attributes

String m_sHelpID = "windows.edit_planting_window"
 Help ID string. More...
 

Additional Inherited Members

- Static Public Attributes inherited from sortie.gui.harvepplant.DisplayWindowBase
static final Color HARVEST_COLOR = new Color(255, 100, 255)
 Color for displaying harvests. More...
 
static final Color PLANT_COLOR = new Color(255, 255, 100)
 Color for displaying plantings. More...
 
static final Color MORTALITY_EPISODE_COLOR = new Color(150, 225, 225)
 Color for displaying mortality episode events. More...
 

Detailed Description

Displays planting events and allows for editing.

Copyright: Copyright (c) Charles D. Canham 2003

Company: Cary Institute of Ecosystem Studies

Author
Lora E. Murphy
Version
1.0
Edit history:
---------------—
May 23, 2013: Created (LEM)

Constructor & Destructor Documentation

◆ PlantingDisplayWindow()

sortie.gui.harvepplant.PlantingDisplayWindow.PlantingDisplayWindow ( JFrame  oOwner,
DisturbanceBehaviors  oDisturbanceBehaviors,
PlantingBehaviors  oPlantBehaviors 
) throws ModelException

Constructor.

Builds the window.

Parameters
oOwnerOwner window for this dialog.
oDisturbanceBehaviorsDisturbanceBehaviors object to exchange data with.
oPlantBehaviorsPlantingBehaviors object to exchange data with.
Exceptions
ModelExceptionpassing through from called methods.

Member Function Documentation

◆ actionPerformed()

void sortie.gui.harvepplant.PlantingDisplayWindow.actionPerformed ( ActionEvent  oEvent)

Responds to window events.

Parameters
oEventEvent triggering this call.

◆ addFinishedData()

void sortie.gui.harvepplant.PlantingDisplayWindow.addFinishedData ( ) throws ModelException
protected

Takes the final data and adds it back to the behavior groups.

This takes the contents of mp_oHarvestData, mp_oMortEpisodeData, and mp_oPlantingData, and puts them back into the parent behavior groups. Then, if there is a set of data for any of the behaviors, it makes sure that they are enabled.

◆ deletePlanting()

void sortie.gui.harvepplant.PlantingDisplayWindow.deletePlanting ( ) throws ModelException
protected

Deletes the currently displayed planting.

If no planting is displayed (the display number is set to 0), nothing happens. If a planting is deleted, the next planting is displayed, or the previous one if it is the last.

Exceptions
ModelExceptionpassed through from called methods.

◆ displayNextPlanting()

void sortie.gui.harvepplant.PlantingDisplayWindow.displayNextPlanting ( ) throws ModelException
protected

Displays the next planting event when the ">>" button is pressed.

If the last planting is being displayed, then nothing changes.

Exceptions
ModelExceptionPassing through from called methods.

◆ displayPlanting()

void sortie.gui.harvepplant.PlantingDisplayWindow.displayPlanting ( PlantingData  oPlanting) throws ModelException
protected

Causes a planting event to be displayed in the window.

Planting events are displayed as a transparent texture - this allows harvests to display underneath.

Parameters
oPlantingPlanting to display, or NULL if no planting is to be displayed.
Exceptions
ModelExceptionpassing through from called methods.

◆ displayPreviousPlanting()

void sortie.gui.harvepplant.PlantingDisplayWindow.displayPreviousPlanting ( ) throws ModelException
protected

Displays the next plant event when the previous button is pressed.

If the first planting is being displayed, then nothing changes.

Exceptions
ModelExceptionPassing through from called methods.

◆ makeGUI()

void sortie.gui.harvepplant.PlantingDisplayWindow.makeGUI ( ) throws ModelException
protected

Draws the window.

Exceptions
ModelExceptionpassing through from called methods.

Member Data Documentation

◆ m_jAmountLabel

JLabel sortie.gui.harvepplant.PlantingDisplayWindow.m_jAmountLabel = new JLabel("Density (#/ha):")
protected

Label that displays the plant amount label for the currently displayed planting.

◆ m_jAmountValueLabel

JLabel sortie.gui.harvepplant.PlantingDisplayWindow.m_jAmountValueLabel = new JLabel("N/A")
protected

Label that displays the plant amount value for the currently displayed planting.

◆ m_jNumPlantingEvents

JLabel sortie.gui.harvepplant.PlantingDisplayWindow.m_jNumPlantingEvents = new JLabel("0")
protected

Label that displays number of planting events currently defined.

◆ m_jPlantNumber

JLabel sortie.gui.harvepplant.PlantingDisplayWindow.m_jPlantNumber = new JLabel("0")
protected

Label that displays the number of the current planting event.

◆ m_jSpacingLabel

JLabel sortie.gui.harvepplant.PlantingDisplayWindow.m_jSpacingLabel = new JLabel("N/A")
protected

Label that displays the plant spacing for the currently displayed planting.

◆ m_jTimestepLabel

JLabel sortie.gui.harvepplant.PlantingDisplayWindow.m_jTimestepLabel = new JLabel("N/A")
protected

Label that displays the timestep for the currently displayed planting.

◆ m_sHelpID

String sortie.gui.harvepplant.PlantingDisplayWindow.m_sHelpID = "windows.edit_planting_window"
private

Help ID string.

◆ mp_fPlantInitialDiam10s

float [] sortie.gui.harvepplant.PlantingDisplayWindow.mp_fPlantInitialDiam10s
protected

Copy of the planting initial diameter at 10 cm values.

◆ mp_jSpeciesPlantInitialDiam10

JLabel sortie.gui.harvepplant.PlantingDisplayWindow.mp_jSpeciesPlantInitialDiam10[]
protected

Array of labels displaying the initial diam10 for each species for all plantings.

◆ mp_jSpeciesPlantPercentages

JLabel sortie.gui.harvepplant.PlantingDisplayWindow.mp_jSpeciesPlantPercentages[]
protected

Array of labels displaying species percentages for the current planting.


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