com.haulmont.cuba.web.gui.components

Class WebFileUploadField

java.lang.Object

com.haulmont.bali.events.EventRouter

com.haulmont.cuba.web.gui.components.WebAbstractComponent<T>

com.haulmont.cuba.web.gui.components.WebAbstractField<T>

com.haulmont.cuba.web.gui.components.WebAbstractUploadField<CubaFileUploadWrapper>

com.haulmont.cuba.web.gui.components.WebFileUploadField

All Implemented Interfaces:

Component, Component.BelongToFrame, Component.Buffered, Component.Editable, Component.Focusable, Component.HasCaption, Component.HasIcon, Component.HasValue, Component.HasXmlDescriptor, Component.Validatable, Component.Wrapper, DatasourceComponent, Field, FileUploadField, UploadField

public class WebFileUploadField
extends WebAbstractUploadField<CubaFileUploadWrapper>
implements FileUploadField

Nested Class Summary

Nested classes/interfaces inherited from interface com.haulmont.cuba.gui.components.FileUploadField

FileUploadField.AfterValueClearEvent, FileUploadField.AfterValueClearListener, FileUploadField.BeforeValueClearEvent, FileUploadField.BeforeValueClearListener, FileUploadField.FileContentProvider, FileUploadField.FileStoragePutMode, FileUploadField.FileUploadSucceedEvent, FileUploadField.FileUploadSucceedListener, FileUploadField.Listener, FileUploadField.ListenerAdapter

Nested classes/interfaces inherited from interface com.haulmont.cuba.gui.components.UploadField

UploadField.DropZone, UploadField.FileUploadErrorEvent, UploadField.FileUploadErrorListener, UploadField.FileUploadEvent, UploadField.FileUploadFinishEvent, UploadField.FileUploadFinishListener, UploadField.FileUploadStartEvent, UploadField.FileUploadStartListener

Nested classes/interfaces inherited from interface com.haulmont.cuba.gui.components.Field

Field.Validator

Nested classes/interfaces inherited from interface com.haulmont.cuba.gui.components.Component

Component.ActionOwner, Component.ActionsHolder, Component.Alignment, Component.BelongToFrame, Component.Buffered, Component.ChildEditableController, Component.Collapsable, Component.Container, Component.Disposable, Component.Editable, Component.EditableChangeEvent, Component.EditableChangeListener, Component.EditableChangeNotifier, Component.ExpandedStateChangeEvent, Component.ExpandedStateChangeListener, Component.Focusable, Component.HasBorder, Component.HasButtonsPanel, Component.HasCaption, Component.HasFormatter, Component.HasIcon, Component.HasInputPrompt, Component.HasNamedComponents, Component.HasPresentations, Component.HasRowsCount, Component.HasSettings, Component.HasValue, Component.HasXmlDescriptor, Component.LayoutClickEvent, Component.LayoutClickListener, Component.LayoutClickNotifier, Component.Margin, Component.MouseEventDetails, Component.OrderedContainer, Component.OuterMargin, Component.SecuredActionsHolder, Component.ShortcutAction, Component.ShortcutNotifier, Component.ShortcutTriggeredEvent, Component.Spacing, Component.UiPermissionAware, Component.Validatable, Component.ValueChangeEvent, Component.ValueChangeListener, Component.Wrapper

Field Summary

Fields inherited from class com.haulmont.cuba.web.gui.components.WebAbstractComponent

ICON_STYLE, UNIT_SYMBOLS

Fields inherited from interface com.haulmont.cuba.gui.components.FileUploadField

NAME

Fields inherited from interface com.haulmont.cuba.gui.components.Component

AUTO_SIZE, AUTO_SIZE_PX, UNITS_PERCENTAGE, UNITS_PIXELS

Constructor Summary

Constructors

Constructor and Description
WebFileUploadField()

Method Summary

