FormDescription

java.lang.Object
- loggerForms.FormDescription

All Implemented Interfaces:

java.lang.Cloneable, java.lang.Comparable<FormDescription>
```
public class FormDescription
extends java.lang.Object
implements java.lang.Cloneable, java.lang.Comparable<FormDescription>
```
Author:

Graham Weatherup - SMRU Holds a description of the Form to be created

Constructor Summary

Constructors
Constructor and Description
`FormDescription(FormDescription existingDescription, java.util.ArrayList<ItemInformation> itemInfos)` Constructor for building a demo form during the design phase.
`FormDescription(FormsControl formsControl, java.lang.String udfName)` Main constructor used when reading data from a UDF table

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`canDrawOnMap()`
`int`	`compareTo(FormDescription otherForm)`
`PamDataUnit`	`createDataFromXML(org.w3c.dom.Document doc)`
`LoggerForm`	`createForm()`
`void`	`dataBlockChanged()` Called when data are added to or removed from the datablock.
`void`	`destroyForms()` Destroy any open forms.
`void`	`editForm(java.awt.Window parentFrame)` Edit the form.
`BEARINGinfo`	`findBEARINGInfo()`
`HEADINGinfo`	`findHEADINGInfo()`
`int`	`findInputControlByName(java.lang.String name)` Find an input control by name and return it's index
`PropertyDescription`	`findProperty(PropertyTypes propertyType)`
`RANGEinfo`	`findRANGEInfo()`
`void`	`formPopupMenu(java.awt.event.MouseEvent evt)`
`java.lang.Integer`	`getAUTOALERT()`
`BEARINGinfo`	`getBearingInfo()`
`BearingTypes`	`getBearingType()`
`FormList<ControlDescription>`	`getControlDescriptions()`
`java.util.ArrayList<ItemInformation>`	`getControlsInformationCopy()`
`char`	`getCounterSuffix()`
`java.lang.String`	`getDBTABLENAME()`
`java.lang.Integer`	`getFixedRange()`
`java.awt.Font`	`getFONT()`
`UDFErrors`	`getFormErrors()`
`java.lang.String`	`getFormName()`
`java.lang.Integer`	`getFormOrderProperty()` Get the order property for the form
`FormPlotOptions`	`getFormPlotOptions()`
`FormsControl`	`getFormsControl()`
`FormsDataBlock`	`getFormsDataBlock()`
`void`	`getFormSettingsData(FormSettings formSettings)` Called from FormSettingsControl just before PAMGuard exits (or settings are saved for some other reason).
`UDFErrors`	`getFormWarnings()`
`HEADINGinfo`	`getHeadingInfo()`
`java.lang.Integer`	`getHeadingLength()`
`RangeUnitTypes`	`getHeadingRangeUnit()`
`BearingTypes`	`getHeadingType()`
`void`	`getHIDDEN()`
`java.lang.String`	`getHOTKEY()`
`java.util.ArrayList<ControlDescription>`	`getInputControlDescriptions()`
`PamTableDefinition`	`getOutputTableDef()`
`java.util.ArrayList<PropertyDescription>`	`getPropertyDescriptions()`
`RANGEinfo`	`getRangeInfo()`
`RangeUnitTypes`	`getRangeType()`
`int`	`getSubformCount()` Get a count of open sub tab forms.
`java.awt.Component`	`getSubtab(LoggerForm loggerForm)`
`javax.swing.JComponent`	`getTabComponent()` Get a component to go into the main tab panel for the Logger forms If it's a POPUP form, return null since these don't go into the tab panel.
`java.lang.String`	`getTabToolTip()` Set an appropriate tool tip for the tab panel.
`long`	`getTimeOfNextSave()`
`java.lang.String`	`getUdfName()`
`UDFTableDefinition`	`getUdfTableDefinition()`
`java.lang.String`	`getXMLData(FormsDataUnit formsDataUnit)` Get the contents of the data unit as xml.
`boolean`	`isNeedsUDFSave()`
`void`	`processTabMouseEvent(LoggerTabbedPane loggerTabbedPane, java.awt.event.MouseEvent evt)` Process an event created by a mouse action on the tab associated with this form.
`void`	`removeForm(java.awt.Window parentFrame)` Remove the form.
`void`	`setFormErrors(UDFErrors formErrors)`
`void`	`setFormOrderProperty(java.lang.Integer order)` Set the form order property.
`void`	`setFormPlotOptions(FormPlotOptions formPlotOptions)`
`void`	`setFormWarnings(UDFErrors formWarnings)`
`void`	`setNeedsUDFSave(boolean needsUDFSave)`
`void`	`setTimeOfNextSave()`
`java.lang.String`	`toString()`
`void`	`viewDataUnit(FormsDataUnit formsDataUnit)` Called only in viewer mode when the selection of a row in the summary table changes.
`boolean`	`writeUDFTable(java.util.ArrayList<ItemInformation> newFormItems)` Write a totally new set of form data from the from design dialog back down into the UDF table.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - FormDescription
```
public FormDescription(FormDescription existingDescription,
               java.util.ArrayList<ItemInformation> itemInfos)
```
    Constructor for building a demo form during the design phase.
    
    Parameters:
    existingDescription -
    itemInfos -
  - FormDescription
