| |
|
| java.lang.Object com.ecyrd.jspwiki.ui.progress.ProgressManager
ProgressManager | public class ProgressManager (Code) | | Manages progressing items. In general this class is used whenever JSPWiki
is doing something which may require a long time. In addition, this manager
provides a JSON interface for finding remotely what the progress is. The
JSON object name is JSON_PROGRESSTRACKER = "
".
author: Janne Jalkanen since: 2.6 |
Inner Class :public class JSONTracker implements RPCCallable | |
Constructor Summary | |
public | ProgressManager() Creates a new ProgressManager. |
Method Summary | |
public String | getNewProgressIdentifier() You can use this to get an unique process identifier. | public int | getProgress(String id) Get the progress in percents.
Parameters: id - The progress identifier. | public void | startProgress(ProgressItem pi, String id) Call this method to get your ProgressItem into the ProgressManager queue. | public void | stopProgress(String id) Call this method to remove your ProgressItem from the queue (after which
getProgress() will no longer find it. |
JSON_PROGRESSTRACKER | final public static String JSON_PROGRESSTRACKER(Code) | | The name of the progress tracker JSON object. The current value is "
",
|
ProgressManager | public ProgressManager()(Code) | | Creates a new ProgressManager.
|
getNewProgressIdentifier | public String getNewProgressIdentifier()(Code) | | You can use this to get an unique process identifier.
A new random value |
startProgress | public void startProgress(ProgressItem pi, String id)(Code) | | Call this method to get your ProgressItem into the ProgressManager queue.
The ProgressItem will be moved to state STARTED.
Parameters: pi - ProgressItem to start Parameters: id - The progress identifier |
stopProgress | public void stopProgress(String id)(Code) | | Call this method to remove your ProgressItem from the queue (after which
getProgress() will no longer find it. The ProgressItem will be moved to state
STOPPED.
Parameters: id - The progress identifier |
|
|
|