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

Class SimpleFileField

java.lang.Object

org.teamapps.ux.component.AbstractComponent

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

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

All Implemented Interfaces:

ClientObject, Component

public class SimpleFileField
extends AbstractField<List<FileItem>>

Author:

Yann Massard (yamass@gmail.com)

Field Summary

Fields

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

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

onBlur, onFocus, onValueChanged, onVisibilityChanged

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

DELETED_ATTRIBUTE, onRendered

Constructor Summary

Constructors

Constructor	Description
SimpleFileField()

Method Summary

Modifier and Type	Method	Description
void	addFileItem(FileItem fileItem)
List<FileItem>	convertUiValueToUxValue(Object value)
UiComponent	createUiComponent()
List<String>	getAcceptedFileTypes()
String	getBrowseButtonCaption()
Icon	getBrowseButtonIcon()
FileFieldDisplayType	getDisplayType()
long	getMaxBytesPerFile()
int	getMaxFiles()
String	getUploadUrl()
List<FileItem>	getValue()
void	handleUiEvent(UiEvent event)
boolean	isEmptyValue(List<FileItem> value)	Whether this value be regarded as empty / "no user input".
void	removeFileItem(FileItem fileItem)
void	setAcceptedFileTypes(List<String> acceptedFileTypes)
void	setBrowseButtonCaption(String browseButtonCaption)
void	setBrowseButtonIcon(Icon browseButtonIcon)
void	setDisplayType(FileFieldDisplayType displayType)
void	setMaxBytesPerFile(long maxBytesPerFile)
void	setMaxFiles(int maxFiles)
void	setUploadUrl(String uploadUrl)

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

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

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

createUiReference, getDebuggingId, getId, getParent, getSessionContext, isRendered, isVisible, mapAbstractUiComponentProperties, queueCommandIfRendered, render, reRenderIfRendered, setAttribute, setCssStyle, setDebuggingId, setParent, toggleCssClass, 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.ClientObject

handleUiQuery

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

setAriaLabel, setAttribute, setCssStyle, setHtmlTitle, setMargin, setMaxHeight, setMaxWidth, setMinHeight, setMinWidth, setShadow, toggleCssClass

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 List<FileItem> convertUiValueToUxValue(Object value)

Overrides:

convertUiValueToUxValue in class AbstractField<List<FileItem>>

getValue

public List<FileItem> getValue()

Overrides:

getValue in class AbstractField<List<FileItem>>

isEmptyValue

public boolean isEmptyValue(List<FileItem> value)

Description copied from class: AbstractField

Whether this value be regarded as empty / "no user input". Override for field-specific behaviour.

Overrides:

isEmptyValue in class AbstractField<List<FileItem>>

Returns:

true if the value can be regarded as "empty".

createUiComponent

public UiComponent createUiComponent()

Specified by:

createUiComponent in class AbstractComponent

handleUiEvent

public void handleUiEvent(UiEvent event)

Specified by:

handleUiEvent in interface ClientObject

Overrides:

handleUiEvent in class AbstractField<List<FileItem>>

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 String getUploadUrl()

setUploadUrl

public void setUploadUrl(String uploadUrl)

getBrowseButtonIcon

public Icon getBrowseButtonIcon()

setBrowseButtonIcon

public void setBrowseButtonIcon(Icon browseButtonIcon)

getBrowseButtonCaption

public String getBrowseButtonCaption()

setBrowseButtonCaption

public void setBrowseButtonCaption(String browseButtonCaption)

getAcceptedFileTypes

public List<String> getAcceptedFileTypes()

setAcceptedFileTypes

public void setAcceptedFileTypes(List<String> acceptedFileTypes)