Class 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>
- All Implemented Interfaces:
ClientObject,Component
-
Field Summary
FieldsModifier and TypeFieldDescriptionfinal Event<UploadCanceledEventData> final Event<UploadFailedEventData> final Event<UploadStartedEventData> final Event<UploadSuccessfulEventData<RECORD>> final Event<UploadTooLargeEventData> Fields inherited from class org.teamapps.ux.component.field.AbstractField
onBlur, onFocus, onValueChanged, onVisibilityChangedFields inherited from class org.teamapps.ux.component.AbstractComponent
DELETED_ATTRIBUTE, onRendered -
Constructor Summary
ConstructorsConstructorDescriptionFileField(UploadedFileToRecordConverter<RECORD> uploadedFileToRecordConverter) -
Method Summary
Modifier and TypeMethodDescriptionprotected voidapplyValueFromUi(Object value) voidconvertUiValueToUxValue(Object uiValues) convertUxValueToUiValue(List<RECORD> uxValue) Converts a server-side value to a client-side field-specific value.static FileField<BaseTemplateRecord<UploadedFile>> create()longintvoidhandleUiEvent(UiEvent event) booleanisEmptyValue(List<RECORD> value) Whether this value be regarded as empty / "no user input".booleanvoidsetAcceptedFileTypes(List<String> acceptedFileTypes) voidsetDisplayType(FileFieldDisplayType displayType) voidsetFileItemPropertyExtractor(PropertyExtractor<RECORD> fileItemPropertyExtractor) voidsetFileItemPropertyProvider(PropertyProvider<RECORD> fileItemPropertyProvider) voidsetFileItemTemplate(Template fileItemTemplate) voidsetMaxBytesPerFile(long maxBytesPerFile) voidsetMaxFiles(int maxFiles) voidsetShowEntriesAsButtonsOnHover(boolean showEntriesAsButtonsOnHover) voidsetUploadButtonData(Object uploadButtonData) voidsetUploadButtonPropertyExtractor(PropertyExtractor propertyExtractor) voidsetUploadButtonPropertyProvider(PropertyProvider propertyProvider) voidsetUploadButtonTemplate(Template uploadButtonTemplate) voidsetUploadUrl(String uploadUrl) voidvoidMethods inherited from class 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, validateMethods 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, unrenderMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface org.teamapps.ux.component.ClientObject
handleUiQueryMethods inherited from interface org.teamapps.ux.component.Component
setAriaLabel, setAttribute, setCssStyle, setHtmlTitle, setMargin, setMaxHeight, setMaxWidth, setMinHeight, setMinWidth, setShadow, toggleCssClass
-
Field Details
-
onUploadTooLarge
-
onUploadStarted
-
onUploadCanceled
-
onUploadFailed
-
onUploadSuccessful
-
onFileItemClicked
-
onFileItemRemoved
-
-
Constructor Details
-
FileField
-
-
Method Details
-
create
-
createUiComponent
- Specified by:
createUiComponentin classAbstractComponent
-
setValue
-
setValue
-
cancelUploads
public void cancelUploads() -
convertUxValueToUiValue
Description copied from class:AbstractFieldConverts a server-side value to a client-side field-specific value. Implementations must not have any side effects to the component!- Overrides:
convertUxValueToUiValuein classAbstractField<List<RECORD>>- Parameters:
uxValue- the server-side value- Returns:
- the object to be sent to the ui
-
convertUiValueToUxValue
- Overrides:
convertUiValueToUxValuein classAbstractField<List<RECORD>>
-
handleUiEvent
- Specified by:
handleUiEventin interfaceClientObject- Overrides:
handleUiEventin classAbstractField<List<RECORD>>
-
isEmptyValue
Description copied from class:AbstractFieldWhether this value be regarded as empty / "no user input". Override for field-specific behaviour.- Overrides:
isEmptyValuein classAbstractField<List<RECORD>>- Returns:
- true if the value can be regarded as "empty".
-
applyValueFromUi
- Overrides:
applyValueFromUiin classAbstractField<List<RECORD>>
-
getFileItemTemplate
-
setFileItemTemplate
-
getMaxBytesPerFile
public long getMaxBytesPerFile() -
setMaxBytesPerFile
public void setMaxBytesPerFile(long maxBytesPerFile) -
getUploadUrl
-
setUploadUrl
-
getUploadButtonTemplate
-
setUploadButtonTemplate
-
getUploadButtonData
-
setUploadButtonData
-
isShowEntriesAsButtonsOnHover
public boolean isShowEntriesAsButtonsOnHover() -
setShowEntriesAsButtonsOnHover
public void setShowEntriesAsButtonsOnHover(boolean showEntriesAsButtonsOnHover) -
getDisplayType
-
setDisplayType
-
getMaxFiles
public int getMaxFiles() -
setMaxFiles
public void setMaxFiles(int maxFiles) -
getUploadButtonPropertyProvider
-
setUploadButtonPropertyProvider
-
setUploadButtonPropertyExtractor
-
getUploadedFileToRecordConverter
-
getFileItemPropertyProvider
-
setFileItemPropertyProvider
-
setFileItemPropertyExtractor
-
getAcceptedFileTypes
-
setAcceptedFileTypes
-