public class MultiFileItem extends CanvasItem
Use MultiFileItem when a record may have one or more files associated with it (such as
attachments to an email message) where no information about the files needs to be stored other
than the files themselves. If you have several fields associated with each file (such as an
uploaded document with a version, comments and processes associated with it), consider
instead an ordinary DataSource with on field of type "binary", and using the FileItem
for upload.
See the Uploading Files
overview for more information on upload.
DataSource Setup
In a relationship sometimes called a "master-detail" relationship, the MultiFileItem stores files in a "detail" DataSource which are related to a "master" DataSource record being edited by the form which contains the MultiFileItem.
To use a MultiFileItem:
primaryKey
field
foreignKey
relationship to the
primaryKey of the "master" DataSource
bind
a DynamicForm to the "master" DataSource
editorType
:"MultiFileItem" and a
dataSource
property set to the ID of the "detail" DataSource
DataSource.ID
"masterRecord" and
with a primaryKey
field "id".
<DataSource ID="uploadedFiles" serverType="sql">
<fields>
<field name="fileId" type="sequence" primaryKey="true" hidden="true"/>
<field name="masterRecordId" type="number" foreignKey="masterRecord.id" hidden="true"/>
<field name="file" type="binary" title="File"/>
</fields>
</DataSource>
Aside from a single "binary" field, the "detail" DataSource should generally have only hidden fields, as shown above. Additional internal fields (such as a "lastUpdated" field) may be added, but will not be editable via MultiFileItem.
Display
The MultiFileItem appears as a list of files related to the current record. An optional
button, the removeButton
allows removing
files. A
second optional button, the editButton
,
launches a
picker for uploading further files.
Saving
In all cases, uploading a new file is an "add" DSRequest against the
dataSource
.
The MultiFileItem has two modes, according to whether the "master" record is being newly created via an "add" operation or whether the master record is pre-existing ("update" operation).
If the master record is pre-existing, each file added by the user is uploaded as soon as the user exits the picker launched from the edit button, and the list of files shown in the main form reflects the actual list of stored files.
If the master record is being newly created, files are not actually uploaded until after the master record is confirmed saved, and the list of fields shown in the main form reflects files which will be uploaded after the master record is saved.
In both cases, if there are multiple files to upload, they are uploaded one at a time, as a
series of separate "add" DSRequests against the dataSource
.
Also in both cases, deletion of any file is immediate. In the case of a pre-existing master
record, all files shown actually exist as DataSource records, and deletion is performed as a
"remove" DSRequest against the dataSource
.
Upload overview and related methods
FormItem.CustomStateGetter, FormItem.StateCustomizer
configOnly, scClassName, warnOnEditorTypeConversion, warnOnEditorTypeConversionDefault
id
factoryCreated, factoryProperties
Constructor and Description |
---|
MultiFileItem() |
MultiFileItem(com.google.gwt.core.client.JavaScriptObject jsObj) |
MultiFileItem(java.lang.String name) |
MultiFileItem(java.lang.String name,
java.lang.String title) |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getEditButtonPrompt()
The
prompt of the edit button . |
java.lang.String |
getEmptyMessage()
Empty message to display when there are no files listed.
|
static MultiFileItem |
getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj) |
java.lang.String |
getPickerAddAnotherFileButtonTitle()
The contents of the "Add another" file button in the picker launched by the
edit button . |
java.lang.String |
getPickerCancelButtonTitle()
The title of the cancel button in the picker lauched by the
edit button . |
java.lang.String |
getPickerConstructor()
MultiFileItems use a
MultiFilePicker instance as their picker. |
java.lang.String |
getPickerUploadButtonInitialTitle()
The initial title of the upload button in the picker lauched by the
edit button that is used before the form is saved. |
java.lang.String |
getPickerUploadButtonTitle()
The title of the upload button in the picker lauched by the
edit button that is used after the form is saved. |
java.lang.String |
getPickerUploadProgressLabel()
Specifies the label of the progress meter in the picker lauched by the
edit button . |
java.lang.String |
getRemoveButtonPrompt()
The
prompt of the remove button . |
MultiFileItem |
setEditButtonPrompt(java.lang.String editButtonPrompt)
The
prompt of the edit button . |
MultiFileItem |
setEmptyMessage(java.lang.String emptyMessage)
Empty message to display when there are no files listed.
|
MultiFileItem |
setPickerAddAnotherFileButtonTitle(java.lang.String pickerAddAnotherFileButtonTitle)
The contents of the "Add another" file button in the picker launched by the
edit button . |
MultiFileItem |
setPickerCancelButtonTitle(java.lang.String pickerCancelButtonTitle)
The title of the cancel button in the picker lauched by the
edit button . |
MultiFileItem |
setPickerConstructor(java.lang.String pickerConstructor)
MultiFileItems use a
MultiFilePicker instance as their picker. |
MultiFileItem |
setPickerUploadButtonInitialTitle(java.lang.String pickerUploadButtonInitialTitle)
The initial title of the upload button in the picker lauched by the
edit button that is used before the form is saved. |
MultiFileItem |
setPickerUploadButtonTitle(java.lang.String pickerUploadButtonTitle)
The title of the upload button in the picker lauched by the
edit button that is used after the form is saved. |
MultiFileItem |
setPickerUploadProgressLabel(java.lang.String pickerUploadProgressLabel)
Specifies the label of the progress meter in the picker lauched by the
edit button . |
MultiFileItem |
setRemoveButtonPrompt(java.lang.String removeButtonPrompt)
The
prompt of the remove button . |
addCanEditChangedHandler, addReadOnlyDisplayChangedHandler, addShowValueHandler, changeAutoChildDefaults, changeAutoChildDefaults, changePickerIconDefaults, createCanvas, getApplyPromptToCanvas, getAutoDestroy, getCanvas, getEditCriteriaInInnerForm, getHeight, getHeightAsString, getMaxHeight, getMinHeight, getMultiple, getOverflow, getPrompt, getShouldSaveValue, hasAdvancedCriteria, isFocused, setApplyPromptToCanvas, setAutoDestroy, setCanEditCriterionPredicate, setCanvas, setCriterionGetter, setCriterionSetter, setDefaultProperties, setEditCriteriaInInnerForm, setHeight, setHeight, setMaxHeight, setMinHeight, setMultiple, setOverflow, setPrompt, setShouldDisableCanvasCustomizer, setShouldSaveValue, setupCanvasConstructor, storeValue, storeValue, storeValue, updateCanvasTabPosition
_getValue, addBlurHandler, addChangedHandler, addChangeHandler, addClickHandler, addDoubleClickHandler, addEditorEnterHandler, addEditorExitHandler, addFocusHandler, addIcon, addIcon, addIconClickHandler, addIconKeyPressHandler, addItemHoverHandler, addKeyDownHandler, addKeyPressHandler, addKeyUpHandler, addPendingStatusChangedHandler, addPickerIconClickHandler, addShowContextMenuHandler, addTitleClickHandler, addTitleDoubleClickHandler, addTitleHoverHandler, addValueHoverHandler, addValueIconClickHandler, applyFormula, asSGWTComponent, blurItem, canEditCriterion, clearErrors, clearValue, disable, disableIcon, enable, enableIcon, error, error, errorIfNotCreated, focusAfterItem, focusInItem, getAccessKey, getAlign, getAllowExpressions, getAlwaysFetchMissingValues, getAlwaysShowControlBox, getApplyAlignToText, getApplyHeightToTextBox, getAriaRole, getAttribute, getAttributeAsBoolean, getAttributeAsBoolean, getAttributeAsDate, getAttributeAsDouble, getAttributeAsFloat, getAttributeAsInt, getAttributeAsJavaScriptObject, getAttributeAsObject, getAttributeAsString, getAutoComplete, getAutoCompleteKeywords, getBrowserInputType, getBrowserSpellCheck, getCanEdit, getCanEditOpaqueValues, getCanFocus, getCanSelectText, getCanTabToIcons, getCanvasAutoChild, getCellHeight, getCellStyle, getChangeOnKeypress, getClassName, getClipStaticValue, getClipTitle, getConfig, getContainerWidget, getControlStyle, getCriteriaField, getCriterion, getCriterion, getCursorPosition, getCustomState, getDataPath, getDateFormatter, getDecimalPad, getDecimalPrecision, getDefaultIconSrc, getDefaultOperator, getDestroyed, getDisabled, getDisabledHover, getDisableIconsOnReadOnly, getDisplayField, getDisplayFieldName, getDisplayValue, getDisplayValue, getEditorTypeConfig, getEditPendingCSSText, getEditProxyConstructor, getEmptyDisplayValue, getEmptyValueIcon, getEndRow, getErrorIconHeight, getErrorIconSrc, getErrorIconWidth, getErrorMessageWidth, getErrors, getEscapeHTML, getExportFormat, getFetchMissingValues, getFieldName, getFilterLocally, getForeignDisplayField, getForm, getFormat, getFormItemAutoChild, getFormula, getFullDataPath, getGlobalTabIndex, getGridColNum, getGridRowNum, getHidden, getHint, getHintStyle, getHoverAlign, getHoverDelay, getHoverFocusKey, getHoverHeight, getHoverHeightAsString, getHoverOpacity, getHoverPersist, getHoverStyle, getHoverVAlign, getHoverWidth, getHoverWidthAsString, getIcon, getIconHeight, getIconHSpace, getIconPageRect, getIconPrompt, getIconRect, getIcons, getIconTabPosition, getIconVAlign, getIconWidth, getID, getImageURLPrefix, getImageURLSuffix, getImplicitSave, getImplicitSaveOnBlur, getInputFormat, getLeft, getLinearColSpan, getLinearColSpanAsString, getLinearEndRow, getLinearEndRowAsString, getLinearStartRow, getLinearStartRowAsString, getLinearWidth, getLinearWidthAsString, getListGrid, getLoadingDisplayValue, getLocateItemBy, getMinHintWidth, getMultipleValueSeparator, getName, getNullOriginalValueText, getOperator, getOptionCriteria, getOptionDataSource, getOptionDataSourceAsString, getOptionFilterContext, getOptionOperationId, getOptionTextMatchStyle, getOriginalValueMessage, getPageLeft, getPageRect, getPageTop, getPaletteDefaults, getPicker, getPickerIcon, getPickerIcon, getPickerIconHeight, getPickerIconName, getPickerIconPrompt, getPickerIconProperties, getPickerIconSrc, getPickerIconStyle, getPickerIconTabPosition, getPickerIconWidth, getPixelHeight, getPixelWidth, getPrintReadOnlyTextBoxStyle, getPrintTextBoxStyle, getPrintTitleStyle, getReadOnlyCanSelectText, getReadOnlyDisplay, getReadOnlyHover, getReadOnlyTextBoxStyle, getReadOnlyWhen, getRect, getRedrawOnChange, getRejectInvalidValueOnChange, getRequired, getRequiredMessage, getRequiredWhen, getRowSpan, getSaveOnEnter, getScClassName, getSelectedRecord, getSelectOnClick, getSelectOnFocus, getShowClippedTitleOnHover, getShowClippedValueOnHover, getShowDeletions, getShowDisabled, getShowDisabledIconsOnFocus, getShowDisabledPickerIconOnFocus, getShowErrorIcon, getShowErrorStyle, getShowErrorText, getShowFocused, getShowFocusedErrorState, getShowFocusedIcons, getShowFocusedPickerIcon, getShowHint, getShowIcons, getShowIconsOnFocus, getShowImageAsURL, getShowOldValueInHover, getShowOver, getShowOverIcons, getShowPending, getShowPickerIcon, getShowPickerIconOnFocus, getShowRTL, getShowTitle, getShowValueIconOnly, getStartRow, getStaticHeight, getStopOnError, getStoreDisplayValues, getSupportsCutPasteEvents, getSuppressValueIcon, getSynchronousValidation, getTabIndex, getTextAlign, getTextBoxStyle, getTextFormula, getTimeFormatter, getTitle, getTitleAlign, getTitleColSpan, getTitleOrientation, getTitleStyle, getTitleVAlign, getTooltip, getTop, getType, getUpdateControlOnOver, getUpdatePickerIconOnOver, getUpdateTextBoxOnOver, getUseAdvancedCriteria, getUseDisabledHintStyleForReadOnly, getUseLocalDisplayFieldValue, getValidateOnChange, getValidateOnExit, getValidOperators, getVAlign, getValue, getValueAsFloat, getValueAsInteger, getValueAsLong, getValueAsRecordList, getValueDeselectedCSSText, getValueField, getValueFieldName, getValueIconHeight, getValueIconLeftPadding, getValueIconRightPadding, getValueIconSize, getValueIconWidth, getValueMap, getValueMapAsArray, getVisible, getVisibleHeight, getVisibleTitleWidth, getVisibleWhen, getVisibleWidth, getWarnOnEditorTypeConversion, getWarnOnEditorTypeConversionDefault, getWidth, getWidthAsString, getWrapHintText, getWrapTitle, handleWarnOnEditorTypeConversion, hasErrors, hide, hideIcon, invalidateDisplayValueCache, isConfigOnly, isCreated, isCutEvent, isDisabled, isDrawn, isInGrid, isPasteEvent, isVisible, linkToInstanceUponCreate, mapDisplayToValue, mapValueToDisplay, mapValueToDisplay, mapValueToDisplay, redraw, redraw, removeIcon, selectedRecordChanged, setAccessKey, setAlign, setAllowExpressions, setAlwaysFetchMissingValues, setAlwaysShowControlBox, setApplyAlignToText, setApplyHeightToTextBox, setAriaRole, setAriaState, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAutoChildConstructor, setAutoChildProperties, setAutoChildProperties, setAutoChildProperties, setAutoChildVisibility, setAutoComplete, setAutoCompleteKeywords, setBrowserInputType, setBrowserSpellCheck, setCanEdit, setCanEditOpaqueValues, setCanFocus, setCanSelectText, setCanTabToIcons, setCellHeight, setCellStyle, setChangeOnKeypress, setClipStaticValue, setClipTitle, setColSpan, setColSpan, setConfigOnly, setControlStyle, setCriteriaField, setCriterion, setCustomStateGetter, setDataPath, setDateFormatter, setDecimalPad, setDecimalPrecision, setDefaultIconSrc, setDefaultOperator, setDefaultProperties, setDefaultValue, setDefaultValue, setDefaultValue, setDefaultValue, setDefaultValue, setDefaultValue, setDefaultValue, setDisabled, setDisabledHover, setDisableIconsOnReadOnly, setDisplayField, setDisplayFormat, setDisplayFormat, setEditorProperties, setEditorType, setEditorType, setEditorType, setEditorValueFormatter, setEditorValueParser, setEditPendingCSSText, setEditProxyConstructor, setEmptyDisplayValue, setEmptyValueIcon, setEndRow, setErrorFormatter, setErrorIconHeight, setErrorIconSrc, setErrorIconWidth, setErrorMessageWidth, setErrorOrientation, setErrors, setErrors, setEscapeHTML, setExportFormat, setFetchMissingValues, setFilterLocally, setForeignDisplayField, setFormat, setFormula, setGlobalTabIndex, setHidden, setHint, setHintStyle, setHoverAlign, setHoverDelay, setHoverFocusKey, setHoverHeight, setHoverHeight, setHoverOpacity, setHoverPersist, setHoverStyle, setHoverVAlign, setHoverWidth, setHoverWidth, setIconDisabled, setIconHeight, setIconHSpace, setIconPrompt, setIcons, setIconShowOnFocus, setIconVAlign, setIconWidth, setID, setImageURLPrefix, setImageURLSuffix, setImplicitSave, setImplicitSaveOnBlur, setInitHandler, setInputFormat, setInputTransformer, setItemHoverFormatter, setItemTitleHoverFormatter, setItemValueHoverFormatter, setJavaScriptObject, setLeft, setLinearColSpan, setLinearColSpan, setLinearEndRow, setLinearEndRow, setLinearStartRow, setLinearStartRow, setLinearWidth, setLinearWidth, setLoadingDisplayValue, setLocateItemBy, setMinHintWidth, setMultipleValueSeparator, setName, setNullOriginalValueText, setNullProperty, setOperator, setOptionCriteria, setOptionDataSource, setOptionDataSource, setOptionFilterContext, setOptionOperationId, setOptionTextMatchStyle, setOriginalValueMessage, setPickerIconHeight, setPickerIconName, setPickerIconPrompt, setPickerIconProperties, setPickerIconSrc, setPickerIconStyle, setPickerIconWidth, setPrintReadOnlyTextBoxStyle, setPrintTextBoxStyle, setPrintTitleStyle, setProperty, setProperty, setProperty, setProperty, setProperty, setReadOnlyCanSelectText, setReadOnlyDisplay, setReadOnlyHover, setReadOnlyTextBoxStyle, setReadOnlyWhen, setRedrawOnChange, setRejectInvalidValueOnChange, setRequired, setRequiredMessage, setRequiredWhen, setRowSpan, setSaveOnEnter, setScClassName, setSelectOnClick, setSelectOnFocus, setShowClippedTitleOnHover, setShowClippedValueOnHover, setShowDeletions, setShowDisabled, setShowDisabledIconsOnFocus, setShowDisabledPickerIconOnFocus, setShowErrorIcon, setShowErrorStyle, setShowErrorText, setShowFocused, setShowFocusedErrorState, setShowFocusedIcons, setShowFocusedPickerIcon, setShowHint, setShowIcons, setShowIconsOnFocus, setShowIfCondition, setShowImageAsURL, setShowOldValueInHover, setShowOver, setShowOverIcons, setShowPending, setShowPickerIcon, setShowPickerIconOnFocus, setShowRTL, setShowTitle, setShowValueIconOnly, setStartRow, setStateCustomizer, setStaticHeight, setStopOnError, setStoreDisplayValues, setSupportsCutPasteEvents, setSuppressValueIcon, setSynchronousValidation, setTabIndex, setTextAlign, setTextBoxStyle, setTextFormula, setTimeFormatter, setTitle, setTitleAlign, setTitleColSpan, setTitleHoverFormatter, setTitleOrientation, setTitleStyle, setTitleVAlign, setTooltip, setTop, setType, setUpdateControlOnOver, setUpdatePickerIconOnOver, setUpdateTextBoxOnOver, setUseAdvancedCriteria, setUseDisabledHintStyleForReadOnly, setUseLocalDisplayFieldValue, setValidateOnChange, setValidateOnExit, setValidators, setValidOperators, setVAlign, setValue, setValue, setValue, setValue, setValue, setValue, setValueDeselectedCSSText, setValueField, setValueFormatter, setValueHoverFormatter, setValueIconHeight, setValueIconLeftPadding, setValueIconMapper, setValueIconRightPadding, setValueIcons, setValueIconSize, setValueIconWidth, setValueMap, setValueMap, setVisible, setVisibleWhen, setWarnOnEditorTypeConversion, setWarnOnEditorTypeConversionDefault, setWidth, setWidth, setWrapHintText, setWrapTitle, shouldApplyHeightToTextBox, shouldFetchMissingValue, shouldSaveOnEnter, shouldStopKeyPressBubbling, show, showIcon, showPicker, stopHover, storeValue, updateState, validate, valueClipped
getRef, getRef, internalSetID
applyFactoryProperties, doAddHandler, fireEvent, getAttributeAsDoubleArray, getAttributeAsElement, getAttributeAsIntArray, getAttributeAsLong, getAttributeAsMap, getAttributeAsObject, getAttributeAsRecord, getAttributeAsStringArray, getAttributes, getHandlerCount, isFactoryCreated, setAttribute, setAttribute, setAttribute, setAttributeAsJavaObject, setFactoryCreated
public MultiFileItem()
public MultiFileItem(com.google.gwt.core.client.JavaScriptObject jsObj)
public MultiFileItem(java.lang.String name)
public MultiFileItem(java.lang.String name, java.lang.String title)
public static MultiFileItem getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)
public MultiFileItem setEditButtonPrompt(java.lang.String editButtonPrompt)
prompt
of the edit button
.editButtonPrompt
- New editButtonPrompt value. Default value is "Add files"MultiFileItem
instance, for chaining setter callspublic java.lang.String getEditButtonPrompt()
prompt
of the edit button
.public MultiFileItem setEmptyMessage(java.lang.String emptyMessage)
emptyMessage
- New emptyMessage value. Default value is "Click icon to add..."MultiFileItem
instance, for chaining setter callspublic java.lang.String getEmptyMessage()
public MultiFileItem setPickerAddAnotherFileButtonTitle(java.lang.String pickerAddAnotherFileButtonTitle)
edit button
.pickerAddAnotherFileButtonTitle
- New pickerAddAnotherFileButtonTitle value. Default value is "<u>Add another</u>"MultiFileItem
instance, for chaining setter callsHTMLString
public java.lang.String getPickerAddAnotherFileButtonTitle()
edit button
.HTMLString
public MultiFileItem setPickerCancelButtonTitle(java.lang.String pickerCancelButtonTitle)
edit button
.pickerCancelButtonTitle
- New pickerCancelButtonTitle value. Default value is "Cancel"MultiFileItem
instance, for chaining setter callspublic java.lang.String getPickerCancelButtonTitle()
edit button
.public MultiFileItem setPickerConstructor(java.lang.String pickerConstructor)
MultiFilePicker
instance as their picker. The generated
picker
autoChild may be customized via the standard com.smartgwt.client.types.AutoChild
pattern.pickerConstructor
- New pickerConstructor value. Default value is "MultiFilePicker"MultiFileItem
instance, for chaining setter callsSCClassName
public java.lang.String getPickerConstructor()
MultiFilePicker
instance as their picker. The generated
picker
autoChild may be customized via the standard com.smartgwt.client.types.AutoChild
pattern.SCClassName
public MultiFileItem setPickerUploadButtonInitialTitle(java.lang.String pickerUploadButtonInitialTitle)
edit button
that is used before the form is saved.pickerUploadButtonInitialTitle
- New pickerUploadButtonInitialTitle value. Default value is "OK"MultiFileItem
instance, for chaining setter callssetPickerUploadButtonTitle(java.lang.String)
public java.lang.String getPickerUploadButtonInitialTitle()
edit button
that is used before the form is saved.getPickerUploadButtonTitle()
public MultiFileItem setPickerUploadButtonTitle(java.lang.String pickerUploadButtonTitle)
edit button
that is used after the form is saved.pickerUploadButtonTitle
- New pickerUploadButtonTitle value. Default value is "Save"MultiFileItem
instance, for chaining setter callssetPickerUploadButtonInitialTitle(java.lang.String)
public java.lang.String getPickerUploadButtonTitle()
edit button
that is used after the form is saved.getPickerUploadButtonInitialTitle()
public MultiFileItem setPickerUploadProgressLabel(java.lang.String pickerUploadProgressLabel)
edit button
. This property is a dynamic string,
similar to the Canvas.dynamicContents
feature, with the
variables fileName
and formattedFileSize
.pickerUploadProgressLabel
- New pickerUploadProgressLabel value. Default value is "Saving ${fileName} ${formattedFileSize}"MultiFileItem
instance, for chaining setter callsHTMLString
public java.lang.String getPickerUploadProgressLabel()
edit button
. This property is a dynamic string,
similar to the Canvas.dynamicContents
feature, with the
variables fileName
and formattedFileSize
.HTMLString
public MultiFileItem setRemoveButtonPrompt(java.lang.String removeButtonPrompt)
prompt
of the remove button
.removeButtonPrompt
- New removeButtonPrompt value. Default value is "Remove selected files"MultiFileItem
instance, for chaining setter callspublic java.lang.String getRemoveButtonPrompt()
prompt
of the remove button
.