ProgressIndicatorBase (Scriptella API Documentation)

java.lang.Object

scriptella.interactive.ProgressIndicatorBase

All Implemented Interfaces:: ProgressIndicator

Direct Known Subclasses:: ConsoleProgressIndicator, SwingProgressIndicator

public abstract class ProgressIndicatorBase extends Object implements ProgressIndicator

TODO: Add documentation

Version:: 1.0
Author:: Fyodor Kupolov

Constructor Summary

Constructors

Constructor

Description

ProgressIndicatorBase()
Method Summary

Modifier and Type

Method

Description

protected double

getOutputThreshold()

protected void

onComplete(String label)

protected abstract void

show(String label, double progress)

void

showProgress(double progress, String message)

Invoked when script execution progress has been changed.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details
- ProgressIndicatorBase
  
  public ProgressIndicatorBase()
Method Details
- showProgress
  
  public void showProgress(double progress, String message)
  
  Description copied from interface: ProgressIndicator
  
  Invoked when script execution progress has been changed.
  
  Specified by:
  
  showProgress in interface ProgressIndicator
  
  Parameters:
  
  progress - progress value between 0 and 1 inclusive.
  
  message - completed event description.
- getOutputThreshold
  
  protected double getOutputThreshold()
- show
  
  protected abstract void show(String label, double progress)
- onComplete
  
  protected void onComplete(String label)