Gephi Toolkit Javadoc

org.gephi.utils.progress
Interface ProgressTicket


public interface ProgressTicket

Progress task following, must be used from Progress class.

Author:
Mathieu Bastian

Method Summary
 void finish()
          Finish the progress task.
 void finish(java.lang.String finishMessage)
          Finish the progress task and show and wrap-up message
 java.lang.String getDisplayName()
          Returns the current display name
 void progress()
          Notify the user about a new completed unit.
 void progress(int workunit)
          Notify the user about completed workunits.
 void progress(java.lang.String message)
          Notify the user about progress by showing message with details.
 void progress(java.lang.String message, int workunit)
          Notify the user about completed workunits and show additional detailed message.
 void setDisplayName(java.lang.String newDisplayName)
          Change the display name of the progress task.
 void start()
          Start the progress indication for indeterminate task.
 void start(int workunits)
          Start the progress indication for a task with known number of steps.
 void switchToDeterminate(int workunits)
          Currently indeterminate task can be switched to show percentage completed.
 void switchToIndeterminate()
          Currently determinate task can be switched to indeterminate mode.
 

Method Detail

finish

void finish()
Finish the progress task.


finish

void finish(java.lang.String finishMessage)
Finish the progress task and show and wrap-up message

Parameters:
finishMessage - a message about the finished task

progress

void progress()
Notify the user about a new completed unit. Equivalent to incrementing workunits by one.


progress

void progress(int workunit)
Notify the user about completed workunits.

Parameters:
workunit - a cumulative number of workunits completed so far

progress

void progress(java.lang.String message)
Notify the user about progress by showing message with details.

Parameters:
message - about the status of the task

progress

void progress(java.lang.String message,
              int workunit)
Notify the user about completed workunits and show additional detailed message.

Parameters:
message - details about the status of the task
workunit - a cumulative number of workunits completed so far

setDisplayName

void setDisplayName(java.lang.String newDisplayName)
Change the display name of the progress task. Use with care, please make sure the changed name is not completely different, or otherwise it might appear to the user as a different task.

Parameters:
newDisplayName - the new display name

getDisplayName

java.lang.String getDisplayName()
Returns the current display name

Returns:
the current display name

start

void start()
Start the progress indication for indeterminate task.


start

void start(int workunits)
Start the progress indication for a task with known number of steps.

Parameters:
workunits - total number of workunits that will be processed

switchToDeterminate

void switchToDeterminate(int workunits)
Currently indeterminate task can be switched to show percentage completed.

Parameters:
workunits - workunits total number of workunits that will be processed

switchToIndeterminate

void switchToIndeterminate()
Currently determinate task can be switched to indeterminate mode.


Gephi Toolkit Javadoc