|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.vaadin.terminal.AbstractClientConnector com.vaadin.ui.AbstractComponent com.vaadin.ui.Upload
public class Upload
Component for uploading files from client to server.
The visible component consists of a file name input box and a browse button and an upload submit button to start uploading.
The Upload component needs a java.io.OutputStream to write the uploaded data. You need to implement the Upload.Receiver interface and return the output stream in the receiveUpload() method.
You can get an event regarding starting (StartedEvent), progress (ProgressEvent), and finishing (FinishedEvent) of upload by implementing StartedListener, ProgressListener, and FinishedListener, respectively. The FinishedListener is called for both failed and succeeded uploads. If you wish to separate between these two cases, you can use SucceededListener (SucceededEvenet) and FailedListener (FailedEvent).
The upload component does not itself show upload progress, but you can use the ProgressIndicator for providing progress feedback by implementing ProgressListener and updating the indicator in updateProgress().
Setting upload component immediate initiates the upload as soon as a file is selected, instead of the common pattern of file selection field and upload button.
Note! Because of browser dependent implementations of element, setting size for Upload component is not supported. For some browsers setting size may work to some extend.
Nested Class Summary | |
---|---|
static class |
Upload.FailedEvent
Upload.FailedEvent event is sent when the upload is received, but the reception is interrupted for some reason. |
static interface |
Upload.FailedListener
Receives events when the uploads are finished, but unsuccessful. |
static class |
Upload.FinishedEvent
Upload.FinishedEvent is sent when the upload receives a file, regardless of whether the reception was successful or failed. |
static interface |
Upload.FinishedListener
Receives the events when the uploads are ready. |
static class |
Upload.NoInputStreamEvent
FailedEvent that indicates that an input stream could not be obtained. |
static class |
Upload.NoOutputStreamEvent
FailedEvent that indicates that an output stream could not be obtained. |
static interface |
Upload.ProgressListener
ProgressListener receives events to track progress of upload. |
static interface |
Upload.Receiver
Interface that must be implemented by the upload receivers to provide the Upload component an output stream to write the uploaded data. |
static class |
Upload.StartedEvent
Upload.StartedEvent event is sent when the upload is started to received. |
static interface |
Upload.StartedListener
Receives the events when the upload starts. |
static class |
Upload.SucceededEvent
Upload.SucceededEvent event is sent when the upload is received successfully. |
static interface |
Upload.SucceededListener
Receives events when the uploads are successfully finished. |
Nested classes/interfaces inherited from class com.vaadin.ui.AbstractComponent |
---|
AbstractComponent.ComponentErrorEvent, AbstractComponent.ComponentErrorHandler |
Nested classes/interfaces inherited from interface com.vaadin.terminal.VariableOwner |
---|
VariableOwner.ErrorEvent |
Nested classes/interfaces inherited from interface com.vaadin.ui.Component |
---|
Component.ErrorEvent, Component.ErrorListener, Component.Event, Component.Focusable, Component.Listener |
Nested classes/interfaces inherited from interface com.vaadin.terminal.Sizeable |
---|
Sizeable.Unit |
Field Summary |
---|
Fields inherited from interface com.vaadin.terminal.Sizeable |
---|
SIZE_UNDEFINED, UNITS_CM, UNITS_EM, UNITS_EX, UNITS_INCH, UNITS_MM, UNITS_PERCENTAGE, UNITS_PICAS, UNITS_PIXELS, UNITS_POINTS |
Constructor Summary | |
---|---|
Upload()
Creates a new instance of Upload. |
|
Upload(String caption,
Upload.Receiver uploadReceiver)
|
Method Summary | |
---|---|
void |
addListener(Upload.FailedListener listener)
Adds the upload interrupted event listener. |
void |
addListener(Upload.FinishedListener listener)
Adds the upload received event listener. |
void |
addListener(Upload.ProgressListener listener)
Adds the upload success event listener. |
void |
addListener(Upload.StartedListener listener)
Adds the upload started event listener. |
void |
addListener(Upload.SucceededListener listener)
Adds the upload success event listener. |
void |
changeVariables(Object source,
Map<String,Object> variables)
Invoked when the value of a variable has changed. |
protected void |
fireNoInputStream(String filename,
String MIMEType,
long length)
|
protected void |
fireNoOutputStream(String filename,
String MIMEType,
long length)
|
protected void |
fireStarted(String filename,
String MIMEType)
Emit upload received event. |
protected void |
fireUpdateProgress(long totalBytes,
long contentLength)
Emits the progress event. |
protected void |
fireUploadInterrupted(String filename,
String MIMEType,
long length)
Emits the upload failed event. |
protected void |
fireUploadInterrupted(String filename,
String MIMEType,
long length,
Exception e)
|
protected void |
fireUploadSuccess(String filename,
String MIMEType,
long length)
Emits the upload success event. |
void |
focus()
Sets the focus for this component if the component is Focusable . |
String |
getButtonCaption()
|
long |
getBytesRead()
Gets read bytes of the file currently being uploaded. |
Collection<?> |
getListeners(Class<?> eventType)
Returns all listeners that are registered for the given event type or one of its subclasses. |
Upload.ProgressListener |
getProgressListener()
Deprecated. Replaced with addListener/removeListener |
Upload.Receiver |
getReceiver()
Returns the current receiver. |
protected StreamVariable |
getStreamVariable()
|
int |
getTabIndex()
Gets the Tabulator index of this Focusable component. |
long |
getUploadSize()
Returns size of file currently being uploaded. |
void |
interruptUpload()
Interrupts the upload currently being received. |
boolean |
isUploading()
|
void |
paintContent(PaintTarget target)
Paints the content of this component. |
void |
removeListener(Upload.FailedListener listener)
Removes the upload interrupted event listener. |
void |
removeListener(Upload.FinishedListener listener)
Removes the upload received event listener. |
void |
removeListener(Upload.ProgressListener listener)
Removes the upload success event listener. |
void |
removeListener(Upload.StartedListener listener)
Removes the upload started event listener. |
void |
removeListener(Upload.SucceededListener listener)
Removes the upload success event listener. |
void |
requestRepaint()
Requests that the connector should be repainted as soon as possible. |
void |
setButtonCaption(String buttonCaption)
In addition to the actual file chooser, upload components have button that starts actual upload progress. |
void |
setProgressListener(Upload.ProgressListener progressListener)
Deprecated. Use addListener(ProgressListener) instead. |
void |
setReceiver(Upload.Receiver receiver)
Sets the receiver. |
void |
setTabIndex(int tabIndex)
Sets the Tabulator index of this Focusable component. |
void |
startUpload()
Go into upload state. |
void |
submitUpload()
Forces the upload the send selected file to the server. |
Methods inherited from class com.vaadin.terminal.AbstractClientConnector |
---|
addExtension, addMethodInvocationToQueue, createState, getAllChildrenIterable, getConnectorId, getExtensions, getRpcManager, getRpcProxy, getStateType, registerRpc, registerRpc, removeExtension, requestRepaintAll, retrievePendingRpcCalls |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface com.vaadin.terminal.VariableOwner |
---|
isEnabled, isImmediate |
Methods inherited from interface com.vaadin.ui.Component |
---|
addListener, addStyleName, attach, getApplication, getCaption, getDebugId, getIcon, getLocale, getParent, getRoot, getState, getStyleName, isEnabled, isReadOnly, isVisible, removeListener, removeStyleName, setCaption, setDebugId, setEnabled, setIcon, setReadOnly, setStyleName, setVisible, updateState |
Methods inherited from interface com.vaadin.terminal.gwt.server.ClientConnector |
---|
detach, getExtensions, getStateType, isConnectorEnabled, removeExtension, requestRepaintAll, retrievePendingRpcCalls, setParent |
Methods inherited from interface com.vaadin.terminal.gwt.client.Connector |
---|
getConnectorId |
Methods inherited from interface com.vaadin.terminal.gwt.server.RpcTarget |
---|
getRpcManager |
Methods inherited from interface com.vaadin.terminal.Sizeable |
---|
getHeight, getHeightUnits, getWidth, getWidthUnits, setHeight, setHeight, setSizeFull, setSizeUndefined, setWidth, setWidth |
Constructor Detail |
---|
public Upload()
public Upload(String caption, Upload.Receiver uploadReceiver)
Method Detail |
---|
public void changeVariables(Object source, Map<String,Object> variables)
changeVariables
in interface VariableOwner
source
- the Source of the variable change. This is the origin of the
event. For example in Web Adapter this is the request.variables
- the Mapping from variable names to new variable values.com.vaadin.ui.AbstractComponent#changeVariables(java.lang.Object,
java.util.Map)
public void paintContent(PaintTarget target) throws PaintException
paintContent
in interface Vaadin6Component
target
- Target to paint the content on.
PaintException
- if the paint operation failed.public void addListener(Upload.StartedListener listener)
listener
- the Listener to be added.public void removeListener(Upload.StartedListener listener)
listener
- the Listener to be removed.public void addListener(Upload.FinishedListener listener)
listener
- the Listener to be added.public void removeListener(Upload.FinishedListener listener)
listener
- the Listener to be removed.public void addListener(Upload.FailedListener listener)
listener
- the Listener to be added.public void removeListener(Upload.FailedListener listener)
listener
- the Listener to be removed.public void addListener(Upload.SucceededListener listener)
listener
- the Listener to be added.public void removeListener(Upload.SucceededListener listener)
listener
- the Listener to be removed.public void addListener(Upload.ProgressListener listener)
listener
- the Listener to be added.public void removeListener(Upload.ProgressListener listener)
listener
- the Listener to be removed.protected void fireStarted(String filename, String MIMEType)
filename
- MIMEType
- length
- protected void fireUploadInterrupted(String filename, String MIMEType, long length)
filename
- MIMEType
- length
- protected void fireNoInputStream(String filename, String MIMEType, long length)
protected void fireNoOutputStream(String filename, String MIMEType, long length)
protected void fireUploadInterrupted(String filename, String MIMEType, long length, Exception e)
protected void fireUploadSuccess(String filename, String MIMEType, long length)
filename
- MIMEType
- length
- protected void fireUpdateProgress(long totalBytes, long contentLength)
totalBytes
- bytes received so farcontentLength
- actual size of the file being uploaded, if knownpublic Upload.Receiver getReceiver()
public void setReceiver(Upload.Receiver receiver)
receiver
- the receiver to set.public void focus()
Focusable
.
focus
in interface Component.Focusable
focus
in class AbstractComponent
FieldEvents
,
FieldEvents.FocusEvent
,
FieldEvents.FocusListener
,
FieldEvents.BlurEvent
,
FieldEvents.BlurListener
public int getTabIndex()
getTabIndex
in interface Component.Focusable
Focusable
componentComponent.Focusable.getTabIndex()
public void setTabIndex(int tabIndex)
setTabIndex
in interface Component.Focusable
tabIndex
- the tab order of this component. Indexes usually start
from 1. Zero means that default tab order should be used.
A negative value means that the field should not be
included in the tabbing sequence.Component.Focusable.setTabIndex(int)
public void startUpload()
public void interruptUpload()
public boolean isUploading()
public long getBytesRead()
public long getUploadSize()
@Deprecated public void setProgressListener(Upload.ProgressListener progressListener)
progressListener
- @Deprecated public Upload.ProgressListener getProgressListener()
public String getButtonCaption()
public void setButtonCaption(String buttonCaption)
In case the button text is set to null, the button is hidden. In this
case developer must explicitly initiate the upload process with
submitUpload()
.
In case the Upload is used in immediate mode using
AbstractComponent.setImmediate(boolean)
, the file choose (html input with type
"file") is hidden and only the button with this text is shown.
Note the string given is set as is to the button. HTML formatting is not stripped. Be sure to properly validate your value according to your needs.
buttonCaption
- text for upload components button.public void submitUpload()
In case developer wants to use this feature, he/she will most probably
want to hide the uploads internal submit button by setting its caption to
null with setButtonCaption(String)
method.
Note, that the upload runs asynchronous. Developer should use normal upload listeners to trac the process of upload. If the field is empty uploaded the file name will be empty string and file length 0 in the upload finished event.
Also note, that the developer should not remove or modify the upload in the same user transaction where the upload submit is requested. The upload may safely be hidden or removed once the upload started event is fired.
public void requestRepaint()
ClientConnector
requestRepaint
in interface ClientConnector
requestRepaint
in class AbstractComponent
protected StreamVariable getStreamVariable()
public Collection<?> getListeners(Class<?> eventType)
AbstractComponent
getListeners
in class AbstractComponent
eventType
- The type of event to return listeners for.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |