Groovy Documentation

org.grails.plugin.vaadin.ui
[Groovy] Class DefaultUploadField

java.lang.Object
  com.vaadin.ui.AbstractComponent
      com.vaadin.ui.AbstractComponentContainer
          com.vaadin.ui.AbstractLayout
              com.vaadin.ui.CssLayout
                  org.vaadin.easyuploads.UploadField
                      org.grails.plugin.vaadin.ui.DefaultUploadField

class DefaultUploadField
extends org.vaadin.easyuploads.UploadField

Overrides Vaadin EasyUpload Addon UploadField to provide following improvements:

Authors:
Francis McKenzie


Nested Class Summary
protected class DefaultUploadField.UploadedFileLink

Displays link to uploaded file and delete button

 
Field Summary
protected boolean committingValueToDataSource

Allow us to listen for datasource changes, but not enter an endless loop if we're the ones making the change

protected Upload uploadComponent

The underlying upload component to which listeners can be attached.

protected DefaultUploadField.UploadedFileLink uploadedFileLink

The upload file link display

 
Fields inherited from class org.vaadin.easyuploads.UploadField
UNITS_PIXELS, UNITS_POINTS, UNITS_PICAS, UNITS_EM, UNITS_EX, UNITS_MM, UNITS_CM, UNITS_INCH, UNITS_PERCENTAGE, SIZE_UNDEFINED, UNIT_SYMBOLS
 
Property Summary
Long cacheTime

The default cache time to use when a propertyDataSource is first set for this field, and the propertyDataSource has a value.

String filename

The default filename to use when a propertyDataSource is first set for this field, and the propertyDataSource has a value.

def log

String mimeType

The default mimeType to use when a propertyDataSource is first set for this field, and the propertyDataSource has a value.

 
Constructor Summary
DefaultUploadField()

Construct an upload field with the default storage mode

DefaultUploadField(org.vaadin.easyuploads.UploadField$StorageMode mode)

Construct an upload field with the specified storage more

 
Method Summary
protected void addUploadedFileLink()

Adds link to uploaded resource and delete button

void attach()

Always update the display when we attach

void commit()

Set a flag to indicate that valueChange events should be ignored until this method is finished.

protected void deleteUpload()

Removes the uploaded file, and clears the uploaded display

Upload getUploadComponent()

The underlying upload component to which listeners can be attached.

protected void removeUploadedFileLink()

Removes link to uploaded resource and delete button

void setReadOnly(boolean readOnly)

Updates the upload field's display to reflect readOnly status

void setValue(Object value)

Catch NullPointerException caused by bug in superclass.

protected void updateDisplay()

Overrides superclass to provide link to file that was uploaded, and delete button

protected void updateReadOnlyDisplay()

Updates the display to reflect the current readOnly status

void valueChange(Property.ValueChangeEvent event)

