com.whitestein.lsps.vaadin.forms

Class WUpload

java.lang.Object

com.whitestein.lsps.vaadin.forms.FormComponent

com.whitestein.lsps.vaadin.forms.WUpload

All Implemented Interfaces:

com.vaadin.event.ConnectorEventListener, com.vaadin.server.ClientConnector.AttachListener, com.vaadin.ui.Upload.FailedListener, com.vaadin.ui.Upload.Receiver, com.vaadin.ui.Upload.StartedListener, com.vaadin.ui.Upload.SucceededListener, Serializable, EventListener

public class WUpload
extends FormComponent
implements com.vaadin.ui.Upload.FailedListener, com.vaadin.ui.Upload.Receiver, com.vaadin.ui.Upload.SucceededListener, com.vaadin.ui.Upload.StartedListener

Author:

mvy

See Also:

Serialized Form

Field Summary

Fields inherited from class com.whitestein.lsps.vaadin.forms.FormComponent

form, INTERNAL_STATE_RECORD_PROPERTY

Fields inherited from interface com.vaadin.server.ClientConnector.AttachListener

attachMethod

Constructor Summary

Constructors

Constructor and Description
WUpload()

Method Summary

Modifier and Type	Method and Description
protected com.vaadin.ui.AbstractComponent	createWidget() Called once, to create the actual Vaadin component.
String	getAcceptedMimeTypes() Gets the accepted MIME-Types
String	getButtonCaption()
com.vaadin.ui.Upload	getWidget() Gets the Vaadin representation of this component.
boolean	isImmediate() Returns the immediate mode of the component.
Boolean	isRequired() Gets the required flag of this component.
void	localizeAndSetButtonCaption(String caption) Localizes the caption and sets it to the button.
protected void	onUploadResult(RecordHolder file, String failureMessage) Handles the result of the file upload.
OutputStream	receiveUpload(String filename, String mimeType)
protected void	restoreInternalState(Map<String,Object> state) Restores the UI state of this component which was previously written by FormComponent.writeInternalState(Map).
void	setAcceptedMimeTypes(String mimeTypes) Sets the accepted MIME-Types by this upload component.
void	setImmediate(boolean immediate) Sets the component's immediate mode to the specified status.
void	setRequired(Boolean required) Sets the required flag to this component
void	uploadFailed(com.vaadin.ui.Upload.FailedEvent event)
void	uploadStarted(com.vaadin.ui.Upload.StartedEvent event)
void	uploadSucceeded(com.vaadin.ui.Upload.SucceededEvent event)
protected void	writeInternalState(Map<String,Object> state) Writes the UI state of this component to the provided map.

Methods inherited from class com.whitestein.lsps.vaadin.forms.FormComponent

addDataErrorMessage, addStyleName, attach, call, clearDataErrorMessages, createEvent, equals, getCaption, getComponentAlignment, getContextClickHandler, getCustomErrorMessage, getDataErrorMessages, getDescription, getExpandRatio, getHasChildrenAdapter, getHeight, getIcon, getModelingId, getNamespace, getStyleName, getTabIndex, getWidth, hashCode, isEnabled, isReadOnly, isVisible, localize, markAsDirty, preventGC, removeStyleName, restoreState, saveState, setCaption, setComponentAlignment, setContextClickHandler, setContextMenuItems, setCustomErrorMessage, setDescription, setEnabled, setExpandRatio, setHeight, setIcon, setReadOnly, setStyleName, setTabIndex, setVisible, setWidth, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

WUpload

public WUpload()

Method Detail

createWidget

protected com.vaadin.ui.AbstractComponent createWidget()

Description copied from class: FormComponent

Called once, to create the actual Vaadin component.

Specified by:

createWidget in class FormComponent

Returns:

the actual Vaadin component, may be null if the component has no UI counterpart.

getWidget

public com.vaadin.ui.Upload getWidget()

Description copied from class: FormComponent

Gets the Vaadin representation of this component.