Modifier and Type	Method and Description
void	addAfterValueClearListener(FileUploadField.AfterValueClearListener listener)
void	addBeforeValueClearListener(FileUploadField.BeforeValueClearListener listener)
void	addFileUploadErrorListener(UploadField.FileUploadErrorListener listener)
void	addFileUploadFinishListener(UploadField.FileUploadFinishListener listener)
void	addFileUploadStartListener(UploadField.FileUploadStartListener listener)
void	addFileUploadSucceedListener(FileUploadField.FileUploadSucceedListener listener)
void	addListener(FileUploadField.Listener listener)
void	commit() Updates all changes since the previous commit to the data source.
void	discard() Discards all changes since last commit.
java.lang.String	getAccept() Returns comma separated types of files.
byte[]	getBytes() Deprecated. Please use getFileId() method and FileUploadingAPI
java.lang.String	getClearButtonCaption()
java.lang.String	getClearButtonDescription()
java.lang.String	getClearButtonIcon()
FileUploadField.FileContentProvider	getContentProvider()
java.io.InputStream	getFileContent()
FileDescriptor	getFileDescriptor()
java.util.UUID	getFileId() Get id for uploaded file in FileUploading.
java.lang.String	getFileName()
FileUploadField.FileStoragePutMode	getMode()
int	getTabIndex() Gets the tabulator index of the HasTabIndex component.
java.lang.String	getUploadButtonCaption()
java.lang.String	getUploadButtonDescription()
java.lang.String	getUploadButtonIcon()
boolean	isBuffered()
boolean	isModified() Tests if the value stored in the object has been modified since it was last updated from the data source.
boolean	isShowClearButton()
boolean	isShowFileName()
void	removeAfterValueClearListener(FileUploadField.AfterValueClearListener listener)
void	removeBeforeValueClearListener(FileUploadField.BeforeValueClearListener listener)
void	removeFileUploadErrorListener(UploadField.FileUploadErrorListener listener)
void	removeFileUploadFinishListener(UploadField.FileUploadFinishListener listener)
void	removeFileUploadStartListener(UploadField.FileUploadStartListener listener)
void	removeFileUploadSucceedListener(FileUploadField.FileUploadSucceedListener listener)
void	removeListener(FileUploadField.Listener listener)
void	setAccept(java.lang.String accept) Sets the mask for files to filter them in the file selection dialog. Example:
void	setBuffered(boolean buffered) Sets the buffered mode.
void	setClearButtonCaption(java.lang.String caption) Setup clear button caption.
void	setClearButtonDescription(java.lang.String description) Setup clear button description.
void	setClearButtonIcon(java.lang.String icon) Setup clear button icon.
void	setContentProvider(FileUploadField.FileContentProvider contentProvider) Set content provider which contains file data.
void	setDropZone(UploadField.DropZone dropZone) Set drop zone reference to this upload component.
void	setDropZonePrompt(java.lang.String dropZonePrompt) Set drop zone prompt that will be shown on drag over window with file.
void	setFileSizeLimit(long fileSizeLimit) Sets maximum allowed file size in bytes.
void	setMode(FileUploadField.FileStoragePutMode mode) Set mode which determines when FileDescriptor will be committed.
void	setPermittedExtensions(java.util.Set<java.lang.String> permittedExtensions) Set white list of file extensions.
void	setShowClearButton(boolean showClearButton) Enable or disable displaying name of clear button.
void	setShowFileName(boolean showFileName) Enable or disable displaying name of uploaded file next to upload button.
void	setTabIndex(int tabIndex) Sets the tabulator index of the Focusable component.
void	setUploadButtonCaption(java.lang.String caption) Setup caption of upload button.
void	setUploadButtonDescription(java.lang.String description) Setup upload button description.
void	setUploadButtonIcon(java.lang.String icon) Setup upload button icon.

Methods inherited from class com.haulmont.cuba.web.gui.components.WebAbstractUploadField

getDropZone, getDropZonePrompt, getFileSizeLimit, getPermittedExtensions

Methods inherited from class com.haulmont.cuba.web.gui.components.WebAbstractField

addListener, addValidator, addValueChangeListener, getDatasource, getMetaProperty, getMetaPropertyPath, getRequiredMessage, getValidators, getValue, isEditable, isRequired, isValid, removeListener, removeValidator, removeValueChangeListener, setDatasource, setEditable, setParent, setRequired, setRequiredMessage, setValue, validate

Methods inherited from class com.haulmont.cuba.web.gui.components.WebAbstractComponent

addStyleName, assignAutoDebugId, getAlignment, getCaption, getComponent, getComponentEnabledFlag, getComponentVisibleFlag, getComposition, getDebugId, getDescription, getFrame, getHeight, getHeightUnits, getIcon, getId, getParent, getStyleName, getWidth, getWidthUnits, getXmlDescriptor, isEnabled, isEnabledItself, isResponsive, isVisible, isVisibleItself, removeStyleName, requestFocus, setAlignment, setCaption, setDebugId, setDescription, setEnabled, setFrame, setHeight, setIcon, setId, setResponsive, setStyleName, setVisible, setWidth, setXmlDescriptor, unwrap, unwrapComposition

Methods inherited from class com.haulmont.bali.events.EventRouter

addListener, addListener, fireEvent, hasListeners, removeListener, removeListener

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.haulmont.cuba.gui.components.UploadField

getDropZone, getDropZonePrompt, getFileSizeLimit, getPermittedExtensions

Methods inherited from interface com.haulmont.cuba.gui.components.Component.Focusable

isFocusable, setFocusable

Methods inherited from interface com.haulmont.cuba.gui.components.Field

addValidator, getRequiredMessage, getValidators, isRequired, removeValidator, setRequired, setRequiredMessage

Methods inherited from interface com.haulmont.cuba.gui.components.DatasourceComponent

getDatasource, getMetaProperty, getMetaPropertyPath, setDatasource

Methods inherited from interface com.haulmont.cuba.gui.components.Component.HasValue

addListener, addValueChangeListener, getValue, removeListener, removeValueChangeListener, setValue

Methods inherited from interface com.haulmont.cuba.gui.components.Component.Editable

isEditable, isEditableWithParent, setEditable

Methods inherited from interface com.haulmont.cuba.gui.components.Component.BelongToFrame

getFrame, setFrame

Methods inherited from interface com.haulmont.cuba.gui.components.Component

addStyleName, getAlignment, getDebugId, getHeight, getHeightUnits, getId, getParent, getStyleName, getWidth, getWidthUnits, isEnabled, isEnabledItself, isResponsive, isVisible, isVisibleItself, removeStyleName, requestFocus, setAlignment, setDebugId, setEnabled, setHeight, setHeightAuto, setHeightFull, setId, setParent, setResponsive, setSizeAuto, setSizeFull, setStyleName, setVisible, setWidth, setWidthAuto, setWidthFull, unwrap, unwrapComposition

Methods inherited from interface com.haulmont.cuba.gui.components.Component.HasCaption

getCaption, getDescription, setCaption, setDescription

Methods inherited from interface com.haulmont.cuba.gui.components.Component.Validatable

isValid, isValidateOnCommit, validate

Methods inherited from interface com.haulmont.cuba.gui.components.Component.HasIcon

getIcon, setIcon

Constructor Detail

WebFileUploadField

public WebFileUploadField()

Method Detail

getFileName

public java.lang.String getFileName()

Specified by:

getFileName in interface FileUploadField

addListener

public void addListener(FileUploadField.Listener listener)

Specified by:

addListener in interface FileUploadField

removeListener

public void removeListener(FileUploadField.Listener listener)

Specified by:

removeListener in interface FileUploadField

getBytes

@Deprecated
public byte[] getBytes()

Deprecated. Please use getFileId() method and FileUploadingAPI

Get content bytes for uploaded file

Specified by:

getBytes in interface FileUploadField

Returns:

Bytes for uploaded file

getFileId

public java.util.UUID getFileId()

Description copied from interface: FileUploadField

Get id for uploaded file in FileUploading.

Specified by:

getFileId in interface FileUploadField

Returns:

File id for uploaded file in FileUploadingAPI

getFileDescriptor

public FileDescriptor getFileDescriptor()

Specified by:

getFileDescriptor in interface FileUploadField

getAccept

public java.lang.String getAccept()

Description copied from interface: UploadField

Returns comma separated types of files.

Specified by:

getAccept in interface UploadField

Returns:

comma separated types of files

setAccept

public void setAccept(java.lang.String accept)

Description copied from interface: UploadField

Sets the mask for files to filter them in the file selection dialog.
Example:

 fileUpload.setAccept(".png,.jpeg")

Specified by:

setAccept in interface UploadField

Parameters:

accept - comma separated types of files

setDropZone

public void setDropZone(UploadField.DropZone dropZone)

Description copied from interface: UploadField

Set drop zone reference to this upload component. Files can be dropped to component of the drop zone to be uploaded by this upload component.

Specified by:

setDropZone in interface UploadField

Overrides:

setDropZone in class WebAbstractUploadField<CubaFileUploadWrapper>

Parameters:

dropZone - drop zone descriptor

setDropZonePrompt

public void setDropZonePrompt(java.lang.String dropZonePrompt)

Description copied from interface: UploadField

Set drop zone prompt that will be shown on drag over window with file.

Specified by:

setDropZonePrompt in interface UploadField

Overrides:

setDropZonePrompt in class WebAbstractUploadField<CubaFileUploadWrapper>

Parameters:

dropZonePrompt - drop zone prompt

addFileUploadStartListener

public void addFileUploadStartListener(UploadField.FileUploadStartListener listener)

Specified by:

addFileUploadStartListener in interface UploadField

removeFileUploadStartListener

public void removeFileUploadStartListener(UploadField.FileUploadStartListener listener)

Specified by:

removeFileUploadStartListener in interface UploadField

addFileUploadFinishListener

public void addFileUploadFinishListener(UploadField.FileUploadFinishListener listener)

Specified by:

addFileUploadFinishListener in interface UploadField

removeFileUploadFinishListener

public void removeFileUploadFinishListener(UploadField.FileUploadFinishListener listener)

Specified by:

removeFileUploadFinishListener in interface UploadField

addFileUploadErrorListener

public void addFileUploadErrorListener(UploadField.FileUploadErrorListener listener)

Specified by:

addFileUploadErrorListener in interface UploadField

removeFileUploadErrorListener

public void removeFileUploadErrorListener(UploadField.FileUploadErrorListener listener)

Specified by:

removeFileUploadErrorListener in interface UploadField

addFileUploadSucceedListener

public void addFileUploadSucceedListener(FileUploadField.FileUploadSucceedListener listener)

Specified by:

addFileUploadSucceedListener in interface FileUploadField

removeFileUploadSucceedListener

public void removeFileUploadSucceedListener(FileUploadField.FileUploadSucceedListener listener)

Specified by:

removeFileUploadSucceedListener in interface FileUploadField

getFileContent

public java.io.InputStream getFileContent()

Specified by:

getFileContent in interface FileUploadField

Returns:

content of uploaded file.

setContentProvider

public void setContentProvider(FileUploadField.FileContentProvider contentProvider)

Description copied from interface: FileUploadField

Set content provider which contains file data.

Passed content provider will be used for downloading by clicking the link with file name or as source for FileUploadField.getFileContent() method.

Specified by:

setContentProvider in interface FileUploadField

Parameters:

contentProvider - content provider

getContentProvider

public FileUploadField.FileContentProvider getContentProvider()

Specified by:

getContentProvider in interface FileUploadField

Returns:

FileContentProvider which can be used to read data from field

setFileSizeLimit

public void setFileSizeLimit(long fileSizeLimit)

Description copied from interface: UploadField

Sets maximum allowed file size in bytes. Default value is 0. In this case component uses system value.

Specified by:

setFileSizeLimit in interface UploadField

getMode

public FileUploadField.FileStoragePutMode getMode()

Specified by:

getMode in interface FileUploadField

Returns:

mode which determines when FileDescriptor will be commited.

setMode

public void setMode(FileUploadField.FileStoragePutMode mode)

Description copied from interface: FileUploadField

Set mode which determines when FileDescriptor will be committed.

Specified by:

setMode in interface FileUploadField

isShowFileName

public boolean isShowFileName()

Specified by:

isShowFileName in interface FileUploadField

Returns:

true if name of uploaded file is shown.

setShowFileName

public void setShowFileName(boolean showFileName)

Description copied from interface: FileUploadField

Enable or disable displaying name of uploaded file next to upload button.

Specified by:

setShowFileName in interface FileUploadField

setPermittedExtensions

public void setPermittedExtensions(java.util.Set<java.lang.String> permittedExtensions)

Description copied from interface: UploadField

Set white list of file extensions. Each extension should start with dot symbol, e.g. ".png".

    private FileUploadField uploadField;
    ...
    uploadField.setPermittedExtensions(Sets.newHashSet(".png", ".jpg"));
 

Specified by:

setPermittedExtensions in interface UploadField

Overrides:

setPermittedExtensions in class WebAbstractUploadField<CubaFileUploadWrapper>

Parameters:

permittedExtensions - permitted extensions.

setShowClearButton

public void setShowClearButton(boolean showClearButton)

Description copied from interface: FileUploadField

Enable or disable displaying name of clear button.

Specified by:

setShowClearButton in interface FileUploadField

isShowClearButton

public boolean isShowClearButton()

Specified by:

isShowClearButton in interface FileUploadField

Returns:

true if clear button is shown.

setClearButtonCaption

public void setClearButtonCaption(java.lang.String caption)

Description copied from interface: FileUploadField

Setup clear button caption.

Specified by:

setClearButtonCaption in interface FileUploadField

getClearButtonCaption

public java.lang.String getClearButtonCaption()

Specified by:

getClearButtonCaption in interface FileUploadField

Returns:

clear button caption.

setClearButtonIcon

public void setClearButtonIcon(java.lang.String icon)