Unless we're the ones that caused the value to change, we need to update the display to reflect the new value.

 
Methods inherited from class org.vaadin.easyuploads.UploadField
org.vaadin.easyuploads.UploadField#getValue(), org.vaadin.easyuploads.UploadField#getType(), org.vaadin.easyuploads.UploadField#setValue(java.lang.Object), org.vaadin.easyuploads.UploadField#isValid(), org.vaadin.easyuploads.UploadField#validate(), org.vaadin.easyuploads.UploadField#isModified(), org.vaadin.easyuploads.UploadField#getFieldType(), org.vaadin.easyuploads.UploadField#commit(), org.vaadin.easyuploads.UploadField#updateProgress(long, long), org.vaadin.easyuploads.UploadField#addListener(com.vaadin.data.Property$ValueChangeListener), org.vaadin.easyuploads.UploadField#isRequired(), org.vaadin.easyuploads.UploadField#setRequired(boolean), org.vaadin.easyuploads.UploadField#removeListener(com.vaadin.data.Property$ValueChangeListener), org.vaadin.easyuploads.UploadField#valueChange(com.vaadin.data.Property$ValueChangeEvent), org.vaadin.easyuploads.UploadField#setPropertyDataSource(com.vaadin.data.Property), org.vaadin.easyuploads.UploadField#getPropertyDataSource(), org.vaadin.easyuploads.UploadField#requestRepaint(), org.vaadin.easyuploads.UploadField#setImmediate(boolean), org.vaadin.easyuploads.UploadField#focus(), org.vaadin.easyuploads.UploadField#getTabIndex(), org.vaadin.easyuploads.UploadField#setTabIndex(int), org.vaadin.easyuploads.UploadField#isInvalidCommitted(), org.vaadin.easyuploads.UploadField#setInvalidCommitted(boolean), org.vaadin.easyuploads.UploadField#discard(), org.vaadin.easyuploads.UploadField#isWriteThrough(), org.vaadin.easyuploads.UploadField#setWriteThrough(boolean), org.vaadin.easyuploads.UploadField#isReadThrough(), org.vaadin.easyuploads.UploadField#setReadThrough(boolean), org.vaadin.easyuploads.UploadField#addValidator(com.vaadin.data.Validator), org.vaadin.easyuploads.UploadField#getValidators(), org.vaadin.easyuploads.UploadField#removeValidator(com.vaadin.data.Validator), org.vaadin.easyuploads.UploadField#isInvalidAllowed(), org.vaadin.easyuploads.UploadField#setInvalidAllowed(boolean), org.vaadin.easyuploads.UploadField#setRequiredError(java.lang.String), org.vaadin.easyuploads.UploadField#getRequiredError(), org.vaadin.easyuploads.UploadField#isValidationVisible(), org.vaadin.easyuploads.UploadField#setValidationVisible(boolean), org.vaadin.easyuploads.UploadField#setCurrentBufferedSourceException(com.vaadin.data.Buffered$SourceException), org.vaadin.easyuploads.UploadField#setStorageMode(org.vaadin.easyuploads.UploadField$StorageMode), org.vaadin.easyuploads.UploadField#setUploadMode(boolean), org.vaadin.easyuploads.UploadField#setButtonCaption(java.lang.String), org.vaadin.easyuploads.UploadField#getButtonCaption(), org.vaadin.easyuploads.UploadField#setMaxUploadSize(long), org.vaadin.easyuploads.UploadField#submitUpload(), org.vaadin.easyuploads.UploadField#getRootLayout(), org.vaadin.easyuploads.UploadField#setFieldType(org.vaadin.easyuploads.UploadField$FieldType), org.vaadin.easyuploads.UploadField#setFileFactory(org.vaadin.easyuploads.FileFactory), org.vaadin.easyuploads.UploadField#getFileFactory(), org.vaadin.easyuploads.UploadField#getContentAsStream(), org.vaadin.easyuploads.UploadField#uploadStarted(com.vaadin.ui.Upload$StartedEvent), org.vaadin.easyuploads.UploadField#uploadFinished(com.vaadin.ui.Upload$FinishedEvent), org.vaadin.easyuploads.UploadField#isFileDeletesAllowed(), org.vaadin.easyuploads.UploadField#setFileDeletesAllowed(boolean), org.vaadin.easyuploads.UploadField#getComponent(int), org.vaadin.easyuploads.UploadField#getComponentCount(), org.vaadin.easyuploads.UploadField#getComponentIndex(com.vaadin.ui.Component), org.vaadin.easyuploads.UploadField#addComponent(com.vaadin.ui.Component, int), org.vaadin.easyuploads.UploadField#addComponent(com.vaadin.ui.Component), org.vaadin.easyuploads.UploadField#addListener(com.vaadin.event.LayoutEvents$LayoutClickListener), org.vaadin.easyuploads.UploadField#removeListener(com.vaadin.event.LayoutEvents$LayoutClickListener), org.vaadin.easyuploads.UploadField#removeComponent(com.vaadin.ui.Component), org.vaadin.easyuploads.UploadField#getComponentIterator(), org.vaadin.easyuploads.UploadField#paintContent(com.vaadin.terminal.PaintTarget), org.vaadin.easyuploads.UploadField#replaceComponent(com.vaadin.ui.Component, com.vaadin.ui.Component), org.vaadin.easyuploads.UploadField#addComponentAsFirst(com.vaadin.ui.Component), org.vaadin.easyuploads.UploadField#setMargin(boolean), org.vaadin.easyuploads.UploadField#setMargin(com.vaadin.ui.Layout$MarginInfo), org.vaadin.easyuploads.UploadField#setMargin(boolean, boolean, boolean, boolean), org.vaadin.easyuploads.UploadField#getMargin(), org.vaadin.easyuploads.UploadField#changeVariables(java.lang.Object, java.util.Map), org.vaadin.easyuploads.UploadField#setEnabled(boolean), org.vaadin.easyuploads.UploadField#setWidth(float, int), org.vaadin.easyuploads.UploadField#addListener(com.vaadin.ui.ComponentContainer$ComponentAttachListener), org.vaadin.easyuploads.UploadField#addListener(com.vaadin.ui.ComponentContainer$ComponentDetachListener), org.vaadin.easyuploads.UploadField#attach(), org.vaadin.easyuploads.UploadField#removeListener(com.vaadin.ui.ComponentContainer$ComponentAttachListener), org.vaadin.easyuploads.UploadField#removeListener(com.vaadin.ui.ComponentContainer$ComponentDetachListener), org.vaadin.easyuploads.UploadField#removeAllComponents(), org.vaadin.easyuploads.UploadField#requestRepaintAll(), org.vaadin.easyuploads.UploadField#moveComponentsFrom(com.vaadin.ui.ComponentContainer), org.vaadin.easyuploads.UploadField#detach(), org.vaadin.easyuploads.UploadField#setHeight(float, int), org.vaadin.easyuploads.UploadField#getParent(), org.vaadin.easyuploads.UploadField#setReadOnly(boolean), org.vaadin.easyuploads.UploadField#isReadOnly(), org.vaadin.easyuploads.UploadField#setParent(com.vaadin.ui.Component), org.vaadin.easyuploads.UploadField#getData(), org.vaadin.easyuploads.UploadField#setLocale(java.util.Locale), org.vaadin.easyuploads.UploadField#getDescription(), org.vaadin.easyuploads.UploadField#paint(com.vaadin.terminal.PaintTarget), org.vaadin.easyuploads.UploadField#getListeners(java.lang.Class), org.vaadin.easyuploads.UploadField#isVisible(), org.vaadin.easyuploads.UploadField#isEnabled(), org.vaadin.easyuploads.UploadField#setVisible(boolean), org.vaadin.easyuploads.UploadField#getLocale(), org.vaadin.easyuploads.UploadField#getWidth(), org.vaadin.easyuploads.UploadField#getHeight(), org.vaadin.easyuploads.UploadField#setIcon(com.vaadin.terminal.Resource), org.vaadin.easyuploads.UploadField#getIcon(), org.vaadin.easyuploads.UploadField#setWidth(float), org.vaadin.easyuploads.UploadField#setWidth(java.lang.String), org.vaadin.easyuploads.UploadField#setDescription(java.lang.String), org.vaadin.easyuploads.UploadField#getErrorMessage(), org.vaadin.easyuploads.UploadField#setErrorHandler(com.vaadin.ui.AbstractComponent$ComponentErrorHandler), org.vaadin.easyuploads.UploadField#getErrorHandler(), org.vaadin.easyuploads.UploadField#addListener(com.vaadin.terminal.Paintable$RepaintRequestListener), org.vaadin.easyuploads.UploadField#addListener(java.lang.Class, java.lang.Object, java.lang.String), org.vaadin.easyuploads.UploadField#addListener(java.lang.Class, java.lang.Object, java.lang.reflect.Method), org.vaadin.easyuploads.UploadField#addListener(com.vaadin.ui.Component$Listener), org.vaadin.easyuploads.UploadField#getStyle(), org.vaadin.easyuploads.UploadField#setStyle(java.lang.String), org.vaadin.easyuploads.UploadField#setData(java.lang.Object), org.vaadin.easyuploads.UploadField#removeListener(java.lang.Class, java.lang.Object, java.lang.String), org.vaadin.easyuploads.UploadField#removeListener(com.vaadin.ui.Component$Listener), org.vaadin.easyuploads.UploadField#removeListener(com.vaadin.terminal.Paintable$RepaintRequestListener), org.vaadin.easyuploads.UploadField#removeListener(java.lang.Class, java.lang.Object), org.vaadin.easyuploads.UploadField#removeListener(java.lang.Class, java.lang.Object, java.lang.reflect.Method), org.vaadin.easyuploads.UploadField#getStyleName(), org.vaadin.easyuploads.UploadField#setStyleName(java.lang.String), org.vaadin.easyuploads.UploadField#addStyleName(java.lang.String), org.vaadin.easyuploads.UploadField#removeStyleName(java.lang.String), org.vaadin.easyuploads.UploadField#getCaption(), org.vaadin.easyuploads.UploadField#setCaption(java.lang.String), org.vaadin.easyuploads.UploadField#getWindow(), org.vaadin.easyuploads.UploadField#getApplication(), org.vaadin.easyuploads.UploadField#childRequestedRepaint(java.util.Collection), org.vaadin.easyuploads.UploadField#setDebugId(java.lang.String), org.vaadin.easyuploads.UploadField#getDebugId(), org.vaadin.easyuploads.UploadField#requestRepaintRequests(), org.vaadin.easyuploads.UploadField#isImmediate(), org.vaadin.easyuploads.UploadField#setHeight(java.lang.String), org.vaadin.easyuploads.UploadField#setHeight(float), org.vaadin.easyuploads.UploadField#getWidthUnits(), org.vaadin.easyuploads.UploadField#setWidthUnits(int), org.vaadin.easyuploads.UploadField#getHeightUnits(), org.vaadin.easyuploads.UploadField#setHeightUnits(int), org.vaadin.easyuploads.UploadField#setSizeFull(), org.vaadin.easyuploads.UploadField#setSizeUndefined(), org.vaadin.easyuploads.UploadField#getComponentError(), org.vaadin.easyuploads.UploadField#setComponentError(com.vaadin.terminal.ErrorMessage), org.vaadin.easyuploads.UploadField#handleError(com.vaadin.ui.AbstractComponent$ComponentErrorEvent), org.vaadin.easyuploads.UploadField#wait(), org.vaadin.easyuploads.UploadField#wait(long), org.vaadin.easyuploads.UploadField#wait(long, int), org.vaadin.easyuploads.UploadField#equals(java.lang.Object), org.vaadin.easyuploads.UploadField#toString(), org.vaadin.easyuploads.UploadField#hashCode(), org.vaadin.easyuploads.UploadField#getClass(), org.vaadin.easyuploads.UploadField#notify(), org.vaadin.easyuploads.UploadField#notifyAll()
 
