public class FormDescription extends java.lang.Object implements java.lang.Cloneable, java.lang.Comparable<FormDescription>
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
|
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.
|
public FormDescription(FormDescription existingDescription, java.util.ArrayList<ItemInformation> itemInfos)
existingDescription
- itemInfos
- public FormDescription(FormsControl formsControl, java.lang.String udfName)
formsControl
- udfName
- public UDFErrors getFormErrors()
public void setFormErrors(UDFErrors formErrors)
formErrors
- the formErrors to setpublic UDFErrors getFormWarnings()
public void setFormWarnings(UDFErrors formWarnings)
formWarnings
- the formWarnings to setpublic boolean writeUDFTable(java.util.ArrayList<ItemInformation> newFormItems)
newFormItems
- array list of new form properties and controls.public java.util.ArrayList<PropertyDescription> getPropertyDescriptions()
public java.lang.String toString()
toString
in class java.lang.Object
public FormList<ControlDescription> getControlDescriptions()
public PropertyDescription findProperty(PropertyTypes propertyType)
public int findInputControlByName(java.lang.String name)
name
- Input control namepublic java.lang.String getFormName()
public java.lang.Integer getAUTOALERT()
public java.awt.Font getFONT()
public java.lang.String getDBTABLENAME()
public BEARINGinfo findBEARINGInfo()
public RANGEinfo findRANGEInfo()
public HEADINGinfo findHEADINGInfo()
public void getHIDDEN()
public java.lang.String getHOTKEY()
public java.lang.String getUdfName()
public javax.swing.JComponent getTabComponent()
public LoggerForm createForm()
public UDFTableDefinition getUdfTableDefinition()
public FormsDataBlock getFormsDataBlock()
public java.util.ArrayList<ControlDescription> getInputControlDescriptions()
public PamTableDefinition getOutputTableDef()
public void processTabMouseEvent(LoggerTabbedPane loggerTabbedPane, java.awt.event.MouseEvent evt)
This will include all button presses and mouse enter / exit. Does not capture mousemove.
evt
- public void formPopupMenu(java.awt.event.MouseEvent evt)
public void editForm(java.awt.Window parentFrame)
public void removeForm(java.awt.Window parentFrame)
public java.awt.Component getSubtab(LoggerForm loggerForm)
loggerForm
- public java.lang.String getTabToolTip()
loggerTabbedPane
- public boolean canDrawOnMap()
public void setFormPlotOptions(FormPlotOptions formPlotOptions)
formPlotOptions
- the formPlotOptions to setpublic FormPlotOptions getFormPlotOptions()
public long getTimeOfNextSave()
public void setTimeOfNextSave()
public FormsControl getFormsControl()
public char getCounterSuffix()
public BearingTypes getBearingType()
This can be one of RELATIVE1, RELATIVE2, TRUE, MAGNETIC;
public RangeUnitTypes getRangeType()
This can be one of nmi, km, m, FIXED;
public java.lang.Integer getFixedRange()
public java.lang.Integer getHeadingLength()
public BearingTypes getHeadingType()
public RangeUnitTypes getHeadingRangeUnit()
This can be one of nmi, km, m, pix;
public void destroyForms()
public void dataBlockChanged()
goes on to notify the history table that things have changed.
public void getFormSettingsData(FormSettings formSettings)
Populate appropriate data into the formSettings as provided.
formSettings
- public void viewDataUnit(FormsDataUnit formsDataUnit)
formsDataUnit
- Data unit to display.public int getSubformCount()
public BEARINGinfo getBearingInfo()
public RANGEinfo getRangeInfo()
public HEADINGinfo getHeadingInfo()
public java.util.ArrayList<ItemInformation> getControlsInformationCopy()
public PamDataUnit createDataFromXML(org.w3c.dom.Document doc)
public java.lang.String getXMLData(FormsDataUnit formsDataUnit)
public int compareTo(FormDescription otherForm)
compareTo
in interface java.lang.Comparable<FormDescription>
public java.lang.Integer getFormOrderProperty()
public void setFormOrderProperty(java.lang.Integer order)
order
- order in list of forms.public boolean isNeedsUDFSave()
public void setNeedsUDFSave(boolean needsUDFSave)
needsUDFSave
- Set true if the forms UDF is going to need re-saving