loggerForms

Class FormSettingsControl

java.lang.Object

loggerForms.FormSettingsControl

All Implemented Interfaces:

PamSettings

public class FormSettingsControl
extends java.lang.Object
implements PamSettings

Controls the settings for a single Logger form description.

Doesn't handle the form design in any way, but things like the divider location as set by the user during use.

(OK - only the divider location at the moment !).

Author:

Doug Gillespie

Constructor Summary

Constructors

Constructor and Description
FormSettingsControl(FormDescription formDescription, java.lang.String udfName)

Method Summary

Methods

Modifier and Type	Method and Description
FormSettings	getFormSettings()
java.io.Serializable	getSettingsReference()
long	getSettingsVersion()
java.lang.String	getUnitName()
java.lang.String	getUnitType()
boolean	restoreSettings(PamControlledUnitSettings pamControlledUnitSettings)

Methods inherited from class java.lang.Object

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

Constructor Detail

FormSettingsControl

public FormSettingsControl(FormDescription formDescription,
                   java.lang.String udfName)

Method Detail

getSettingsReference

public java.io.Serializable getSettingsReference()

Specified by:

getSettingsReference in interface PamSettings

Returns:

The serialisable object that will be stored

getSettingsVersion

public long getSettingsVersion()

Specified by:

getSettingsVersion in interface PamSettings

Returns:

An integer version number for the settings

getUnitName

public java.lang.String getUnitName()

Specified by:

getUnitName in interface PamSettings

Returns:

A Name specific to this instance of the particular class, e.g. Sperm whale detector, Beaked whale detector, etc.

getUnitType

public java.lang.String getUnitType()

Specified by:

getUnitType in interface PamSettings

Returns:

A Name specific to the type, e.g. Glick detector

restoreSettings

public boolean restoreSettings(PamControlledUnitSettings pamControlledUnitSettings)

Specified by:

restoreSettings in interface PamSettings

Returns:

true if successful The object performs final checks (if needed) and then casts the settings data pamcontrolledunitSettings.settings into the correct type and uses as required

getFormSettings

public FormSettings getFormSettings()

Returns:

the formSettings