```
public FormDescription(FormsControl formsControl,
               java.lang.String udfName)
```
    Main constructor used when reading data from a UDF table
    
    Parameters:
    formsControl -
    udfName -
- Method Detail
  - getFormErrors
```
public UDFErrors getFormErrors()
```
    Returns:
    the formErrors
  - setFormErrors
```
public void setFormErrors(UDFErrors formErrors)
```
    Parameters:
    formErrors - the formErrors to set
  - getFormWarnings
```
public UDFErrors getFormWarnings()
```
    Returns:
    the formWarnings
  - setFormWarnings
```
public void setFormWarnings(UDFErrors formWarnings)
```
    Parameters:
    formWarnings - the formWarnings to set
  - writeUDFTable
```
public boolean writeUDFTable(java.util.ArrayList<ItemInformation> newFormItems)
```
    Write a totally new set of form data from the from design dialog back down into the UDF table. To do this, the UDF table must be cleared first.
    
    Parameters:
    newFormItems - array list of new form properties and controls.
    
    Returns:
    true if the operation was successful.
  - getPropertyDescriptions
```
public java.util.ArrayList<PropertyDescription> getPropertyDescriptions()
```
    Returns:
    the propertyDescriptions
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - getControlDescriptions
```
public FormList<ControlDescription> getControlDescriptions()
```
    Returns:
    the controlDescriptions
  - findProperty
```
public PropertyDescription findProperty(PropertyTypes propertyType)
```
  - findInputControlByName
```
public int findInputControlByName(java.lang.String name)
```
    Find an input control by name and return it's index
    
    Parameters:
    name - Input control name
    
    Returns:
    index in table, or -1 if nothing found.
  - getFormName
```
public java.lang.String getFormName()
```
  - getAUTOALERT
```
public java.lang.Integer getAUTOALERT()
```
  - getFONT
```
public java.awt.Font getFONT()
```
  - getDBTABLENAME
```
public java.lang.String getDBTABLENAME()
```
  - findBEARINGInfo
```
public BEARINGinfo findBEARINGInfo()
```
    Returns:
    BEARINGinfo
  - findRANGEInfo
```
public RANGEinfo findRANGEInfo()
```
    Returns:
    RANGEinfo
  - findHEADINGInfo
```
public HEADINGinfo findHEADINGInfo()
```
    Returns:
    HEADINGinfo
  - getHIDDEN
```
public void getHIDDEN()
```
  - getHOTKEY
```
public java.lang.String getHOTKEY()
```
  - getUdfName
```
public java.lang.String getUdfName()
```
  - getTabComponent
```
public javax.swing.JComponent getTabComponent()
```
    Get a component to go into the main tab panel for the Logger forms If it's a POPUP form, return null since these don't go into the tab panel. If it's SUBTABS, then return an empty tab panel, but be prepared to add stuff to it IF it's a normal form, then return a normal form.
    
    Returns:
  - createForm
```
public LoggerForm createForm()
```
  - getUdfTableDefinition
```
public UDFTableDefinition getUdfTableDefinition()
```
    Returns:
    the udfTableDefinition
  - getFormsDataBlock
```
public FormsDataBlock getFormsDataBlock()
```
    Returns:
    the formsDataBlock
  - getInputControlDescriptions
```
public java.util.ArrayList<ControlDescription> getInputControlDescriptions()
```
    Returns:
    the inputControlDescriptions
  - getOutputTableDef
```
public PamTableDefinition getOutputTableDef()
```
    Returns:
    the outputTableDef
  - processTabMouseEvent
```
public void processTabMouseEvent(LoggerTabbedPane loggerTabbedPane,
                        java.awt.event.MouseEvent evt)
```
    Process an event created by a mouse action on the tab associated with this form.
    This will include all button presses and mouse enter / exit. Does not capture mousemove.
    
    Parameters:
    evt -
  - formPopupMenu
```
public void formPopupMenu(java.awt.event.MouseEvent evt)
```
  - editForm
```
public void editForm(java.awt.Window parentFrame)
```
    Edit the form. Will eventually pop up a large dialog with a whole load of options for adding and altering controls.
  - removeForm
```
public void removeForm(java.awt.Window parentFrame)
```
    Remove the form. Will involve dropping the UDF table from the database, which is a pretty serious thing to want to do ! Warn first and suggest hiding or just renaming the udf.
  - getSubtab
```
public java.awt.Component getSubtab(LoggerForm loggerForm)
```
    Parameters:
    loggerForm -
    
    Returns:
  - getTabToolTip
```
public java.lang.String getTabToolTip()
```
    Set an appropriate tool tip for the tab panel.
    
    Parameters:
    loggerTabbedPane -
  - canDrawOnMap
```
public boolean canDrawOnMap()
```
    Returns:
    true if the form data can be plotted on the PAMGUARD map. May adapt this later on so it can draw on other projections as well.
  - setFormPlotOptions
```
public void setFormPlotOptions(FormPlotOptions formPlotOptions)
```
    Parameters:
    formPlotOptions - the formPlotOptions to set
  - getFormPlotOptions
```
public FormPlotOptions getFormPlotOptions()
```
    Returns:
    the formPlotOptions
  - getTimeOfNextSave
```
public long getTimeOfNextSave()
```
    Returns:
    the timeOfNextSave
  - setTimeOfNextSave
```
public void setTimeOfNextSave()
```
  - getFormsControl
```
public FormsControl getFormsControl()
```
    Returns:
    the formsControl
  - getCounterSuffix
```
public char getCounterSuffix()
```
    Returns:
    the counterSuffix
  - getBearingType
```
public BearingTypes getBearingType()
```
    Returns:
    the bearingType
    This can be one of RELATIVE1, RELATIVE2, TRUE, MAGNETIC;
  - getRangeType
```
public RangeUnitTypes getRangeType()
```
    Returns:
    the rangeType
    This can be one of nmi, km, m, FIXED;
  - getFixedRange
```
public java.lang.Integer getFixedRange()
```
    Returns:
    the range value to be used when getRangeType returns FIXED
  - getHeadingLength
```
public java.lang.Integer getHeadingLength()
```
    Returns:
    the length of the heading arrow in units given in getHEadingRangeUnit()
  - getHeadingType
```
public BearingTypes getHeadingType()
```
    Returns:
    the headingType This can be one of RELATIVE1, RELATIVE2, TRUE, MAGNETIC;
  - getHeadingRangeUnit
```
public RangeUnitTypes getHeadingRangeUnit()
```
    Returns:
    the headingRangeUnit
    This can be one of nmi, km, m, pix;
  - destroyForms
