Package com.inductiveautomation.ignition.client.util.gui.progress

Interface AsyncClientTask

All Known Implementing Classes:
CopyTagJsonAction.Task, HierarchialTranslationTable.AbstractExportTask, HierarchialTranslationTable.AbstractImportTask, HierarchialTranslationTable.PropBasedExportTask, HierarchialTranslationTable.PropBasedImportTask, TagTransferHandler.ImportClientTagTask, TagTransferHandler.ImportTagJsonTask, TagTransferHandler.MoveClientTagTask, TagTransferHandler.OpcImportTask, TagTransferHandler.TagPasteTask
public interface AsyncClientTask
An AsyncClientTask is a task that can be executed through the client progress manager. It is very similar to a runnable, but the run function takes a progress listener, and can throw an exception.

The task can also specify whether or not the user is allowed to cancel the operation (if so, the canceled state will be visible through the progressListener), and can specify a title for the operation.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    canCancel()
    Whether or not the user is allowed to cancel the operation.
    String
    getTaskTitle()
    A helpful title describing the operation for the user.
    void
    run(TaskProgressListener progressListener)
    The "work" function.

  • Method Details

    • getTaskTitle

      String getTaskTitle()
      A helpful title describing the operation for the user.

    • canCancel

      boolean canCancel()
      Whether or not the user is allowed to cancel the operation.

    • run

      void run(TaskProgressListener progressListener) throws Exception
      The "work" function. Should update the progressListener of status, and check whether the operation has been canceled, if applicable. Should throw an exception on failure.
      Throws:
      Exception