loggerForms.controls

Class LoggerControl

java.lang.Object

loggerForms.controls.LoggerControl

Direct Known Subclasses:

CharAreaControl, CheckboxControl, LatLongControl, LatLongTimeControl, LookupControl, SimpleControl, SubFormControl, TimestampControl

public abstract class LoggerControl
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
static int	AUTO_UPDATE_CANT
static int	AUTO_UPDATE_FAIL
static int	AUTO_UPDATE_SUCCESS

Constructor Summary

Constructors

Constructor and Description
LoggerControl(ControlDescription controlDescription, LoggerForm loggerForm)

Method Summary

Methods

Modifier and Type	Method and Description
void	addF1KeyListener(javax.swing.JComponent component)
static void	addFocusListenerToAllSubComponants(java.awt.event.FocusListener l, java.awt.Component component)
static void	addMouseListenerToAllSubComponants(java.awt.event.MouseListener l, java.awt.Component component)
int	autoUpdate() Automatically update a control.
void	clear()
void	clearDataError()
void	clearDataWarning() clear DataWarning field
void	f1Pressed()
abstract int	fillNMEAControlData(NMEADataUnit dataUnit) Called once a correct NMEA data unit has been found to write the data into the control.
NMEADataBlock	findNMEADataBlock() The NMEA datablock name must be stored somewhere - how about as Topic ?
javax.swing.JPanel	getComponent()
ControlDescription	getControlDescription()
abstract java.lang.Object	getData()
abstract java.lang.String	getDataError()
java.lang.String	getDataWarning()
LoggerForm	getLoggerForm()
void	lFocusGained(java.awt.event.FocusEvent fe)
abstract void	setData(java.lang.Object data) this will populate the Field with either last entered data or most up to date entry
abstract void	setDefault() Return to the default value based on the associated control description
void	setToolTipToAllSubJComponants(java.awt.Component component)
int	updateNMEAData() Tries to find the appropriate NMEA string by searching multiple data blocks if necessary.
int	updateNMEAData(NMEADataUnit nmeaData) Used when NMEA data is being updated in response to the arrival of a new NMEA string (i.e.

Methods inherited from class java.lang.Object

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

Field Detail

AUTO_UPDATE_SUCCESS

public static final int AUTO_UPDATE_SUCCESS

See Also:

Constant Field Values

AUTO_UPDATE_FAIL

public static final int AUTO_UPDATE_FAIL

See Also:

Constant Field Values

AUTO_UPDATE_CANT

public static final int AUTO_UPDATE_CANT

See Also:

Constant Field Values

Constructor Detail

LoggerControl

public LoggerControl(ControlDescription controlDescription,
             LoggerForm loggerForm)

Method Detail

setToolTipToAllSubJComponants

public void setToolTipToAllSubJComponants(java.awt.Component component)

Parameters:

listener -

jComponent -

addMouseListenerToAllSubComponants

public static void addMouseListenerToAllSubComponants(java.awt.event.MouseListener l,
                                      java.awt.Component component)

Parameters:

listener -

jComponent -

addFocusListenerToAllSubComponants

public static void addFocusListenerToAllSubComponants(java.awt.event.FocusListener l,
                                      java.awt.Component component)

addF1KeyListener

public void addF1KeyListener(javax.swing.JComponent component)

f1Pressed

public void f1Pressed()

getDataError

public abstract java.lang.String getDataError()

Returns:

getData

public abstract java.lang.Object getData()

Returns:

data from field(s) of component

setData

public abstract void setData(java.lang.Object data)

this will populate the Field with either last entered data or most up to date entry

setDefault

public abstract void setDefault()

Return to the default value based on the associated control description

autoUpdate

public int autoUpdate()

Automatically update a control. This is only possible for controls such as time, timestamps and NMEA items.

Returns:

AUTO_UPDATE_SUCCESS, AUTO_UPDATE_FAIL or AUTO_UPDATE_CANT

clear

public void clear()

getControlDescription

public ControlDescription getControlDescription()

Returns:

the controlDescription

getLoggerForm

public LoggerForm getLoggerForm()

Returns:

the loggerForm

getComponent

public javax.swing.JPanel getComponent()

Returns:

the component

lFocusGained

public void lFocusGained(java.awt.event.FocusEvent fe)

getDataWarning

public java.lang.String getDataWarning()

Returns:

the dataWarning

clearDataWarning

public void clearDataWarning()

clear DataWarning field

clearDataError

public void clearDataError()

updateNMEAData

public int updateNMEAData()

Tries to find the appropriate NMEA string by searching multiple data blocks if necessary. IF the previous call was Successful, then it will just go straight to that same data block, otherwise, it will search all available datablocks.

Returns:

fillNMEAControlData

public abstract int fillNMEAControlData(NMEADataUnit dataUnit)

Called once a correct NMEA data unit has been found to write the data into the control.

Parameters:

dataUnit - NMEA data unit

Returns:

success flag.

updateNMEAData

public int updateNMEAData(NMEADataUnit nmeaData)

Used when NMEA data is being updated in response to the arrival of a new NMEA string (i.e. on forms which save all NMEA data from a single string). An actual string is passed in, but there is just a chance that it will be the wrong type in which case the default is used.

Parameters:

nmeaData -

findNMEADataBlock

public NMEADataBlock findNMEADataBlock()

The NMEA datablock name must be stored somewhere - how about as Topic ?

Returns: