|
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjava.lang.Thread
org.opencms.workplace.commons.CmsProgressThread
This class is used to build a list (A_CmsListDialog
) in the background
and to show the progress of building to the user.
To work correctly the operations while building the list have to update the actual progress.
Field Summary |
Fields inherited from class java.lang.Thread |
MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY |
Constructor Summary | |
CmsProgressThread(A_CmsListDialog list,
java.lang.String key,
java.util.Locale locale)
Constructs a new progress thread with the given name. |
Method Summary | |
java.lang.String |
getDescription()
Returns the description to show for the progress. |
java.lang.Throwable |
getError()
Returns the error exception in case there was an error during the execution of this thread, null otherwise. |
long |
getFinishTime()
Returns the time the thread was finished. |
java.lang.String |
getKey()
Returns the key of this thread. |
A_CmsListDialog |
getList()
Returns the list of the progress bar. |
java.util.Locale |
getLocale()
Returns the locale to use for this thread. |
int |
getProgress()
Returns the progress. |
java.lang.String |
getResult()
Returns the finished result as HTML of the list. |
long |
getRuntime()
Returns the time this report has been running. |
long |
getStartTime()
Returns the time the thread has started. |
void |
run()
|
void |
setDescription(java.lang.String description)
Sets the description to show for the progress. |
void |
setLocale(java.util.Locale locale)
Sets the locale to use for this thread. |
void |
setProgress(int progress)
Sets the progress. |
Methods inherited from class java.lang.Thread |
activeCount, checkAccess, countStackFrames, currentThread, destroy, dumpStack, enumerate, getContextClassLoader, getName, getPriority, getThreadGroup, holdsLock, interrupt, interrupted, isAlive, isDaemon, isInterrupted, join, join, join, resume, setContextClassLoader, setDaemon, setName, setPriority, sleep, sleep, start, stop, stop, suspend, toString, yield |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
public CmsProgressThread(A_CmsListDialog list, java.lang.String key, java.util.Locale locale)
list
- the list to use for the progress to displaykey
- the key of the threadlocale
- the locale to use for this threadMethod Detail |
public java.lang.String getDescription()
public java.lang.Throwable getError()
public long getFinishTime()
public java.lang.String getKey()
public A_CmsListDialog getList()
public java.util.Locale getLocale()
public int getProgress()
public java.lang.String getResult()
public long getRuntime()
public long getStartTime()
public void run()
Thread.run()
public void setDescription(java.lang.String description)
description
- the description to show for the progress to setpublic void setLocale(java.util.Locale locale)
locale
- the locale to use for this thread to setpublic void setProgress(int progress)
progress
- the progress to set
|
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |