Package org.teamapps.ux.component.field.upload.simple

Class SimpleFileField

java.lang.Object

org.teamapps.ux.component.AbstractComponent

org.teamapps.ux.component.field.AbstractField<java.util.List<FileItem>>

org.teamapps.ux.component.field.upload.simple.SimpleFileField

All Implemented Interfaces:

Component

public class SimpleFileField
extends AbstractField<java.util.List<FileItem>>

Author:

Yann Massard (yamass@gmail.com)

Field Summary

Fields

Modifier and Type	Field	Description
Event<FileItem>	onFileItemClicked
Event<FileItem>	onFileItemRemoved
Event<FileItem>	onUploadCanceledByUser
Event<FileItem>	onUploadFailed
Event<FileItem>	onUploadInitiatedByUser
Event<FileItem>	onUploadStarted
Event<FileItem>	onUploadSuccessful
Event<FileItem>	onUploadTooLarge

Fields inherited from class org.teamapps.ux.component.field.AbstractField

onValueChanged, onVisibilityChanged

Fields inherited from class org.teamapps.ux.component.AbstractComponent

onDestroyed, onRendered

Constructor Summary

Constructors

Constructor	Description
SimpleFileField()

Method Summary

Modifier and Type	Method	Description
void	addFileItem(FileItem fileItem)
java.util.List<FileItem>	convertUiValueToUxValue(java.lang.Object value)
org.teamapps.dto.UiComponent	createUiComponent()
protected void	doDestroy()	Override this method to release resources whenever this component gets destroyed
java.lang.String	getBrowseButtonCaption()
org.teamapps.icons.api.Icon	getBrowseButtonIcon()
FileFieldDisplayType	getDisplayType()
long	getMaxBytesPerFile()
int	getMaxFiles()
java.lang.String	getUploadUrl()
java.util.List<FileItem>	getValue()
void	handleUiEvent(org.teamapps.dto.UiEvent event)
void	removeFileItem(FileItem fileItem)
void	setBrowseButtonCaption(java.lang.String browseButtonCaption)
void	setBrowseButtonIcon(org.teamapps.icons.api.Icon browseButtonIcon)
void	setDisplayType(FileFieldDisplayType displayType)
void	setMaxBytesPerFile(long maxBytesPerFile)
void	setMaxFiles(int maxFiles)
void	setUploadUrl(java.lang.String uploadUrl)

Methods inherited from class org.teamapps.ux.component.field.AbstractField

addCustomFieldMessage, addValidator, applyValueFromUi, clearCustomFieldMessages, convertUxValueToUiValue, focus, getCustomFieldMessages, getDefaultMessagePosition, getDefaultMessageVisibility, getEditingMode, getFieldMessages, getMaxFieldMessageSeverity, getValidators, isEmpty, isRequired, isValid, mapAbstractFieldAttributesToUiField, removeCustomFieldMessage, removeValidator, setAndLockValue, setCustomFieldMessages, setDefaultMessagePosition, setDefaultMessageVisibility, setEditingMode, setRequired, setValue, setVisible, validate

Methods inherited from class org.teamapps.ux.component.AbstractComponent

createUiComponentReference, destroy, getDebuggingId, getId, getParent, getSessionContext, isDestroyed, isEffectivelyVisible, isRendered, isVisible, mapAbstractUiComponentProperties, onDestroyed, queueCommandIfRendered, render, reRenderIfRendered, setCssStyle, setDebuggingId, setMargin, setMaxHeight, setMaxWidth, setMinHeight, setMinWidth, setParent, setShadow, toString, unrender

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.teamapps.ux.component.Component

setCssStyle

Field Details

onUploadInitiatedByUser

public final Event<FileItem> onUploadInitiatedByUser

onUploadTooLarge

public final Event<FileItem> onUploadTooLarge

onUploadStarted

public final Event<FileItem> onUploadStarted

onUploadCanceledByUser

public final Event<FileItem> onUploadCanceledByUser

onUploadFailed

public final Event<FileItem> onUploadFailed

onUploadSuccessful

public final Event<FileItem> onUploadSuccessful

onFileItemClicked

public final Event<FileItem> onFileItemClicked

onFileItemRemoved

public final Event<FileItem> onFileItemRemoved

Constructor Details

SimpleFileField

public SimpleFileField()

Method Details

addFileItem

public void addFileItem(FileItem fileItem)

removeFileItem

public void removeFileItem(FileItem fileItem)

convertUiValueToUxValue

public java.util.List<FileItem> convertUiValueToUxValue(java.lang.Object value)

Overrides:

convertUiValueToUxValue in class AbstractField<java.util.List<FileItem>>

getValue

public java.util.List<FileItem> getValue()

Overrides:

getValue in class AbstractField<java.util.List<FileItem>>

createUiComponent

public org.teamapps.dto.UiComponent createUiComponent()

Specified by:

createUiComponent in class AbstractComponent

handleUiEvent

public void handleUiEvent(org.teamapps.dto.UiEvent event)

Specified by:

handleUiEvent in interface Component

Overrides:

handleUiEvent in class AbstractField<java.util.List<FileItem>>

doDestroy

protected void doDestroy()

Description copied from class: AbstractComponent

Override this method to release resources whenever this component gets destroyed

Overrides:

doDestroy in class AbstractComponent

getDisplayType

public FileFieldDisplayType getDisplayType()

setDisplayType

public void setDisplayType(FileFieldDisplayType displayType)

getMaxFiles

public int getMaxFiles()

setMaxFiles

public void setMaxFiles(int maxFiles)

getMaxBytesPerFile

public long getMaxBytesPerFile()

setMaxBytesPerFile

public void setMaxBytesPerFile(long maxBytesPerFile)

getUploadUrl

public java.lang.String getUploadUrl()

setUploadUrl

public void setUploadUrl(java.lang.String uploadUrl)

getBrowseButtonIcon

public org.teamapps.icons.api.Icon getBrowseButtonIcon()

setBrowseButtonIcon

public void setBrowseButtonIcon(org.teamapps.icons.api.Icon browseButtonIcon)

getBrowseButtonCaption

public java.lang.String getBrowseButtonCaption()

setBrowseButtonCaption

public void setBrowseButtonCaption(java.lang.String browseButtonCaption)