Package PamView.paneloverlay

Class OverlayDataManager<TOverlayInfoType extends OverlayDataInfo>

java.lang.Object

PamView.paneloverlay.OverlayDataManager<TOverlayInfoType>

All Implemented Interfaces:

OverlayDataObserver

Direct Known Subclasses:

BasicMarkDataSelector, MapGroupOverlayManager, SpectrogramOverlayDataManager

public abstract class OverlayDataManager<TOverlayInfoType extends OverlayDataInfo>
extends Object
implements OverlayDataObserver

Provides functions for managing lists of overlays which might be used with a specific GeneralProjector, i.e. any data block that might draw on that projector. Provides checkable menu lists, dialog panels with check boxes and options, etc. It will also handle storing of selections within lists of data, and provide names to dataselectors within datablocks.

Author:

Doug Gillespie

Constructor Summary

Constructors

Constructor	Description
OverlayDataManager(GeneralProjector.ParameterType[] parameterTypes, GeneralProjector.ParameterUnits[] parameterUnits)

Method Summary

Modifier and Type	Method	Description
int	addSelectionMenuItems(JComponent menu, Window awtWindow, boolean sortAlphabetical, boolean allowScores, boolean includeSymbolManagement)	Add all items associated with the list to a
abstract String	getDataSelectorName()
abstract TOverlayInfoType	getOverlayInfo(PamDataBlock dataBlock)	Get the OverlayDataInfo associated with these items - it's possible that these will have been extended to contain additional information so don't handle them too directly in the abstract class.
GeneralProjector.ParameterType[]	getParameterTypes()
GeneralProjector.ParameterUnits[]	getParameterUnits()
OverlaySwingPanel	getSwingPanel(Window parentWindow)
List<PamDataBlock>	listDataBlocks(boolean sortAlphabetical)	Get a list of all datablocks that can use this projector

Methods inherited from class java.lang.Object

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

Methods inherited from interface PamView.paneloverlay.OverlayDataObserver

selectionChanged

Constructor Details

OverlayDataManager

public OverlayDataManager(GeneralProjector.ParameterType[] parameterTypes,
 GeneralProjector.ParameterUnits[] parameterUnits)

Parameters:

generalProjector -

Method Details

listDataBlocks

public List<PamDataBlock> listDataBlocks(boolean sortAlphabetical)

Get a list of all datablocks that can use this projector

Parameters:

sortAlphabetical - sort the list alphabetically.

Returns:

a list of data blocks.

getSwingPanel

public OverlaySwingPanel getSwingPanel(Window parentWindow)

getDataSelectorName

public abstract String getDataSelectorName()

Returns:

a String name for a dataselector associated with this. this will generally be the name of an associated PamControlledUnit.

getOverlayInfo

public abstract TOverlayInfoType getOverlayInfo(PamDataBlock dataBlock)

Get the OverlayDataInfo associated with these items - it's possible that these will have been extended to contain additional information so don't handle them too directly in the abstract class. .

Parameters:

dataBlock - associated datablock.

Returns:

an OverlayDataInfo - must not be null, so create one if needed.

addSelectionMenuItems

public int addSelectionMenuItems(JComponent menu,
 Window awtWindow,
 boolean sortAlphabetical,
 boolean allowScores,
 boolean includeSymbolManagement)

Add all items associated with the list to a

Parameters:

menu -

Returns:

getParameterTypes

public GeneralProjector.ParameterType[] getParameterTypes()

Returns:

the parameterTypes

getParameterUnits

public GeneralProjector.ParameterUnits[] getParameterUnits()

Returns:

the parameterUnits