org.millstone.base.ui
Class Upload

java.lang.Object
  |
  +--org.millstone.base.ui.AbstractComponent
        |
        +--org.millstone.base.ui.Upload

All Implemented Interfaces:

Component, java.util.EventListener, MethodEventSource, Paintable, VariableOwner

public class Upload

extends AbstractComponent

Component for client file uploading.

Since:

3.0

Version:

3.0.3

Author:

IT Mill Ltd.

Nested Class Summary

class	Upload.FailedEvent Upload.Interrupted 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 unsuccessfull.
class	Upload.FinishedEvent Upload.Received event is sent when the upload receives a file, regardless if the receival was successfull.
static interface	Upload.FinishedListener Receives events when the uploads are ready.
static interface	Upload.Receiver Interface that must be implemented by the upload receivers.
class	Upload.SucceededEvent Upload.Success event is sent when the upload is received successfully.
static interface	Upload.SucceededListener Receives events when the uploads are successfully finished.

Nested classes inherited from class org.millstone.base.ui.Component

Component.Listener

Nested classes inherited from class org.millstone.base.terminal.Paintable

Paintable.RepaintRequestEvent, Paintable.RepaintRequestListener

Constructor Summary

Upload(java.lang.String caption, Upload.Receiver uploadReceiver)
Creates a new instance of Upload that redirects the uploaded data to given stream.

Method Summary

void	addListener(Upload.FailedListener listener) Add upload interrupted event listener
void	addListener(Upload.FinishedListener listener) Add upload received event listener
void	addListener(Upload.SucceededListener listener) Add upload success event listener
void	changeVariables(java.lang.Object source, java.util.Map variables) Invoked when the value of a variable has changed.
protected void	fireUploadInterrupted(java.lang.String filename, java.lang.String MIMEType, long length) Emit upload interrupted event.
protected void	fireUploadReceived(java.lang.String filename, java.lang.String MIMEType, long length) Emit upload received event.
protected void	fireUploadSuccess(java.lang.String filename, java.lang.String MIMEType, long length) Emit upload success event.
Upload.Receiver	getReceiver() Returns the current receiver.
java.lang.String	getTag() Get component type.
void	paintContent(PaintTarget target) Paint the content of this component.
void	removeListener(Upload.FailedListener listener) Remove upload interrupted event listener
void	removeListener(Upload.FinishedListener listener) Remove upload received event listener
void	removeListener(Upload.SucceededListener listener) Remove upload success event listener
void	setReceiver(Upload.Receiver receiver) Sets the receiver.

Methods inherited from class org.millstone.base.ui.AbstractComponent

addListener, addListener, addListener, addListener, attach, childRequestedRepaint, dependsOn, detach, fireComponentEvent, fireEvent, getApplication, getCaption, getComponentError, getDescription, getDirectDependencies, getErrorMessage, getIcon, getLocale, getParent, getStyle, getWindow, isEnabled, isImmediate, isReadOnly, isVisible, paint, removeDirectDependency, removeListener, removeListener, removeListener, removeListener, removeListener, requestRepaint, requestRepaintRequests, setCaption, setComponentError, setDescription, setEnabled, setIcon, setImmediate, setLocale, setParent, setReadOnly, setStyle, setVisible

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Upload

public Upload(java.lang.String caption,
              Upload.Receiver uploadReceiver)

Creates a new instance of Upload that redirects the uploaded data to given stream.

Method Detail

getTag

public java.lang.String getTag()

Get component type.

Specified by:

getTag in class AbstractComponent

Returns:

Component type as string.

changeVariables

public void changeVariables(java.lang.Object source,
                            java.util.Map variables)

Invoked when the value of a variable has changed.

Specified by:

changeVariables in interface VariableOwner

Overrides:

changeVariables in class AbstractComponent

Parameters:

source - Source of the variable change. This is the origin of the event. For example in Web Adapter this is the request.

variables - Mapping from variable names to new variable values

paintContent

public void paintContent(PaintTarget target)
                  throws PaintException

Paint the content of this component.

Overrides:

paintContent in class AbstractComponent

Parameters:

target - Target to paint the content on.

Throws:

PaintException - The paint operation failed.

addListener

public void addListener(Upload.FinishedListener listener)

Add upload received event listener

Parameters:

listener - Listener to be added.

removeListener

public void removeListener(Upload.FinishedListener listener)

Remove upload received event listener

Parameters:

listener - Listener to be removed.

addListener

public void addListener(Upload.FailedListener listener)

Add upload interrupted event listener

Parameters:

listener - Listener to be added.

removeListener

public void removeListener(Upload.FailedListener listener)

Remove upload interrupted event listener

Parameters:

listener - Listener to be removed.

addListener

public void addListener(Upload.SucceededListener listener)

Add upload success event listener

Parameters:

listener - Listener to be added.

removeListener

public void removeListener(Upload.SucceededListener listener)

Remove upload success event listener

Parameters:

listener - Listener to be removed.

fireUploadReceived

protected void fireUploadReceived(java.lang.String filename,
                                  java.lang.String MIMEType,
                                  long length)

Emit upload received event.

fireUploadInterrupted

protected void fireUploadInterrupted(java.lang.String filename,
                                     java.lang.String MIMEType,
                                     long length)

Emit upload interrupted event.

fireUploadSuccess

protected void fireUploadSuccess(java.lang.String filename,
                                 java.lang.String MIMEType,
                                 long length)

Emit upload success event.

getReceiver

public Upload.Receiver getReceiver()

Returns the current receiver.

Returns:

Receiver

setReceiver

public void setReceiver(Upload.Receiver receiver)

Sets the receiver.

Parameters:

receiver - The receiver to set