org.scijava.app.event
Class StatusEvent

java.lang.Object
  extended by org.scijava.AbstractContextual
      extended by org.scijava.event.SciJavaEvent
          extended by org.scijava.app.event.StatusEvent
All Implemented Interfaces:
Contextual

public class StatusEvent
extends SciJavaEvent

An event indicating a status update.

Author:
Curtis Rueden

Constructor Summary
StatusEvent(int progress, int maximum)
           
StatusEvent(int progress, int maximum, String message)
           
StatusEvent(int progress, int maximum, String message, boolean warn)
           
StatusEvent(String message)
           
StatusEvent(String message, boolean warn)
           
 
Method Summary
 int getProgressMaximum()
          Gets progress maximum.
 int getProgressValue()
          Gets progress value.
 String getStatusMessage()
          Gets status message, or null for no change.
 boolean isWarning()
          Returns whether or not this is a warning event.
 String toString()
           
 
Methods inherited from class org.scijava.event.SciJavaEvent
consume, getCallingThread, getStackTrace, isConsumed, setCallingThread, setConsumed
 
Methods inherited from class org.scijava.AbstractContextual
context, getContext, setContext
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

StatusEvent

public StatusEvent(String message)

StatusEvent

public StatusEvent(String message,
                   boolean warn)

StatusEvent

public StatusEvent(int progress,
                   int maximum)

StatusEvent

public StatusEvent(int progress,
                   int maximum,
                   String message)

StatusEvent

public StatusEvent(int progress,
                   int maximum,
                   String message,
                   boolean warn)
Method Detail

getProgressValue

public int getProgressValue()
Gets progress value. Returns -1 if progress is unknown.


getProgressMaximum

public int getProgressMaximum()
Gets progress maximum. Returns -1 if progress is unknown.


getStatusMessage

public String getStatusMessage()
Gets status message, or null for no change.


isWarning

public boolean isWarning()
Returns whether or not this is a warning event.


toString

public String toString()
Overrides:
toString in class SciJavaEvent


Copyright © 2009–2014 SciJava. All rights reserved.