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

Class FileField<RECORD>

java.lang.Object

org.teamapps.ux.component.AbstractComponent

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

org.teamapps.ux.component.field.upload.FileField<RECORD>

All Implemented Interfaces:

ClientObject, Component

public class FileField<RECORD>
extends AbstractField<java.util.List<RECORD>>

Field Summary

Fields

Modifier and Type	Field	Description
Event<RECORD>	onFileItemClicked
Event<RECORD>	onFileItemRemoved
Event<UploadCanceledEventData>	onUploadCanceled
Event<UploadFailedEventData>	onUploadFailed
Event<UploadStartedEventData>	onUploadStarted
Event<UploadSuccessfulEventData<RECORD>>	onUploadSuccessful
Event<UploadTooLargeEventData>	onUploadTooLarge

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

onValueChanged, onVisibilityChanged

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

DELETED_ATTRIBUTE, onRendered

Constructor Summary

Constructors

Constructor	Description
FileField(UploadedFileToRecordConverter<RECORD> uploadedFileToRecordConverter)

Method Summary

Modifier and Type	Method	Description
protected void	applyValueFromUi(java.lang.Object value)
void	cancelUploads()
java.util.List<RECORD>	convertUiValueToUxValue(java.lang.Object uiValues)
java.lang.Object	convertUxValueToUiValue(java.util.List<RECORD> uxValue)	Converts a server-side value to a client-side field-specific value.
static FileField<BaseTemplateRecord<UploadedFile>>	create()
org.teamapps.dto.UiField	createUiComponent()
FileFieldDisplayType	getDisplayType()
PropertyProvider<RECORD>	getFileItemPropertyProvider()
Template	getFileItemTemplate()
long	getMaxBytesPerFile()
int	getMaxFiles()
java.lang.Object	getUploadButtonData()
PropertyProvider	getUploadButtonPropertyProvider()
Template	getUploadButtonTemplate()
UploadedFileToRecordConverter<RECORD>	getUploadedFileToRecordConverter()
java.lang.String	getUploadUrl()
void	handleUiEvent(org.teamapps.dto.UiEvent event)
boolean	isEmpty()	Whether this field can be regarded as empty / "no user input".
boolean	isShowEntriesAsButtonsOnHover()
void	setDisplayType(FileFieldDisplayType displayType)
void	setFileItemPropertyExtractor(PropertyExtractor<RECORD> fileItemPropertyExtractor)
void	setFileItemPropertyProvider(PropertyProvider<RECORD> fileItemPropertyProvider)
void	setFileItemTemplate(Template fileItemTemplate)
void	setMaxBytesPerFile(long maxBytesPerFile)
void	setMaxFiles(int maxFiles)
void	setShowEntriesAsButtonsOnHover(boolean showEntriesAsButtonsOnHover)
void	setUploadButtonData(java.lang.Object uploadButtonData)
void	setUploadButtonPropertyExtractor(PropertyExtractor propertyExtractor)
void	setUploadButtonPropertyProvider(PropertyProvider propertyProvider)
void	setUploadButtonTemplate(Template uploadButtonTemplate)
void	setUploadUrl(java.lang.String uploadUrl)
void	setValue(java.util.List<RECORD> records)
void	setValue(java.util.List<RECORD> records, boolean cancelUploads)

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

addCustomFieldMessage, addCustomFieldMessage, addValidator, clearCustomFieldMessages, clearValidatorMessages, focus, getCustomFieldMessages, getDefaultMessagePosition, getDefaultMessageVisibility, getEditingMode, getFieldMessages, getMaxFieldMessageSeverity, getValidators, getValue, isRequired, isValid, isValueChangedByClient, mapAbstractFieldAttributesToUiField, removeCustomFieldMessage, removeValidator, setAndLockValue, setCustomFieldMessages, setDefaultMessagePosition, setDefaultMessageVisibility, setEditingMode, setRequired, setRequiredIfVisibleAndEditable, 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 Detail

onUploadTooLarge

public final Event<UploadTooLargeEventData> onUploadTooLarge

onUploadStarted

public final Event<UploadStartedEventData> onUploadStarted

onUploadCanceled

