Interface DownloadIndicator

All Known Implementing Classes:
DefaultDownloadIndicator, DummyDownloadIndicator
public interface DownloadIndicator
A DownloadIndicator creates DownloadServiceListeners that are notified of resources being transferred and their progress.
Version:
$Revision: 1.8 $

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    disposeListener(DownloadServiceListener listener)
    Indicates that a download service listener that was obtained from the getDownloadListener method will no longer be used.
    DownloadServiceListener
    getListener(String downloadName, URL[] resources)
    Return a download service listener that displays the progress of downloading resources.

  • Method Details

    • getListener

      DownloadServiceListener getListener(String downloadName, URL[] resources)
      Return a download service listener that displays the progress of downloading resources. Update messages may be reported for URLs that are not included initially.

      Progress messages are sent as if the DownloadServiceListener were listening to a DownloadService request. The listener will receive progress messages from time to time during the download.

      Parameters:
      downloadName - name identifying the download to the user
      resources - initial urls to display, empty if none known at start
      Returns:
      dedicated listener

    • disposeListener

      void disposeListener(DownloadServiceListener listener)
      Indicates that a download service listener that was obtained from the getDownloadListener method will no longer be used. This method can be used to ensure that progress dialogs are properly removed once a particular download is finished.
      Parameters:
      listener - the listener that is no longer in use