Package beamformer.localiser.plot

Class BeamLocDisplayProvider

java.lang.Object

beamformer.localiser.plot.BeamLocDisplayProvider

All Implemented Interfaces:

UserDisplayProvider

public class BeamLocDisplayProvider
extends Object
implements UserDisplayProvider

Constructor Summary

Constructors

Constructor	Description
BeamLocDisplayProvider(BeamFormLocaliserControl bfLocaliserControl)

Method Summary

Modifier and Type	Method	Description
boolean	canCreate()
UserDisplayComponent	getComponent(UserDisplayControl userDisplayControl, String uniqueDisplayName)
Class	getComponentClass()
int	getMaxDisplays()
String	getName()
void	removeDisplay(UserDisplayComponent component)	Called when a display is removed from a user display.

Methods inherited from class java.lang.Object

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

Constructor Details

BeamLocDisplayProvider

public BeamLocDisplayProvider(BeamFormLocaliserControl bfLocaliserControl)

Method Details

getName

public String getName()

Specified by:

getName in interface UserDisplayProvider

Returns:

the name of the display to be shown in the user display menu

getComponent

public UserDisplayComponent getComponent(UserDisplayControl userDisplayControl,
 String uniqueDisplayName)

Specified by:

getComponent in interface UserDisplayProvider

Parameters:

userDisplayControl - the user display that this component is being created within.

uniqueDisplayName - unique name for the display. This may need to be passed early to a display so that it can find settings based on this name.

Returns:

The swing component to add into a frame within the user display.

getComponentClass

public Class getComponentClass()

Specified by:

getComponentClass in interface UserDisplayProvider

Returns:

the class of the swing component.

getMaxDisplays

public int getMaxDisplays()

Specified by:

getMaxDisplays in interface UserDisplayProvider

Returns:

the max mumber of displays that can be created. 0 indicates no limit.

canCreate

public boolean canCreate()

Specified by:

canCreate in interface UserDisplayProvider

Returns:

true if another display can be created (i.e. number of displays is invalid input: '<' the max number or there is no max number.

removeDisplay

public void removeDisplay(UserDisplayComponent component)

Description copied from interface: UserDisplayProvider

Called when a display is removed from a user display.

Specified by:

removeDisplay in interface UserDisplayProvider

Parameters:

component - removed component.