Package userDisplayFX

Class UserDisplayControlFX

java.lang.Object

PamController.PamControlledUnit

userDisplayFX.UserDisplayControlFX

All Implemented Interfaces:

SettingsNameProvider

Direct Known Subclasses:

DetectionDisplayControl, DetectionDisplayControl2, TDDisplayController

public abstract class UserDisplayControlFX
extends PamControlledUnit

Class which acts as a plug in for a display in PAMGUARDFX. Modules may have their own displays or a UserDisplayControlFX can be used to create a more generic display, which may, for example, plug in to many different modules.

Author:

Jamie Macaulay

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	UserDisplayControlFX.DisplayControlGUI	Holds info on the GUI components of the display.

Field Summary

Fields

Modifier and Type	Field	Description
static String	defUnitType

Constructor Summary

Constructors

Constructor	Description
UserDisplayControlFX(String unitName)

Method Summary

Modifier and Type	Method	Description
void	addCompatibleUnit(Class<? extends PamDataUnit> newDataClass)
abstract ArrayList<UserDisplayNodeFX>	getDisplays()
UserDisplayControlFX.DisplayControlGUI	getGUI(int flag)	Get the GUI for the PAMControlled unit.
int	getNCompatibleDataUnits()
UserDisplayProcess	getUserDisplayProcess()	Get the process for the user display.
boolean	isMultiParent()	True if the display can accept multiple parent data blocks at the same time.
boolean	removeCompatibleDataUnit(Class<? extends PamDataUnit> newDataClass)
boolean	removeCompatibleDataUnits()
void	setMultiParent(boolean multiParent)	Set whether the display can accept multiple parent data blocks at the same time.

Methods inherited from class PamController.PamControlledUnit

addOfflineTaskGroup, addOtherRelatedMenuItems, addPamProcess, addPamProcess, addRelatedMenuItems, canClose, canPlayViewerSound, createDetectionMenu, createDisplayMenu, createFileMenu, createHelpMenu, flushDataBlockBuffers, getBackupInformation, getFrameNumber, getGuiFrame, getInstanceIndex, getModuleStatus, getModuleStatusManager, getModuleSummary, getModuleSummary, getNumOfflineTaskGroups, getNumPamProcesses, getOfflineState, getOfflineTaskGroup, getPamConfiguration, getPamController, getPamModuleInfo, getPamProcess, getPamView, getPlugin, getShortUnitType, getSidePanel, getTabClipCopier, getTabPanel, getTabSpecificMenuBar, getToolbarComponent, getUnitName, getUnitType, getVerboseLevel, gotoTab, isInMainConfiguration, isNetRx, isViewer, notifyModelChanged, pamClose, pamHasStopped, pamToStart, playViewerSound, removePamProcess, removeUnit, rename, saveViewerData, setFrameNumber, setModuleStatusManager, setPamConfiguration, setPamController, setPamModuleInfo, setPamView, setSidePanel, setTabPanel, setToolbarComponent, setupControlledUnit, stopViewerSound, tellModule, terminalPrint, terminalPrintln, toString

Methods inherited from class java.lang.Object

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

Field Details

defUnitType

public static String defUnitType

Constructor Details

UserDisplayControlFX

public UserDisplayControlFX(String unitName)

Method Details

getUserDisplayProcess

public UserDisplayProcess getUserDisplayProcess()

Get the process for the user display. This handles compatible data units and current parent data blocks etc.

Returns:

the user display process.

addCompatibleUnit

public void addCompatibleUnit(Class<? extends PamDataUnit> newDataClass)

getNCompatibleDataUnits

public int getNCompatibleDataUnits()

removeCompatibleDataUnit

public boolean removeCompatibleDataUnit(Class<? extends PamDataUnit> newDataClass)

removeCompatibleDataUnits

public boolean removeCompatibleDataUnits()

isMultiParent

public boolean isMultiParent()

True if the display can accept multiple parent data blocks at the same time.

Returns:

true if the display can accept multiple parent data blocks.

setMultiParent

public void setMultiParent(boolean multiParent)

Set whether the display can accept multiple parent data blocks at the same time.

Parameters:

multiParent - true if the display can accept multiple parent data blocks.

getDisplays

public abstract ArrayList<UserDisplayNodeFX> getDisplays()

getGUI

public UserDisplayControlFX.DisplayControlGUI getGUI(int flag)

Description copied from class: PamControlledUnit

Get the GUI for the PAMControlled unit. This has multiple GUI options which are instantiated depending on the view type.

Overrides:

getGUI in class PamControlledUnit

Parameters:

flag - . The GUI type flag defined in PAMGuiManager.

Returns:

the GUI for the PamControlledUnit unit.