Package PamController
Interface PAMControllerGUI
- All Superinterfaces:
PamViewInterface
- All Known Implementing Classes:
GuiFrameManager
,NullGuiController
,PamGuiManagerFX
Basic interface for the primary UI and UI manager showing the PAMGuard GUI.
- Author:
- Jamie Macaulay
-
Method Summary
Modifier and TypeMethodDescriptionvoid
addView
(PamViewInterface newView) Add a PAMView Interface.void
Called to destroy modelCalled on startup to grab pamsettings/database from somewhere.getModuleName
(Object parentFrame, PamModuleInfo moduleInfo) Get the name for a controlled unit from user input.boolean
The GUI may have a callback into the PamController once it has all been set up.void
init()
Called immediately after the creation of the GUI in the PAMController.initPrimaryView
(PamController pamController, PamModel pamModelInterface) Called when the controller is ready for the fire view.void
notifyLoadProgress
(PamTaskUpdate progress) Notify the GUI that some loading is taking placevoid
notifyModelChanged
(int changeType) Notification flag that the model has changedMethods inherited from interface PamView.PamViewInterface
addControlledUnit, enableGUIControl, getFrameNumber, getGuiFrame, modelChanged, pamEnded, pamStarted, removeControlledUnit, setTitle, showControlledUnit
-
Method Details
-
addView
Add a PAMView Interface. This mirrors many of the functions in PAMControllerGUI -
destroyModel
void destroyModel()Called to destroy model -
notifyModelChanged
void notifyModelChanged(int changeType) Notification flag that the model has changed- Parameters:
changeType
-
-
notifyLoadProgress
Notify the GUI that some loading is taking place- Parameters:
progress
- - the progress.
-
getInitialSettings
PamSettings getInitialSettings()Called on startup to grab pamsettings/database from somewhere.- Returns:
- the pamsettings/database.
-
init
void init()Called immediately after the creation of the GUI in the PAMController. -
initPrimaryView
Called when the controller is ready for the fire view.- Parameters:
pamController
-pamModelInterface
-- Returns:
- init and retuirn the first view
-
hasCallBack
boolean hasCallBack()The GUI may have a callback into the PamController once it has all been set up. If this is the case then on init() PAMController stops and relies on the GUI code to call the relevant setupPAMGuard folder once the GUI thread is happy everything is being set up properly.- Returns:
-
getModuleName
Get the name for a controlled unit from user input.- Parameters:
parentFrame
- - an object which can be the parent frame for the dialog.moduleInfo
- - the type of controlled unit.- Returns:
- the name of the module.
-