loggerForms

Class FormsControl

java.lang.Object

PamController.PamControlledUnit

loggerForms.FormsControl

public class FormsControl
extends PamControlledUnit

Author:

Graham Weatherup controls the logger forms module

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.ArrayList<java.lang.String>	restrictedTitles

Constructor Summary

Constructors

Constructor and Description
FormsControl(java.lang.String unitName)

Method Summary

Methods

Modifier and Type	Method and Description
void	addFormDescription(java.lang.String newFormName)
boolean	canClose() Called before Pamguard shuts down.
javax.swing.JMenuItem	createDetectionMenu(java.awt.Frame parentFrame) Create a JMenu object containing MenuItems associated with PamProcesses
javax.swing.JMenuItem	createDisplayMenu(java.awt.Frame parentFrame) Create a JMenu object containing MenuItems associated with the view
void	displayOptions(java.awt.Frame parentFrame)
FormDescription	findFormByOrder(int order) Find a form which has a particular order value.
FormDescription	findFormDescription(java.lang.String formName) Find a form description with a given name.
FormDescription	getFormDescription(int iForm) Get the form description for a specific index.
int	getFormIndex(FormDescription formDescription) Get a form index from a form description
FormsProcess	getFormsProcess()
FormsTabPanel	getFormsTabPanel() Get the correct type of reference to the forms tab panel.
int	getNumFormDescriptions()
java.lang.Character	getOutputTableNameCounterSuffix(FormDescription thisFormDescription)
PamSidePanel	getSidePanel() Gets a reference to a small panel to be displayed along the left hand edge of the main tab panel.
PamTabPanel	getTabPanel() Gets a reference to a panel to be added to a view
void	newLoggerform(java.awt.Frame parentFrame)
void	notifyModelChanged(int changeType) General notification when the PAMGAURD model changes.
void	regenerateForms(java.awt.Window parentFrame) Delete and recreate all forms / form data, etc.
void	rewriteChangedUDFTables() Rewrite all UDF tables in forms which have been altered.

Methods inherited from class PamController.PamControlledUnit

addOfflineTaskGroup, addOtherRelatedMenuItems, addPamProcess, addRelatedMenuItems, addXMLParameter, addXMLParameter, addXMLParameter, addXMLParameter, canPlayViewerSound, createFileMenu, createHelpMenu, fillXMLElement, flushDataBlockBuffers, getFrameNumber, getGuiFrame, getModuleSummary, getNumOfflineTaskGroups, getNumPamProcesses, getOfflineTaskGroup, getPamController, getPamModuleInfo, getPamProcess, getPamView, getShortUnitType, getTabClipCopier, getTabSpecificMenuBar, getToolbarComponent, getUnitName, getUnitType, getVerboseLevel, gotoTab, isViewer, pamClose, pamHasStopped, pamToStart, playViewerSound, removePamProcess, removeUnit, rename, saveViewerData, setFrameNumber, setPamController, setPamModuleInfo, setPamView, setSidePanel, setTabPanel, setupControlledUnit, stopViewerSound, terminalPrint, terminalPrintln, toString

Methods inherited from class java.lang.Object

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

Field Detail

restrictedTitles

public static java.util.ArrayList<java.lang.String> restrictedTitles

Constructor Detail

FormsControl

public FormsControl(java.lang.String unitName)

Method Detail

notifyModelChanged

public void notifyModelChanged(int changeType)

Description copied from class: PamControlledUnit

General notification when the PAMGAURD model changes.

Overrides:

notifyModelChanged in class PamControlledUnit

Parameters:

changeType - type of change

getNumFormDescriptions

public int getNumFormDescriptions()

getFormDescription

public FormDescription getFormDescription(int iForm)

Get the form description for a specific index.

Parameters:

iForm - form index

Returns:

for description

getFormIndex

public int getFormIndex(FormDescription formDescription)

Get a form index from a form description

Parameters:

formDescription - Form Descriptions

Returns:

form index or -1 if not found

findFormByOrder

public FormDescription findFormByOrder(int order)

Find a form which has a particular order value.

Parameters:

order - order (starts from 1 generally)

Returns:

a form, or null if none have that order.

findFormDescription

public FormDescription findFormDescription(java.lang.String formName)

Find a form description with a given name.

Parameters:

formName -

Returns:

form description or null.

getOutputTableNameCounterSuffix

public java.lang.Character getOutputTableNameCounterSuffix(FormDescription thisFormDescription)

addFormDescription

public void addFormDescription(java.lang.String newFormName)

getFormsTabPanel

public FormsTabPanel getFormsTabPanel()

Get the correct type of reference to the forms tab panel.

Returns:

reference to the forms tab panel.

getTabPanel

public PamTabPanel getTabPanel()

Description copied from class: PamControlledUnit

Gets a reference to a panel to be added to a view

Overrides:

getTabPanel in class PamControlledUnit

Returns:

reference to a PamTabPanel object

See Also:

PamTabPanel, PamSidePanel

getSidePanel

public PamSidePanel getSidePanel()

Description copied from class: PamControlledUnit

Gets a reference to a small panel to be displayed along the left hand edge of the main tab panel. Side panels should be small since they are always visible and any space they take will be taken from the main tab panel.

It is possible for a PamControlled unit to have a side panel without having a pamTabPanel.

Overrides:

getSidePanel in class PamControlledUnit

Returns:

a pamSidePanel object.

See Also:

PamSidePanel, PamTabPanel

getFormsProcess

public FormsProcess getFormsProcess()

Returns:

the formsProcess

createDetectionMenu

public javax.swing.JMenuItem createDetectionMenu(java.awt.Frame parentFrame)

Description copied from class: PamControlledUnit

Create a JMenu object containing MenuItems associated with PamProcesses

Overrides:

createDetectionMenu in class PamControlledUnit

Parameters:

parentFrame - The owner frame of the menu

Returns:

reference to a JMenu which can be added to an existing menu or menu bar

Note that if multiple views are to use the same menu, then they should each create a new menu (by setting Create to true) the first time they call this method.

newLoggerform

public void newLoggerform(java.awt.Frame parentFrame)

regenerateForms

public void regenerateForms(java.awt.Window parentFrame)

Delete and recreate all forms / form data, etc.

Parameters:

parentFrame -

createDisplayMenu

public javax.swing.JMenuItem createDisplayMenu(java.awt.Frame parentFrame)

Description copied from class: PamControlledUnit

Create a JMenu object containing MenuItems associated with the view

Overrides:

createDisplayMenu in class PamControlledUnit

Returns:

reference to a JMenu which can be added to an existing menu or menu bar

Note that if multiple views are to use the same menu, then they should each create a new menu (by setting Create to true) the first time they call this method.

displayOptions

public void displayOptions(java.awt.Frame parentFrame)

canClose

public boolean canClose()

Description copied from class: PamControlledUnit

Called before Pamguard shuts down. Rather than returning false, this function can be used as a final oportunity to save settings, write to the database, etc.

Overrides:

canClose in class PamControlledUnit

Returns:

true if OK for Pamguard to shut down, false otherwise.

rewriteChangedUDFTables

public void rewriteChangedUDFTables()

Rewrite all UDF tables in forms which have been altered.