Package userDisplay

Interface UserDisplayProvider

All Known Implementing Classes:
AnalogDiagnosticsDisplayProvider, ArraySensorPanelProvider, BackupDisplayProvider, BeamLocDisplayProvider, BearingDisplayProvider, DetectionGroupTableProvider, DifarDisplayProvider, DifarDisplayProvider2, EffortDisplayProvider, LocaliserDisplayProvider, Map3DDisplayProvider, MapDisplayProvider, QADisplayProvider, RadarDisplayProvider, SonobuoyManagerProvider, SpectrogramDiplayProvider, TDDisplayProvider, TDDisplayProviderFX
public interface UserDisplayProvider
Provider of displays for the main display panel. Can be implemented by anything anywhere in PAMGUard and will add the appropriate menu command to the user display menu, etc.
Author:
Doug Gillespie

  • Method Details

    • getName

      String getName()
      Returns:
      the name of the display to be shown in the user display menu

    • getComponent

      UserDisplayComponent getComponent(UserDisplayControl userDisplayControl, String uniqueDisplayName)
      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

      Class getComponentClass()
      Returns:
      the class of the swing component.

    • getMaxDisplays

      int getMaxDisplays()
      Returns:
      the max mumber of displays that can be created. 0 indicates no limit.

    • canCreate

      boolean canCreate()
      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

      void removeDisplay(UserDisplayComponent component)
      Called when a display is removed from a user display.
      Parameters:
      component - removed component.