Methods inherited from class CssLayout
getComponent, getComponentCount, getComponentIndex, addComponent, addComponent, addListener, removeListener, removeComponent, getComponentIterator, paintContent, replaceComponent, addComponentAsFirst, setMargin, setMargin, setMargin, getMargin, changeVariables, setEnabled, setWidth, addListener, addListener, attach, removeListener, removeListener, removeAllComponents, requestRepaintAll, moveComponentsFrom, detach, setHeight, getParent, setReadOnly, isReadOnly, setParent, getData, setLocale, getDescription, paint, getListeners, isVisible, isEnabled, setVisible, getLocale, getWidth, getHeight, setIcon, getIcon, setWidth, setWidth, setDescription, getErrorMessage, setErrorHandler, getErrorHandler, addListener, addListener, addListener, addListener, getStyle, setStyle, setData, removeListener, removeListener, removeListener, removeListener, removeListener, requestRepaint, getStyleName, setStyleName, addStyleName, removeStyleName, getCaption, setCaption, getWindow, getApplication, childRequestedRepaint, setDebugId, getDebugId, requestRepaintRequests, isImmediate, setHeight, setHeight, getWidthUnits, setWidthUnits, getHeightUnits, setHeightUnits, setSizeFull, setSizeUndefined, setImmediate, getComponentError, setComponentError, handleError, wait, wait, wait, equals, toString, hashCode, getClass, notify, notifyAll
 