```
public void destroyForms()
```
    Destroy any open forms. This includes disconnecting any observer of NMEA data.
  - dataBlockChanged
```
public void dataBlockChanged()
```
    Called when data are added to or removed from the datablock.
    goes on to notify the history table that things have changed.
  - getFormSettingsData
```
public void getFormSettingsData(FormSettings formSettings)
```
    Called from FormSettingsControl just before PAMGuard exits (or settings are saved for some other reason).
    Populate appropriate data into the formSettings as provided.
    
    Parameters:
    formSettings -
  - viewDataUnit
```
public void viewDataUnit(FormsDataUnit formsDataUnit)
```
    Called only in viewer mode when the selection of a row in the summary table changes. The contents of the data unit will be displayed in the form (which cannot be edited !), or the form will be cleared if the data unit is null
    
    Parameters:
    formsDataUnit - Data unit to display.
  - getSubformCount
```
public int getSubformCount()
```
    Get a count of open sub tab forms.
    
    Returns:
    the number of open sub tab forms.
  - getBearingInfo
```
public BEARINGinfo getBearingInfo()
```
  - getRangeInfo
```
public RANGEinfo getRangeInfo()
```
  - getHeadingInfo
```
public HEADINGinfo getHeadingInfo()
```
  - getControlsInformationCopy
```
public java.util.ArrayList<ItemInformation> getControlsInformationCopy()
```
    Returns:
    cloned copies of ItemInformation in all controls.
  - createDataFromXML
```
public PamDataUnit createDataFromXML(org.w3c.dom.Document doc)
```
  - getXMLData
```
public java.lang.String getXMLData(FormsDataUnit formsDataUnit)
```
    Get the contents of the data unit as xml.
    
    Returns:
    an XML String summarising the form data.
  - compareTo
```
public int compareTo(FormDescription otherForm)
```
    Specified by:
    
    compareTo in interface java.lang.Comparable<FormDescription>
  - getFormOrderProperty
```
public java.lang.Integer getFormOrderProperty()
```
    Get the order property for the form
    
    Returns:
    order property or null if it isn't set.
  - setFormOrderProperty
```
public void setFormOrderProperty(java.lang.Integer order)
```
    Set the form order property.
    
    Parameters:
    order - order in list of forms.
  - isNeedsUDFSave
```
public boolean isNeedsUDFSave()
```
    Returns:
    true if the forms UDF table needs rewriting.
  - setNeedsUDFSave
```
public void setNeedsUDFSave(boolean needsUDFSave)
```
    Parameters:
    needsUDFSave - Set true if the forms UDF is going to need re-saving

Class FormDescription

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

FormDescription

FormDescription

Method Detail

getFormErrors

setFormErrors

getFormWarnings

setFormWarnings

writeUDFTable

getPropertyDescriptions

toString

getControlDescriptions

findProperty

findInputControlByName

getFormName

getAUTOALERT

getFONT

getDBTABLENAME

findBEARINGInfo

findRANGEInfo

findHEADINGInfo

getHIDDEN

getHOTKEY

getUdfName

getTabComponent

createForm

getUdfTableDefinition

getFormsDataBlock

getInputControlDescriptions

getOutputTableDef

processTabMouseEvent

formPopupMenu

editForm

removeForm

getSubtab

getTabToolTip

canDrawOnMap

setFormPlotOptions

getFormPlotOptions

getTimeOfNextSave

setTimeOfNextSave

getFormsControl

getCounterSuffix

getBearingType

getRangeType

getFixedRange

getHeadingLength

getHeadingType

getHeadingRangeUnit

destroyForms

dataBlockChanged

getFormSettingsData

viewDataUnit

getSubformCount

getBearingInfo

getRangeInfo

getHeadingInfo

getControlsInformationCopy

createDataFromXML

getXMLData

compareTo

getFormOrderProperty

setFormOrderProperty

isNeedsUDFSave

setNeedsUDFSave