Package chemaxon.core.util

Interface MProgressMonitor

All Superinterfaces:
ProgressMonitor
@PublicApi @Deprecated(forRemoval=true) @SubjectToRemoval(date=JAN_01_2027) public interface MProgressMonitor extends ProgressMonitor
Deprecated, for removal: This API element is subject to removal in a future version.
Use ProgressMonitor instead.
Progress monitor interface.
Since:
Marvin 4.0, 07/12/2005

  • Method Summary

    Modifier and Type
    Method
    Description
    MProgressMonitor
    getChild()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Gets the child of this progress monitor.
    int
    getLevel()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Gets the level of this progress monitor.
    int
    getMaximum()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Gets the maximum progress value.
    default void
    init(String note, int max)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Initializes progress monitoring.
    void
    initProgressMonitor(String note, int min, int max)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Create a progress monitor.
    boolean
    isCanceled()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Tests whether the user canceled the dialog.
    boolean
    isDialogVisible()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Tests whether the dialog is visible.
    MProgressMonitor
    newInstance()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Creates new monitor with same parent, message, levels.
    void
    setMaximum(int v)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Gets the maximum value.
    boolean
    setProgressValue(int x)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Set progress.
    default void
    setValue(int value)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Sets the current progress value.

    Methods inherited from interface chemaxon.core.util.ProgressMonitor

    init

  • Method Details

    • init

      default void init(String note, int max)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from interface: ProgressMonitor
      Initializes progress monitoring. Resets progress if it was set before.
      Specified by:
      init in interface ProgressMonitor
      Parameters:
      note - optional note that describes the process (e.g. to display in a dialog)
      max - maximum progress value

    • setValue

      default void setValue(int value)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from interface: ProgressMonitor
      Sets the current progress value. It must be between 0 and ProgressMonitor.getMaximum().
      Specified by:
      setValue in interface ProgressMonitor
      Parameters:
      value - the current progress value

    • getMaximum

      int getMaximum()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Gets the maximum progress value.
      Specified by:
      getMaximum in interface ProgressMonitor
      Returns:
      the maximum progress value

    • initProgressMonitor

      void initProgressMonitor(String note, int min, int max)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Create a progress monitor.
      Parameters:
      note - text to appear in the dialog
      min - initial progress value
      max - final progress value

    • setProgressValue

      boolean setProgressValue(int x)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Set progress.
      Parameters:
      x - the current progress value
      Returns:
      true if progressing fine, false if canceled

    • setMaximum

      void setMaximum(int v)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Gets the maximum value.
      Parameters:
      v - the maximum value

    • isCanceled

      boolean isCanceled()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Tests whether the user canceled the dialog.
      Specified by:
      isCanceled in interface ProgressMonitor
      Returns:
      true if the progress dialog is canceled, false otherwise

    • getChild

      MProgressMonitor getChild()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Gets the child of this progress monitor.
      Returns:
      the child or null

    • getLevel

      int getLevel()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Gets the level of this progress monitor.
      Returns:
      the level

    • isDialogVisible

      boolean isDialogVisible()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Tests whether the dialog is visible.
      Returns:
      true if the progress dialog is visible, false otherwise

    • newInstance

      MProgressMonitor newInstance()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Creates new monitor with same parent, message, levels.
      Returns:
      the new progress monitor