loggerForms

Class LoggerForm

java.lang.Object

loggerForms.LoggerForm

public class LoggerForm
extends java.lang.Object

A LoggerForm is the central component of all form types, inclucing normal forms popup forms and subtab forms. Therefore the form itself is capable of providing a single JComponent (a JPanel). some other part of the software will either place this into the main tab panel, a sub tab panel or it's own dialog frame (for a pop-up).

Author:

Graham Weatherup

Field Summary

Fields

Modifier and Type	Field and Description
static int	EditDataForm
static int	NewDataForm
static int	PreviewDataForm

Constructor Summary

Constructors

Constructor and Description
LoggerForm(FormDescription formDescription, int NewOrEdit) called when creating a form for new data input(normal/subtabs/popup), or to edit old data JComponent component that the form is put in should maybe be included to say whether it will go in window/frame to rename/remove as necessary

Method Summary

Methods

Modifier and Type	Method and Description
void	destroyForm() Destroy the form - which for now means killing any NMEA observer.
void	displayMessage(java.lang.String message)
void	enableControls() Enable / disable buttons
void	focusGained(java.awt.event.FocusEvent fe, LoggerControl loggerControlComponent)
PamPanel	getComponent()
CounterControl	getCounter()
FormDescription	getFormDescription()
java.lang.String	getFormErrors()
java.lang.String	getFormWarnings()
java.util.ArrayList<LoggerControl>	getInputControls()
PamPanel	getLastRow()
int	getNewOrEdit()
boolean	hasCounter()
boolean	printErrors(java.util.ArrayList<java.lang.String> errors)
void	readOnGps()
void	setHasCounter(CounterControl cc) sets hasCounter to true
void	setHintAndMessage(LoggerControl loggerControlComponent)
java.lang.Object[]	transferControlDataToArray() Transfers data from the from controls to the data array which will get saved in the data unit.
boolean	transferDataArrayToForm(java.lang.Object[] dataArray) Transfers data from the array within a data unit back into the form controls.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

NewDataForm

public static final int NewDataForm

See Also:

Constant Field Values

EditDataForm

public static final int EditDataForm

See Also:

Constant Field Values

PreviewDataForm

public static final int PreviewDataForm

See Also:

Constant Field Values

Constructor Detail

LoggerForm

public LoggerForm(FormDescription formDescription,
          int NewOrEdit)

called when creating a form for new data input(normal/subtabs/popup), or to edit old data JComponent component that the form is put in should maybe be included to say whether it will go in window/frame to rename/remove as necessary

Parameters:

formDescription -

Method Detail

getInputControls

public java.util.ArrayList<LoggerControl> getInputControls()

Returns:

the inputControls

hasCounter

public boolean hasCounter()

Returns:

the hasCounter

getCounter

public CounterControl getCounter()

Returns:

the CounterControl

setHasCounter

public void setHasCounter(CounterControl cc)

sets hasCounter to true

getNewOrEdit

public int getNewOrEdit()

Returns:

the NewOrEdit

readOnGps

public void readOnGps()

getFormDescription

public FormDescription getFormDescription()

Returns:

the formDescription

enableControls

public void enableControls()

Enable / disable buttons

for now this is basically just disabling buttons if we're in viewer mode. A More sophisticated function might consider enabling / diabling depending on whether or not a form can be saved.

displayMessage

public void displayMessage(java.lang.String message)

getFormWarnings

public java.lang.String getFormWarnings()

getFormErrors

public java.lang.String getFormErrors()

transferControlDataToArray

public java.lang.Object[] transferControlDataToArray()

Transfers data from the from controls to the data array which will get saved in the data unit.

Returns:

array of data objects

transferDataArrayToForm

public boolean transferDataArrayToForm(java.lang.Object[] dataArray)

Transfers data from the array within a data unit back into the form controls.

Parameters:

dataArray -

Returns:

true

printErrors

public boolean printErrors(java.util.ArrayList<java.lang.String> errors)

getComponent

public PamPanel getComponent()

setHintAndMessage

public void setHintAndMessage(LoggerControl loggerControlComponent)

focusGained

public void focusGained(java.awt.event.FocusEvent fe,
               LoggerControl loggerControlComponent)

destroyForm

public void destroyForm()

Destroy the form - which for now means killing any NMEA observer.

getLastRow

public PamPanel getLastRow()

Returns:

the lastRow