javawrapper::SubplotEdit Class Reference

Window for editing subplot information. More...

List of all members.

Public Member Functions

 SubplotEdit (JDialog oOwner, OutputBehaviors oOutput, DisturbanceBehaviors oDisturbanceBehaviors, PlantingBehaviors oPlantBehaviors, boolean bIsShort) throws ModelException
 Constructor.
void actionPerformed (ActionEvent oEvent)
 Responds to window events.

Protected Member Functions

void SetUpCharting () throws ModelException
 Sets up the data cell charting.
void DisplayHarvest (HarvestData oHarvest) throws ModelException
 Causes a harvest event to be displayed in the window.
void DisplayMortEpisode (HarvestData oEpisode) throws ModelException
 Causes a mortality episode to be displayed in the window.
void DisplayPlanting (PlantingData oPlanting) throws ModelException
 Causes a planting event to be displayed in the window.
void DisplayNextHarvest () throws ModelException
 Displays the next harvest when the ">>" button is pressed.
void DisplayNextMortEpisode () throws ModelException
 Displays the next mortality episode when the next button is pressed.
void DisplayNextPlanting () throws ModelException
 Displays the next planting event when the ">>" button is pressed.
void DisplayPreviousHarvest () throws ModelException
 Displays the next harvest when the previous button is pressed.
void DisplayPreviousMortEpisode () throws ModelException
 Displays the next mortality episode when the previous button is pressed.
void DisplayPreviousPlanting () throws ModelException
 Displays the next plant event when the previous button is pressed.
void RefreshChart ()
 Refreshes the chart to show the data currently held in m_oDataset.

Protected Attributes

XYSimpleCellRenderer m_oRenderer = new XYSimpleCellRenderer()
 Renderer which displays current cell selections.
org.jfree.chart.ChartPanel m_oChart
 ChartPanel displaying the chart.
JLabel m_jHarvestNumber = new JLabel("0")
 Label that displays the number of the current harvest event.
JLabel m_jMortEpisodeNumber = new JLabel("0")
 Label that displays the number of the current mortality episode.
JLabel m_jPlantNumber = new JLabel("0")
 Label that displays the number of the current planting event.

Package Attributes

XYZSimpleDataset m_oDataset
 The dataset to render.

Classes

class  SubplotMouseListener
 Class for interpreting mouse clicks on the chart for selecting cells for subplot editing. More...


Detailed Description

Window for editing subplot information.

Copyright: Copyright (c) Charles D. Canham 2003

Company: Institute of Ecosystem Studies

Author:
Lora E. Murphy
Version:
1.0
Edit History: ----------------------------- May 10, 2006: Fixed a bug that caused out-of-memory errors (LEM) December 21, 2006: Changed to XYSimpleCellRenderer during upgrade to JFreeChart 1.0.3 (LEM)


Constructor & Destructor Documentation

javawrapper::SubplotEdit::SubplotEdit ( JDialog  oOwner,
OutputBehaviors  oOutput,
DisturbanceBehaviors  oDisturbanceBehaviors,
PlantingBehaviors  oPlantBehaviors,
boolean  bIsShort 
) throws ModelException [inline]

Constructor.

Creates the GUI.

Parameters:
oOwner Parent frame of this dialog.
oOutput Output behavior to exchange subplot data with.
oDisturbanceBehaviors For displaying disturbance events.
oPlantBehaviors For displaying planting events.
bIsShort Whether this is for short output (true) or detailed output (false)
Exceptions:
ModelException if anything goes wrong with window creation.


Member Function Documentation

void javawrapper::SubplotEdit::SetUpCharting (  )  throws ModelException [inline, protected]

Sets up the data cell charting.

This creates the cell renderer and the chart, and places the chart in the chart panel.

Exceptions:
ModelException if the chart cannot be created.

void javawrapper::SubplotEdit::DisplayHarvest ( HarvestData  oHarvest  )  throws ModelException [inline, protected]

Causes a harvest event to be displayed in the window.

Parameters:
oHarvest Harvest to display, or NULL if no harvest is to be displayed.
Exceptions:
ModelException passing through from called methods.

void javawrapper::SubplotEdit::DisplayMortEpisode ( HarvestData  oEpisode  )  throws ModelException [inline, protected]

Causes a mortality episode to be displayed in the window.

Parameters:
oEpisode Mortality episode to display, or NULL if no episode is to be displayed.
Exceptions:
ModelException passing through from called methods.

void javawrapper::SubplotEdit::DisplayPlanting ( PlantingData  oPlanting  )  throws ModelException [inline, 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:
oPlanting Planting to display, or NULL if no planting is to be displayed.
Exceptions:
ModelException passing through from called methods.

void javawrapper::SubplotEdit::DisplayNextHarvest (  )  throws ModelException [inline, protected]

Displays the next harvest when the ">>" button is pressed.

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

Exceptions:
ModelException Passing through from called methods.

void javawrapper::SubplotEdit::DisplayNextMortEpisode (  )  throws ModelException [inline, protected]

Displays the next mortality episode when the next button is pressed.

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

Exceptions:
ModelException Passing through from called methods.

void javawrapper::SubplotEdit::DisplayNextPlanting (  )  throws ModelException [inline, protected]

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

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

Exceptions:
ModelException Passing through from called methods.

void javawrapper::SubplotEdit::DisplayPreviousHarvest (  )  throws ModelException [inline, protected]

Displays the next harvest when the previous button is pressed.

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

Exceptions:
ModelException Passing through from called methods.

void javawrapper::SubplotEdit::DisplayPreviousMortEpisode (  )  throws ModelException [inline, protected]

Displays the next mortality episode when the previous button is pressed.

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

Exceptions:
ModelException Passing through from called methods.

void javawrapper::SubplotEdit::DisplayPreviousPlanting (  )  throws ModelException [inline, protected]

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

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

Exceptions:
ModelException Passing through from called methods.

void javawrapper::SubplotEdit::RefreshChart (  )  [inline, protected]

Refreshes the chart to show the data currently held in m_oDataset.

Exceptions:
ModelException if the chart cannot be created.

void javawrapper::SubplotEdit::actionPerformed ( ActionEvent  oEvent  )  [inline]

Responds to window events.

Parameters:
oEvent Event triggering this call.


Member Data Documentation

XYZSimpleDataset javawrapper::SubplotEdit::m_oDataset [package]

The dataset to render.

It contains the grid of values that says whether a cell is currently selected (true) or not (false) - sized # subplots + 4 by # plot X cells by # plot Y cells. The subplots are drawn on the map in layers. There is one series at index 0 with all true values, to provide a white underlayer. On top of that are the mortality episodes. For each actual subplot drawn on top of that, if the value is not selected, it's set to false so nothing will be drawn over data values for the layers underneath.


The documentation for this class was generated from the following file:
Generated on Thu May 24 09:34:55 2007 for SORTIE Java Interface by  doxygen 1.5.2