public interface ProgressTicket
Progress
class.Modifier and Type | Method and Description |
---|---|
void |
finish()
Finish the progress task.
|
void |
finish(String finishMessage)
Finish the progress task and show and wrap-up message
|
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(String message)
Notify the user about progress by showing message with details.
|
void |
progress(String message,
int workunit)
Notify the user about completed workunits and show additional detailed message.
|
void |
setDisplayName(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.
|
void finish()
void finish(String finishMessage)
finishMessage
- a message about the finished taskvoid progress()
void progress(int workunit)
workunit
- a cumulative number of workunits completed so farvoid progress(String message)
message
- about the status of the taskvoid progress(String message, int workunit)
message
- details about the status of the taskworkunit
- a cumulative number of workunits completed so farvoid setDisplayName(String newDisplayName)
newDisplayName
- the new display nameString getDisplayName()
void start()
void start(int workunits)
workunits
- total number of workunits that will be processedvoid switchToDeterminate(int workunits)
workunits
- workunits total number of workunits that will be processedvoid switchToIndeterminate()
Copyright © 2007–2017 Gephi Consortium. All rights reserved.