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

Klasse FileField<RECORD>

java.lang.Object

org.teamapps.ux.component.AbstractComponent

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

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

Alle implementierten Schnittstellen:

ClientObject, Component

public class FileField<RECORD>
extends AbstractField<List<RECORD>>

Feldübersicht

Felder

Modifizierer und Typ	Feld	Beschreibung
final Event<RECORD>	onFileItemClicked
final Event<RECORD>	onFileItemRemoved
final Event<UploadCanceledEventData>	onUploadCanceled
final Event<UploadFailedEventData>	onUploadFailed
final Event<UploadStartedEventData>	onUploadStarted
final Event<UploadSuccessfulEventData<RECORD>>	onUploadSuccessful
final Event<UploadTooLargeEventData>	onUploadTooLarge

Von Klasse geerbte Felder org.teamapps.ux.component.field.AbstractField

onBlur, onFocus, onValueChanged, onVisibilityChanged

Von Klasse geerbte Felder org.teamapps.ux.component.AbstractComponent

DELETED_ATTRIBUTE, onRendered

Konstruktorübersicht

Konstruktoren

Konstruktor	Beschreibung
FileField(UploadedFileToRecordConverter<RECORD> uploadedFileToRecordConverter)

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
protected void	applyValueFromUi(Object value)
void	cancelUploads()
List<RECORD>	convertUiValueToUxValue(Object uiValues)
Object	convertUxValueToUiValue(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()
List<String>	getAcceptedFileTypes()
FileFieldDisplayType	getDisplayType()
PropertyProvider<RECORD>	getFileItemPropertyProvider()
Template	getFileItemTemplate()
long	getMaxBytesPerFile()
int	getMaxFiles()
Object	getUploadButtonData()
PropertyProvider	getUploadButtonPropertyProvider()
Template	getUploadButtonTemplate()
UploadedFileToRecordConverter<RECORD>	getUploadedFileToRecordConverter()
String	getUploadUrl()
void	handleUiEvent(org.teamapps.dto.UiEvent event)
boolean	isEmptyValue(List<RECORD> value)	Whether this value be regarded as empty / "no user input".
boolean	isShowEntriesAsButtonsOnHover()
void	setAcceptedFileTypes(List<String> acceptedFileTypes)
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(Object uploadButtonData)
void	setUploadButtonPropertyExtractor(PropertyExtractor propertyExtractor)
void	setUploadButtonPropertyProvider(PropertyProvider propertyProvider)
void	setUploadButtonTemplate(Template uploadButtonTemplate)
void	setUploadUrl(String uploadUrl)
void	setValue(List<RECORD> records)
void	setValue(List<RECORD> records, boolean cancelUploads)

Von Klasse geerbte Methoden org.teamapps.ux.component.field.AbstractField

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

Von Klasse geerbte Methoden org.teamapps.ux.component.AbstractComponent

createUiReference, getDebuggingId, getId, getParent, getSessionContext, isRendered, isVisible, mapAbstractUiComponentProperties, queueCommandIfRendered, render, reRenderIfRendered, setAttribute, setCssStyle, setDebuggingId, setParent, toggleCssClass, toString, unrender

Von Klasse geerbte Methoden java.lang.Object

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

Von Schnittstelle geerbte Methoden org.teamapps.ux.component.ClientObject

handleUiQuery

Von Schnittstelle geerbte Methoden org.teamapps.ux.component.Component

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

Felddetails

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

Konstruktordetails

FileField

public FileField(UploadedFileToRecordConverter<RECORD> uploadedFileToRecordConverter)

Methodendetails

create

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

createUiComponent

public org.teamapps.dto.UiField createUiComponent()

Angegeben von:

createUiComponent in Klasse AbstractComponent

setValue

public void setValue(List<RECORD> records)

Setzt außer Kraft:

setValue in Klasse AbstractField<List<RECORD>>

setValue

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

cancelUploads

public void cancelUploads()

convertUxValueToUiValue

public Object convertUxValueToUiValue(List<RECORD> uxValue)

Beschreibung aus Klasse kopiert: AbstractField

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

Setzt außer Kraft:

convertUxValueToUiValue in Klasse AbstractField<List<RECORD>>

Parameter:

uxValue - the server-side value

Gibt zurück:

the object to be sent to the ui

convertUiValueToUxValue

public List<RECORD> convertUiValueToUxValue(Object uiValues)

Setzt außer Kraft:

convertUiValueToUxValue in Klasse AbstractField<List<RECORD>>

handleUiEvent

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

Angegeben von:

handleUiEvent in Schnittstelle ClientObject

Setzt außer Kraft:

handleUiEvent in Klasse AbstractField<List<RECORD>>

isEmptyValue

public boolean isEmptyValue(List<RECORD> value)

Beschreibung aus Klasse kopiert: AbstractField

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

Setzt außer Kraft:

isEmptyValue in Klasse AbstractField<List<RECORD>>

Gibt zurück:

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

applyValueFromUi

protected void applyValueFromUi(Object value)

Setzt außer Kraft:

applyValueFromUi in Klasse AbstractField<List<RECORD>>

getFileItemTemplate

public Template getFileItemTemplate()

setFileItemTemplate

public void setFileItemTemplate(Template fileItemTemplate)

getMaxBytesPerFile

public long getMaxBytesPerFile()

setMaxBytesPerFile

public void setMaxBytesPerFile(long maxBytesPerFile)

getUploadUrl

public String getUploadUrl()

setUploadUrl

public void setUploadUrl(String uploadUrl)

getUploadButtonTemplate

public Template getUploadButtonTemplate()

setUploadButtonTemplate

public void setUploadButtonTemplate(Template uploadButtonTemplate)

getUploadButtonData

public Object getUploadButtonData()

setUploadButtonData

public void setUploadButtonData(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)

getAcceptedFileTypes

public List<String> getAcceptedFileTypes()

setAcceptedFileTypes

public void setAcceptedFileTypes(List<String> acceptedFileTypes)