public class Progress extends Object
Constructor and Description |
---|
Progress() |
Modifier and Type | Method and Description |
---|---|
static void |
finish(ProgressTicket progressTicket)
Finish the progress task.
|
static void |
finish(ProgressTicket progressTicket,
String finishMessage)
Finish the progress task and display a wrap-up message
|
static String |
getDisplayName(ProgressTicket progressTicket)
Returns the current task's display name, or an empty string.
|
static void |
progress(ProgressTicket progressTicket)
Notify the user about a new completed unit.
|
static void |
progress(ProgressTicket progressTicket,
int workunit)
Notify the user about completed workunits.
|
static void |
progress(ProgressTicket progressTicket,
String message)
Notify the user about progress by showing message with details.
|
static void |
progress(ProgressTicket progressTicket,
String message,
int workunit)
Notify the user about completed workunits and show additional detailed message.
|
static void |
setDisplayName(ProgressTicket progressTicket,
String newDisplayName)
Change the display name of the progress task.
|
static void |
start(ProgressTicket progressTicket)
Start the progress indication for indeterminate task.
|
static void |
start(ProgressTicket progressTicket,
int workunits)
Start the progress indication for a task with known number of steps.
|
static void |
switchToDeterminate(ProgressTicket progressTicket,
int workunits)
Currently indeterminate task can be switched to show percentage completed.
|
static void |
switchToIndeterminate(ProgressTicket progressTicket)
Currently determinate task can be switched to indeterminate mode.
|
public static void finish(ProgressTicket progressTicket)
progressTicket
- the progress ticket of the taskpublic static void finish(ProgressTicket progressTicket, String finishMessage)
progressTicket
- the progress ticket of the taskfinishMessage
- a message about the finished taskpublic static void progress(ProgressTicket progressTicket)
progressTicket
- the progress ticket of the taskpublic static void progress(ProgressTicket progressTicket, int workunit)
progressTicket
- the progress ticket of the taskworkunit
- a cumulative number of workunits completed so farpublic static void progress(ProgressTicket progressTicket, String message)
progressTicket
- the progress ticket of the taskmessage
- details about the status of the taskpublic static void progress(ProgressTicket progressTicket, String message, int workunit)
progressTicket
- the progress ticket of the taskmessage
- details about the status of the taskworkunit
- a cumulative number of workunits completed so farpublic static void setDisplayName(ProgressTicket progressTicket, String newDisplayName)
progressTicket
- the progress ticket of the tasknewDisplayName
- the new display namepublic static String getDisplayName(ProgressTicket progressTicket)
public static void start(ProgressTicket progressTicket)
progressTicket
- the progress ticket of the taskpublic static void start(ProgressTicket progressTicket, int workunits)
progressTicket
- the progress ticket of the taskworkunits
- total number of workunits that will be processedpublic static void switchToDeterminate(ProgressTicket progressTicket, int workunits)
progressTicket
- the progress ticket of the taskworkunits
- workunits total number of workunits that will be processedpublic static void switchToIndeterminate(ProgressTicket progressTicket)
progressTicket
- the progress ticket of the taskCopyright © 2007–2017 Gephi Consortium. All rights reserved.