Package org.graffiti.util

Interface ProgressViewer

All Known Subinterfaces:
SplashScreenInterface
All Known Implementing Classes:
ClusterSplashScreen, DBEsplashScreen, SplashScreen
public interface ProgressViewer
A class that displays in some sense progress made while a long running task.
Version:
$Revision: 1.5 $ $Date: 2010/12/22 13:05:33 $
Author:
Michael Forster

  • Method Summary

    Modifier and Type Method Description
    int getMaximum()  
    int getValue()
    Returns the progress viewer's current value.
    void setMaximum​(int n)
    Sets the progress viewer's maximum value to n.
    void setText​(String text)
    Sets the value of the progress text.
    void setValue​(int n)
    Sets the progress viewer's current value to n.

  • Method Details

    • setMaximum

      void setMaximum​(int n)
      Sets the progress viewer's maximum value to n. By default, the maximum value is 100.
      Parameters:
      n - the new maximum

    • setText

      void setText​(String text)
      Sets the value of the progress text. By default, this string is null. If you have provided a custom progress string and want to revert to the built-in behavior, set the string back to null.
      Parameters:
      text - the value of the progress string

    • setValue

      void setValue​(int n)
      Sets the progress viewer's current value to n.
      Parameters:
      n - the new value

    • getValue

      int getValue()
      Returns the progress viewer's current value. The value is always between the zero and the maximum values, inclusive. By default, the value is initialized to zero.
      Returns:
      DOCUMENT ME!

    • getMaximum

      int getMaximum()