Description copied from interface: FileUploadField

Setup clear button icon.

Specified by:

setClearButtonIcon in interface FileUploadField

getClearButtonIcon

public java.lang.String getClearButtonIcon()

Specified by:

getClearButtonIcon in interface FileUploadField

Returns:

clear button icon.

setClearButtonDescription

public void setClearButtonDescription(java.lang.String description)

Description copied from interface: FileUploadField

Setup clear button description.

Specified by:

setClearButtonDescription in interface FileUploadField

getClearButtonDescription

public java.lang.String getClearButtonDescription()

Specified by:

getClearButtonDescription in interface FileUploadField

Returns:

clear button description.

addBeforeValueClearListener

public void addBeforeValueClearListener(FileUploadField.BeforeValueClearListener listener)

Specified by:

addBeforeValueClearListener in interface FileUploadField

removeBeforeValueClearListener

public void removeBeforeValueClearListener(FileUploadField.BeforeValueClearListener listener)

Specified by:

removeBeforeValueClearListener in interface FileUploadField

addAfterValueClearListener

public void addAfterValueClearListener(FileUploadField.AfterValueClearListener listener)

Specified by:

addAfterValueClearListener in interface FileUploadField

removeAfterValueClearListener

public void removeAfterValueClearListener(FileUploadField.AfterValueClearListener listener)

Specified by:

removeAfterValueClearListener in interface FileUploadField

setUploadButtonCaption

public void setUploadButtonCaption(java.lang.String caption)

Description copied from interface: FileUploadField

Setup caption of upload button.

Specified by:

setUploadButtonCaption in interface FileUploadField

getUploadButtonCaption

public java.lang.String getUploadButtonCaption()

Specified by:

getUploadButtonCaption in interface FileUploadField

Returns:

upload button caption.

setUploadButtonIcon

public void setUploadButtonIcon(java.lang.String icon)

Description copied from interface: FileUploadField

Setup upload button icon.

Specified by:

setUploadButtonIcon in interface FileUploadField

getUploadButtonIcon

public java.lang.String getUploadButtonIcon()

Specified by:

getUploadButtonIcon in interface FileUploadField

Returns:

upload button icon.

setUploadButtonDescription

public void setUploadButtonDescription(java.lang.String description)

Description copied from interface: FileUploadField

Setup upload button description.

Specified by:

setUploadButtonDescription in interface FileUploadField

getUploadButtonDescription

public java.lang.String getUploadButtonDescription()

Specified by:

getUploadButtonDescription in interface FileUploadField

Returns:

upload button description.

getTabIndex

public int getTabIndex()

Description copied from interface: Component.Focusable

Gets the tabulator index of the HasTabIndex component.

Specified by:

getTabIndex in interface Component.Focusable

Returns:

tab index set for the HasTabIndex component

setTabIndex

public void setTabIndex(int tabIndex)

Description copied from interface: Component.Focusable

Sets the tabulator index of the Focusable component. The tab index property is used to specify the order in which the fields are focused when the user presses the Tab key. Components with a defined tab index are focused sequentially first, and then the components with no tab index.

Specified by:

setTabIndex in interface Component.Focusable

Parameters:

tabIndex - tab index

commit

public void commit()

Description copied from interface: Component.Buffered

Updates all changes since the previous commit to the data source.

Specified by:

commit in interface Component.Buffered

discard

public void discard()

Description copied from interface: Component.Buffered

Discards all changes since last commit. The object updates its value from the data source.

Specified by:

discard in interface Component.Buffered

isBuffered

public boolean isBuffered()

Specified by:

isBuffered in interface Component.Buffered

Returns:

true if buffered mode is on, false otherwise

setBuffered

public void setBuffered(boolean buffered)

Description copied from interface: Component.Buffered

Sets the buffered mode.

When in buffered mode, an internal buffer will be used to store changes until Component.Buffered.commit() is called. Calling Component.Buffered.discard() will revert the internal buffer to the value of the data source.

When in non-buffered mode both read and write operations will be done directly on the data source. In this mode the Component.Buffered.commit() and Component.Buffered.discard() methods serve no purpose.

Specified by:

setBuffered in interface Component.Buffered

Parameters:

buffered - true if buffered mode should be turned on, false otherwise

isModified

public boolean isModified()

Description copied from interface: Component.Buffered

Tests if the value stored in the object has been modified since it was last updated from the data source.

Specified by:

isModified in interface Component.Buffered

Returns:

true if the value in the object has been modified since the last data source update, false if not.