Package annotation

Interface AnnotationDialogPanel

All Known Implementing Classes:
SNRAnnotationPanel, SPLAnnotationPanel, StringDialogPanel, TimestampDialogPanel, UserFormDialogPanel, WavAnnotationPanel
public interface AnnotationDialogPanel
General interface for dialog panels which get incorporated into other dialog panels for editing one or more annotations of a data unit.
Author:
Doug Gillespie

  • Method Summary

    Modifier and Type
    Method
    Description
    JComponent
    getDialogComponent()
    Get the awt component which will be incorporated into a larger display panel / component.
    boolean
    getParams(PamDataUnit pamDataUnit)
     
    void
    setParams(PamDataUnit pamDataUnit)
    Set the initial parameter values in the panel.

  • Method Details

    • getDialogComponent

      JComponent getDialogComponent()
      Get the awt component which will be incorporated into a larger display panel / component.
      Returns:
      an awt component.

    • setParams

      void setParams(PamDataUnit pamDataUnit)
      Set the initial parameter values in the panel. Since this interface is purely abstract, the type of parameter is unknown, so concrete implementations will somehow have to pass the class containing the parameter information in some other way.
      Parameters:
      pamDataUnit - Data unit to update annotation on

    • getParams

      boolean getParams(PamDataUnit pamDataUnit)
      Parameters:
      pamDataUnit - Data unit to update annotation on
      Returns:
      true if parameters all have acceptable values and the dialog can close.