Package Spectrogram

Class SpectrogramDiplayProvider

java.lang.Object

Spectrogram.SpectrogramDiplayProvider

All Implemented Interfaces:

UserDisplayProvider

public class SpectrogramDiplayProvider
extends Object
implements UserDisplayProvider

Constructor Summary

Constructors

Constructor	Description
SpectrogramDiplayProvider()

Method Summary

Modifier and Type	Method	Description
boolean	canCreate()
SpectrogramDisplayComponent	createSpectrogramDisplay(UserDisplayControl userDisplayControl, SpectrogramParameters spectrogramParameters, String uniqueDisplayName)	This can be used to recreate spectrogram displays from old configurations with their correct settings.
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.
void	setReadyParameters(SpectrogramParameters spectrogramParameters)	Set parameters ready for the next constructed display.

Methods inherited from class java.lang.Object

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

Constructor Details

SpectrogramDiplayProvider

public SpectrogramDiplayProvider()

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.

createSpectrogramDisplay

public SpectrogramDisplayComponent createSpectrogramDisplay(UserDisplayControl userDisplayControl,
 SpectrogramParameters spectrogramParameters,
 String uniqueDisplayName)

This can be used to recreate spectrogram displays from old configurations with their correct settings. From now on though, all spectrograms will be responsible for doing their own settings.

Parameters:

userDisplayControl -

spectrogramParameters -

uniqueDisplayName -

Returns:

display component.

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.

setReadyParameters

public void setReadyParameters(SpectrogramParameters spectrogramParameters)

Set parameters ready for the next constructed display. this is used as a bit of a fudge when converting old stle params storage

Parameters:

spectrogramParameters -