Package noaa.coastwatch.gui

Interface DataViewOverlayControl

All Known Implementing Classes:
NavigationAnalysisPanel
public interface DataViewOverlayControl
The DataViewOverlayControl class is an interface that can be implemented by any class that acts to control the overlay content of an EarthDataViewPanel. The control signals a change in the overlays that should be displayed on the view using OVERLAY_LIST_PROPERTY, and a change in the operation mode using OPERATION_MODE_PROPERTY. The operation mode property controls what drawing mode the view should use, and uses mode constants from the LightTable class.
Since:
3.2.2
Author:
Peter Hollemans

  • Field Details

  • Method Details

    • deactivate

      void deactivate()
      Deactivates the control. This is used to signal to the control that some other control has been set active. The control unclicks any buttons that indicate the operation mode.

    • addPropertyChangeListener

      void addPropertyChangeListener(String propertyName, PropertyChangeListener listener)
      Adds a change listener to the list. The control signals changes in its properties using OVERLAY_LIST_PROPERTY and OPERATION_MODE_PROPERTY.
      Parameters:
      propertyName - the property to listen for.
      listener - the listener to call when a property change occurs.

    • performOperation

      void performOperation(Shape shape)
      Performs a view control operation using the specified shape. The shape should correspond to the current operation mode. Generally, this method is called when the user performs some interactive operation on the view and the resulting shape is made available.
      Parameters:
      shape - the shape to perform the operation for.

    • isActive

      boolean isActive()
      Gets the control activity state.
      Returns:
      true if the control is in an active state, or false if not. An active control is a control that is ready to perform an operation using performOperation(java.awt.Shape).

    • getOperationMode

      LightTable.Mode getOperationMode()
      Gets the current operation mode.
      Returns:
      the current operation mode as a mode from the LightTable class.