public final Event<UploadCanceledEventData> onUploadCanceled

onUploadFailed

public final Event<UploadFailedEventData> onUploadFailed

onUploadSuccessful

public final Event<UploadSuccessfulEventData<RECORD>> onUploadSuccessful

onFileItemClicked

public final Event<RECORD> onFileItemClicked

onFileItemRemoved

public final Event<RECORD> onFileItemRemoved

Constructor Detail

FileField

public FileField(UploadedFileToRecordConverter<RECORD> uploadedFileToRecordConverter)

Method Detail

create

public static FileField<BaseTemplateRecord<UploadedFile>> create()

createUiComponent

public org.teamapps.dto.UiField createUiComponent()

Specified by:

createUiComponent in class AbstractComponent

setValue

public void setValue(java.util.List<RECORD> records)

Overrides:

setValue in class AbstractField<java.util.List<RECORD>>

setValue

public void setValue(java.util.List<RECORD> records,
                     boolean cancelUploads)

cancelUploads

public void cancelUploads()

convertUxValueToUiValue

public java.lang.Object convertUxValueToUiValue(java.util.List<RECORD> uxValue)

Description copied from class: AbstractField

Converts a server-side value to a client-side field-specific value. Implementations must not have any side effects to the component!

Overrides:

convertUxValueToUiValue in class AbstractField<java.util.List<RECORD>>

Parameters:

uxValue - the server-side value

Returns:

the object to be sent to the ui

convertUiValueToUxValue

public java.util.List<RECORD> convertUiValueToUxValue(java.lang.Object uiValues)

Overrides:

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

handleUiEvent

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

Specified by:

handleUiEvent in interface ClientObject

Overrides:

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

isEmpty

public boolean isEmpty()

Description copied from class: AbstractField

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

Overrides:

isEmpty in class AbstractField<java.util.List<RECORD>>

Returns:

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

applyValueFromUi

protected void applyValueFromUi(java.lang.Object value)

Overrides:

applyValueFromUi in class AbstractField<java.util.List<RECORD>>

getFileItemTemplate

public Template getFileItemTemplate()

setFileItemTemplate

public void setFileItemTemplate(Template fileItemTemplate)

getMaxBytesPerFile

public long getMaxBytesPerFile()

setMaxBytesPerFile

public void setMaxBytesPerFile(long maxBytesPerFile)

getUploadUrl

public java.lang.String getUploadUrl()

setUploadUrl

public void setUploadUrl(java.lang.String uploadUrl)

getUploadButtonTemplate

public Template getUploadButtonTemplate()

setUploadButtonTemplate

public void setUploadButtonTemplate(Template uploadButtonTemplate)

getUploadButtonData

public java.lang.Object getUploadButtonData()

setUploadButtonData

public void setUploadButtonData(java.lang.Object uploadButtonData)

isShowEntriesAsButtonsOnHover

public boolean isShowEntriesAsButtonsOnHover()

setShowEntriesAsButtonsOnHover

public void setShowEntriesAsButtonsOnHover(boolean showEntriesAsButtonsOnHover)

getDisplayType

public FileFieldDisplayType getDisplayType()

setDisplayType

public void setDisplayType(FileFieldDisplayType displayType)

getMaxFiles

public int getMaxFiles()

setMaxFiles

public void setMaxFiles(int maxFiles)

getUploadButtonPropertyProvider

public PropertyProvider getUploadButtonPropertyProvider()

setUploadButtonPropertyProvider

public void setUploadButtonPropertyProvider(PropertyProvider propertyProvider)

setUploadButtonPropertyExtractor

public void setUploadButtonPropertyExtractor(PropertyExtractor propertyExtractor)

getUploadedFileToRecordConverter

public UploadedFileToRecordConverter<RECORD> getUploadedFileToRecordConverter()

getFileItemPropertyProvider

public PropertyProvider<RECORD> getFileItemPropertyProvider()

setFileItemPropertyProvider

public void setFileItemPropertyProvider(PropertyProvider<RECORD> fileItemPropertyProvider)

setFileItemPropertyExtractor

public void setFileItemPropertyExtractor(PropertyExtractor<RECORD> fileItemPropertyExtractor)