Field Detail

committingValueToDataSource

protected boolean committingValueToDataSource
Allow us to listen for datasource changes, but not enter an endless loop if we're the ones making the change


uploadComponent

protected Upload uploadComponent
The underlying upload component to which listeners can be attached.


uploadedFileLink

protected DefaultUploadField.UploadedFileLink uploadedFileLink
The upload file link display


 
Property Detail

cacheTime

Long cacheTime
The default cache time to use when a propertyDataSource is first set for this field, and the propertyDataSource has a value.


filename

String filename
The default filename to use when a propertyDataSource is first set for this field, and the propertyDataSource has a value.


log

def log


mimeType

String mimeType
The default mimeType to use when a propertyDataSource is first set for this field, and the propertyDataSource has a value.


 
Constructor Detail

DefaultUploadField

DefaultUploadField()
Construct an upload field with the default storage mode


DefaultUploadField

DefaultUploadField(org.vaadin.easyuploads.UploadField$StorageMode mode)
Construct an upload field with the specified storage more


 
Method Detail

addUploadedFileLink

protected void addUploadedFileLink()
Adds link to uploaded resource and delete button


attach

void attach()
Always update the display when we attach


commit

void commit()
Set a flag to indicate that valueChange events should be ignored until this method is finished.


deleteUpload

protected void deleteUpload()
Removes the uploaded file, and clears the uploaded display


getUploadComponent

Upload getUploadComponent()
The underlying upload component to which listeners can be attached.


removeUploadedFileLink

protected void removeUploadedFileLink()
Removes link to uploaded resource and delete button


setReadOnly

@Override
void setReadOnly(boolean readOnly)
Updates the upload field's display to reflect readOnly status


setValue

@Override
void setValue(Object value)
Catch NullPointerException caused by bug in superclass.

Also, set a flag to indicate that valueChange events should be ignored until this method is finished.


updateDisplay

@Override
protected void updateDisplay()
Overrides superclass to provide link to file that was uploaded, and delete button


updateReadOnlyDisplay

protected void updateReadOnlyDisplay()
Updates the display to reflect the current readOnly status


valueChange

void valueChange(Property.ValueChangeEvent event)
Unless we're the ones that caused the value to change, we need to update the display to reflect the new value.


 

Groovy Documentation