Overrides:

getWidget in class FormComponent

Returns:

the Vaadin representation of this form component.

uploadStarted

public void uploadStarted(com.vaadin.ui.Upload.StartedEvent event)

Specified by:

uploadStarted in interface com.vaadin.ui.Upload.StartedListener

uploadFailed

public void uploadFailed(com.vaadin.ui.Upload.FailedEvent event)

Specified by:

uploadFailed in interface com.vaadin.ui.Upload.FailedListener

setAcceptedMimeTypes

public void setAcceptedMimeTypes(String mimeTypes)

Sets the accepted MIME-Types by this upload component.

Parameters:

mimeTypes - the accepted MIME-Types

getAcceptedMimeTypes

public String getAcceptedMimeTypes()

Gets the accepted MIME-Types

Returns:

the accepted MIME types

receiveUpload

public OutputStream receiveUpload(String filename,
                                  String mimeType)

Specified by:

receiveUpload in interface com.vaadin.ui.Upload.Receiver

onUploadResult

protected void onUploadResult(RecordHolder file,
                              String failureMessage)

Handles the result of the file upload. This method has to be called within a form and transaction context.

Parameters:

file -

failureMessage -

uploadSucceeded

public void uploadSucceeded(com.vaadin.ui.Upload.SucceededEvent event)

Specified by:

uploadSucceeded in interface com.vaadin.ui.Upload.SucceededListener

localizeAndSetButtonCaption

public void localizeAndSetButtonCaption(String caption)

Localizes the caption and sets it to the button.

Parameters:

caption -

setRequired

public void setRequired(Boolean required)

Sets the required flag to this component

Parameters:

required -

isRequired

public Boolean isRequired()

Gets the required flag of this component.

Returns:

true if this component has been marked as required.

writeInternalState

protected void writeInternalState(Map<String,Object> state)

Description copied from class: FormComponent

Writes the UI state of this component to the provided map. The written state is later used to restore the UI when a saved document or saved Todo is reopened.

Many UI attributes such as size, caption, etc. are not held in the records but are stored exclusively in the Vaadin components. In the records the getter/setter methods of such attributes directly delegate to the underlying component. For the purposes of the Save Document/Todo use case the state of such attributes has to be preserved.

Subclasses should override this method. The overriding method should call super.writeInternalState(state) to store the state form the super class as well. The attributes should be written to the provided state parameter. The type of the values written to the state can only by Java representation of LSPS types. That is java.util.Date, java.lang.String, Decimal, RecordHolder, ListHolder, ... The name of the attributes stored in the map should be unique and should not collide with the names used by any of the superclass. It is the responsibility of the overridden method to ensure that.

Subclasses overriding this method should also override FormComponent.restoreInternalState(Map) and restore the state written by this method.

Overrides:

writeInternalState in class FormComponent

Parameters:

state - a map to which this method should write the component's UI state.

See Also:

FormComponent.restoreInternalState(Map), FormComponent.saveState()

restoreInternalState

protected void restoreInternalState(Map<String,Object> state)

Description copied from class: FormComponent

Restores the UI state of this component which was previously written by FormComponent.writeInternalState(Map). Subclasses should override and call super.restoreInternalState(state);

Overrides:

restoreInternalState in class FormComponent

Parameters:

state - a map of attributes and their values

See Also:

FormComponent.writeInternalState(Map)

getButtonCaption

public String getButtonCaption()

Returns:

String to be rendered into button that fires uploading

isImmediate

public boolean isImmediate()

Returns the immediate mode of the component.

Certain operations such as adding a value change listener will set the component into immediate mode if setImmediate(boolean) has not been explicitly called with false.

Returns:

true if the component is in immediate mode (explicitly or implicitly set), false if the component if not in immediate mode

setImmediate

public void setImmediate(boolean immediate)

Sets the component's immediate mode to the specified status.

Parameters:

immediate - the boolean value specifying if the component should be in the immediate mode after the call.