EchoPoint API - 3.0.0b5
App Webcontainer

echopoint.tucana
Class UploadRenderState

java.lang.Object
  extended by echopoint.tucana.UploadRenderState
All Implemented Interfaces:
Serializable, RenderState

public class UploadRenderState
extends Object
implements RenderState

RenderState implementation for UploadSelect components. This class is thread-safe.

Version:
$Id: UploadRenderState.java 90 2008-11-11 01:41:05Z sptrakesh $
Author:
Echo FileTransfer Library
See Also:
Serialized Form

Constructor Summary
UploadRenderState()
          Creates a new UploadRenderState.
 
Method Summary
 UploadProgress getProgress(String uploadIndex)
          Gets the progress for the given upload index.
 String getUploadIndex()
          Gets the maximum upload index currently in use.
 boolean isUploadEnded(String uploadIndex)
          Determines whether the upload with the specified index has ended.
 void setProgress(String uploadIndex, UploadProgress progress)
          Sets the progress for the specified upload index.
 void uploadEnded(String uploadIndex)
          Announces that an upload with given index has ended.
 void uploadStarted(String uploadIndex)
          Announces that an upload with given index has started.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

UploadRenderState

public UploadRenderState()
Creates a new UploadRenderState.

Method Detail

getUploadIndex

public String getUploadIndex()
Gets the maximum upload index currently in use. This index can be used to prevent duplicate indices when performing client-side refreshes.

Returns:
the index or -1 if no uploads indices are present.

uploadStarted

public void uploadStarted(String uploadIndex)
Announces that an upload with given index has started.

Parameters:
uploadIndex - the upload index

isUploadEnded

public boolean isUploadEnded(String uploadIndex)
Determines whether the upload with the specified index has ended.

Parameters:
uploadIndex - the upload index
Returns:
true if the upload has ended.

uploadEnded

public void uploadEnded(String uploadIndex)
Announces that an upload with given index has ended.

Parameters:
uploadIndex - The upload index for the current upload.

getProgress

public UploadProgress getProgress(String uploadIndex)
Gets the progress for the given upload index.

Parameters:
uploadIndex - the upload index
Returns:
the progress if available, null otherwise.

setProgress

public void setProgress(String uploadIndex,
                        UploadProgress progress)
Sets the progress for the specified upload index.

Parameters:
uploadIndex - the upload index
progress - the progress

EchoPoint API - 3.0.0b5
App Webcontainer