Package PamView

Class PamObjectViewer

java.lang.Object

PamView.PamObjectViewer

All Implemented Interfaces:

ComponentListener, EventListener, PamSettings, SettingsNameProvider, PamViewInterface

public class PamObjectViewer
extends Object
implements PamViewInterface, ComponentListener, PamSettings

Make a diagram of the overall PAM process layout. A bit like UML ! Contains menus to add modules, remove them, rename them, etc.

Author:

Doug Gillespie

Field Summary

Fields

Modifier and Type	Field	Description
static final int	arrowSize
static final int	instArrowSize

Method Summary

Modifier and Type	Method	Description
void	addControlledUnit(PamControlledUnit unit)	Called whenever a pamcontrolled unit is added ot the model.
void	componentHidden(ComponentEvent e)
void	componentMoved(ComponentEvent e)
void	componentResized(ComponentEvent e)
void	componentShown(ComponentEvent e)
void	enableGUIControl(boolean enable)	Enable and disable the entire GUI.
int	getFrameNumber()
JFrame	getGuiFrame()
static PamObjectViewer	getObjectViewer(Frame frame)
Serializable	getSettingsReference()
long	getSettingsVersion()
String	getUnitName()
String	getUnitType()
void	modelChanged(int changeType)
void	pamEnded()
void	pamStarted()
void	removeControlledUnit(PamControlledUnit unit)	Called whenever a controlled unit is removed.
boolean	restoreSettings(PamControlledUnitSettings pamControlledUnitSettings)
void	setTitle(String title)
static void	Show(Frame frame, PamConfiguration pamConfiguration)
void	showControlledUnit(PamControlledUnit unit)	Show the GUI for a specific controlled unit

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

arrowSize

public static final int arrowSize

See Also:

• Constant Field Values

instArrowSize

public static final int instArrowSize

See Also:

• Constant Field Values

Method Details

getObjectViewer

public static PamObjectViewer getObjectViewer(Frame frame)

Show

public static void Show(Frame frame,
 PamConfiguration pamConfiguration)

setTitle

public void setTitle(String title)

Specified by:

setTitle in interface PamViewInterface

componentHidden

public void componentHidden(ComponentEvent e)

Specified by:

componentHidden in interface ComponentListener

componentMoved

public void componentMoved(ComponentEvent e)

Specified by:

componentMoved in interface ComponentListener

componentResized

public void componentResized(ComponentEvent e)

Specified by:

componentResized in interface ComponentListener

componentShown

public void componentShown(ComponentEvent e)

Specified by:

componentShown in interface ComponentListener

modelChanged

public void modelChanged(int changeType)

Specified by:

modelChanged in interface PamViewInterface

pamEnded

public void pamEnded()

Specified by:

pamEnded in interface PamViewInterface

pamStarted

public void pamStarted()

Specified by:

pamStarted in interface PamViewInterface

getSettingsReference

public Serializable getSettingsReference()

Specified by:

getSettingsReference in interface PamSettings

Returns:

The serialisable object that will be stored

getSettingsVersion

public long getSettingsVersion()

Specified by:

getSettingsVersion in interface PamSettings

Returns:

An integer version number for the settings

getUnitName

public String getUnitName()

Specified by:

getUnitName in interface SettingsNameProvider

Returns:

A Name specific to this instance of the particular class, e.g. Sperm whale detector, Beaked whale detector, etc.

getUnitType

public String getUnitType()

Specified by:

getUnitType in interface PamSettings

Returns:

A Name specific to the type, e.g. Click detector

restoreSettings

public boolean restoreSettings(PamControlledUnitSettings pamControlledUnitSettings)

Specified by:

restoreSettings in interface PamSettings

Parameters:

pamControlledUnitSettings -

Returns:

true if successful The object performs final checks (if needed) and then casts the settings data pamcontrolledunitSettings.settings into the correct type and uses as required

addControlledUnit

public void addControlledUnit(PamControlledUnit unit)

Description copied from interface: PamViewInterface

Called whenever a pamcontrolled unit is added ot the model.

Specified by:

addControlledUnit in interface PamViewInterface

Parameters:

unit - - the added controlled unit.

removeControlledUnit

public void removeControlledUnit(PamControlledUnit unit)

Description copied from interface: PamViewInterface

Called whenever a controlled unit is removed.

Specified by:

removeControlledUnit in interface PamViewInterface

Parameters:

unit -

showControlledUnit

public void showControlledUnit(PamControlledUnit unit)

Description copied from interface: PamViewInterface

Show the GUI for a specific controlled unit

Specified by:

showControlledUnit in interface PamViewInterface

Parameters:

unit - -the controlled unit to show.

getFrameNumber

public int getFrameNumber()

Specified by:

getFrameNumber in interface PamViewInterface

Returns:

Frame number used by the multiple GUI frames. All other objects, such as the model view should return invalid input: '<' 0.

getGuiFrame

public JFrame getGuiFrame()

Specified by:

getGuiFrame in interface PamViewInterface

enableGUIControl

public void enableGUIControl(boolean enable)

Description copied from interface: PamViewInterface

Enable and disable the entire GUI.

Specified by:

enableGUIControl in interface PamViewInterface

Parameters:

enable - - true to enable the GUI/