Class FileItem
- All Implemented Interfaces:
HasHandlers,HasBlurHandlers,HasCanEditChangedHandlers,HasChangedHandlers,HasChangeHandlers,HasClickHandlers,HasDoubleClickHandlers,HasEditorEnterHandlers,HasEditorExitHandlers,HasFocusHandlers,HasIconClickHandlers,HasIconKeyPressHandlers,HasItemHoverHandlers,HasKeyDownHandlers,HasKeyPressHandlers,HasKeyUpHandlers,HasPendingStatusChangedHandlers,HasPickerIconClickHandlers,HasReadOnlyDisplayChangedHandlers,HasShowContextMenuHandlers,HasShowValueHandlers,HasTitleClickHandlers,HasTitleDoubleClickHandlers,HasTitleHoverHandlers,HasValueHoverHandlers,HasValueIconClickHandlers
- Direct Known Subclasses:
ViewFileItem
Editable mode
The editForm will be automatically generated and displayed as
this.canvas, allowing the user to select file(s) to
upload.
See the Upload Overview for information on using this control.
Read-only mode
For fields of type "blob" the raw data value will be displayed in the generated
displayForm.
For other fields, the displayCanvas will be displayed.
For
"imageFile" fields with showFileInline set to true, the image-file will be streamed and displayed inline within the displayCanvas.
Otherwise, the displayCanvas will render out View and Download icons and the fileName.
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class com.smartgwt.client.widgets.form.fields.FormItem
FormItem.CustomStateGetter, FormItem.StateCustomizer -
Field Summary
Fields inherited from class com.smartgwt.client.widgets.form.fields.FormItem
configOnly, scClassName, warnOnEditorTypeConversion, warnOnEditorTypeConversionDefaultFields inherited from class com.smartgwt.client.core.RefDataClass
idFields inherited from class com.smartgwt.client.core.DataClass
factoryCreated, factoryProperties -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic voidchangeAutoChildDefaults(String autoChildName, Canvas defaults) Changes the defaults for Canvas AutoChildren namedautoChildName.static voidchangeAutoChildDefaults(String autoChildName, FormItem defaults) Changes the defaults for FormItem AutoChildren namedautoChildName.static voidchangePickerIconDefaults(FormItemIcon defaults) A comma-separated list of valid MIME types, used as a filter for the file picker window.This attribute enables camera capture functionality for mobile devices, accepting the following values: Set it to "user" to capture using the front-facing camera. Set it to "environment" to capture using the rear-facing camera.TheDynamicFormcreated automatically whencanEditis false and the field is of type "blob".TheStaticTextItemcreated automatically and displayed in thedisplayFormwhencanEditis false and the field type is "blob".Returns the URL for an Icon that will allow the file to be downloadedTheDynamicFormcreated automatically whencanEditis true.Default class used to construct theEditProxyfor this component when the component isfirst placed into edit mode.When true, allow the file-selection dialog shelled by the browser to select multiple files.static FileItemgetOrCreateRef(JavaScriptObject jsObj) Should this item's value be saved in the form's values and hence returned fromform.getValues()?Indicates whether to stream the image and display it inline or to display the View and Download icons.Returns the URL for an Icon that will allow the file to be viewed.A comma-separated list of valid MIME types, used as a filter for the file picker window.setCapture(String capture) This attribute enables camera capture functionality for mobile devices, accepting the following values: Set it to "user" to capture using the front-facing camera. Set it to "environment" to capture using the rear-facing camera.static voidsetDefaultProperties(FileItem fileItemProperties) Class level method to set the default properties of this class.setDownloadIconSrc(String downloadIconSrc) Returns the URL for an Icon that will allow the file to be downloadedsetEditProxyConstructor(String editProxyConstructor) Default class used to construct theEditProxyfor this component when the component isfirst placed into edit mode.setMultiple(Boolean multiple) When true, allow the file-selection dialog shelled by the browser to select multiple files.setShouldSaveValue(Boolean shouldSaveValue) Should this item's value be saved in the form's values and hence returned fromform.getValues()?setShowFileInline(Boolean showFileInline) Indicates whether to stream the image and display it inline or to display the View and Download icons.setViewIconSrc(String viewIconSrc) Returns the URL for an Icon that will allow the file to be viewed.Methods inherited from class com.smartgwt.client.widgets.form.fields.CanvasItem
addCanEditChangedHandler, addReadOnlyDisplayChangedHandler, addShowValueHandler, createCanvas, getApplyPromptToCanvas, getAutoDestroy, getCanvas, getEditCriteriaInInnerForm, getHeight, getHeightAsString, getMaxHeight, getMinHeight, getOverflow, getPrompt, hasAdvancedCriteria, isFocused, setApplyPromptToCanvas, setAutoDestroy, setCanEditCriterionPredicate, setCanvas, setCriterionGetter, setCriterionSetter, setDefaultProperties, setEditCriteriaInInnerForm, setHeight, setHeight, setMaxHeight, setMinHeight, setOverflow, setPrompt, setShouldDisableCanvasCustomizer, setupCanvasConstructor, storeValue, storeValue, storeValue, updateCanvasTabPositionMethods inherited from class com.smartgwt.client.widgets.form.fields.FormItem
_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, checkFormItemType, 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, getCanHover, getCanSelectText, getCanTabToIcons, getCanvasAutoChild, getCellHeight, getCellStyle, getChangeOnKeypress, getClassName, getClipStaticValue, getClipTitle, getConfig, getContainerWidget, getControlStyle, getCriteriaField, getCriterion, getCriterion, getCursorPosition, getCustomState, getDataPath, getDateFormatter, getDecimalPad, getDecimalPrecision, getDefaultIconSrc, getDefaultOperator, getDefaultValue, getDestroyed, getDisabled, getDisabledHover, getDisableIconsOnReadOnly, getDisplayField, getDisplayFieldName, getDisplayValue, getDisplayValue, getEditorTypeConfig, getEditPendingCSSText, getEmptyDisplayValue, getEmptyValueIcon, getEndRow, getErrorIconHeight, getErrorIconProperties, 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, getIconBaseStyle, 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, getReadOnlyControlStyle, getReadOnlyDisplay, getReadOnlyHover, getReadOnlyTextBoxStyle, getReadOnlyWhen, getRect, getRedrawOnChange, getRejectInvalidValueOnChange, getRequired, getRequiredMessage, getRequiredWhen, getRowSpan, getSaveOnEnter, getScClassName, getSelectedRecord, getSelectOnClick, getSelectOnFocus, getShowClippedTitleOnHover, getShowClippedValueOnHover, getShowDeletions, getShowDisabled, getShowDisabledIconsOnFocus, getShowDisabledPickerIconOnFocus, getShowErrorIcon, getShowErrorIconInline, 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, getWrapStaticValue, getWrapTitle, handleWarnOnEditorTypeConversion, hasErrors, hide, hideIcon, invalidateDisplayValueCache, isAssignableFrom, 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, setCanHover, 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, setEmptyDisplayValue, setEmptyValueIcon, setEndRow, setErrorFormatter, setErrorIconHeight, setErrorIconProperties, 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, setIconBaseStyle, 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, setReadOnlyControlStyle, setReadOnlyDisplay, setReadOnlyHover, setReadOnlyTextBoxStyle, setReadOnlyWhen, setRedrawOnChange, setRejectInvalidValueOnChange, setRequired, setRequiredMessage, setRequiredWhen, setRowSpan, setSaveOnEnter, setScClassName, setSelectOnClick, setSelectOnFocus, setShowClippedTitleOnHover, setShowClippedValueOnHover, setShowDeletions, setShowDisabled, setShowDisabledIconsOnFocus, setShowDisabledPickerIconOnFocus, setShowErrorIcon, setShowErrorIconInline, 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, setUseObjectFactoryForTypeFallback, 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, setWrapStaticValue, setWrapTitle, shouldApplyHeightToTextBox, shouldFetchMissingValue, shouldSaveOnEnter, shouldStopKeyPressBubbling, show, showIcon, showPicker, stopHover, storeValue, updateState, validate, valueClippedMethods inherited from class com.smartgwt.client.data.Field
getCanExport, getExportTitle, getPrimaryKey, getSortByField, setCanExport, setExportTitle, setPrimaryKey, setSortByFieldMethods inherited from class com.smartgwt.client.core.RefDataClass
getRef, getRef, internalSetIDMethods inherited from class com.smartgwt.client.core.DataClass
applyFactoryProperties, doAddHandler, fireEvent, getAttributeAsDoubleArray, getAttributeAsElement, getAttributeAsIntArray, getAttributeAsLong, getAttributeAsMap, getAttributeAsObject, getAttributeAsRecord, getAttributeAsStringArray, getAttributes, getHandlerCount, isFactoryCreated, setAttribute, setAttribute, setAttribute, setAttributeAsJavaObject, setFactoryCreatedMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface com.google.gwt.event.shared.HasHandlers
fireEvent
-
Constructor Details
-
FileItem
public FileItem() -
FileItem
-
FileItem
-
FileItem
-
-
Method Details
-
getOrCreateRef
-
changeAutoChildDefaults
Changes the defaults for Canvas AutoChildren namedautoChildName.- Parameters:
autoChildName- name of an AutoChild to customize the defaults for.defaults- Canvas defaults to apply. These defaults override any existing properties without destroying or wiping out non-overridden properties. For usage tips on this param, seeSGWTProperties.- See Also:
-
changeAutoChildDefaults
Changes the defaults for FormItem AutoChildren namedautoChildName.- Parameters:
autoChildName- name of an AutoChild to customize the defaults for.defaults- FormItem defaults to apply. These defaults override any existing properties without destroying or wiping out non-overridden properties. For usage tips on this param, seeSGWTProperties.- See Also:
-
changePickerIconDefaults
-
setAccept
A comma-separated list of valid MIME types, used as a filter for the file picker window.Note that this property makes use of the HTML
acceptattribute, and so relies on the browser to perform the desired filtering. For further study, see:- Parameters:
accept- New accept value. Default value is null- Returns:
FileIteminstance, for chaining setter calls
-
getAccept
A comma-separated list of valid MIME types, used as a filter for the file picker window.Note that this property makes use of the HTML
acceptattribute, and so relies on the browser to perform the desired filtering. For further study, see:- Returns:
- Current accept value. Default value is null
-
setCapture
This attribute enables camera capture functionality for mobile devices, accepting the following values:- Set it to "user" to capture using the front-facing camera.
- Set it to "environment" to capture using the rear-facing camera.
Please note that in the latest versions of Android and iOS, utilizing this attribute will consistently load the rear camera. This behavior is due to the direct camera software's ability to switch between the two cameras seamlessly.
When working with the capture functionality of iPhones and Android devices, it's important to consider the supported DataSourceField.mimeTypes for audio, video, and image files that can be used with the fileItem.accept attribute. Here's a list of commonly supported mime types for capturing on these devices:
Supported Image Mime Types:
- image/jpeg: JPEG image format (.jpg, .jpeg)
- image/png: Portable Network Graphics format (.png)
- audio/3gpp: 3GPP format, commonly used for audio capture.
- audio/mp4: MP4 format, widely supported for audio capture.
- video/3gpp: 3GPP format, commonly used for video capture.
- video/mp4: MP4 format, widely supported for video capture.
The behavior of using the capture attribute depends on the value used in the accept attribute. For example:
- accept="image/*" will load the camera ready to take pictures.
- accept="audio/*" will load the default audio recorder, not the camera.
- accept="video/*" will load the camera in video mode, ready to capture videos.
Lastly, keep in mind that these settings have no effect on desktop browsers; they apply exclusively to mobile devices.
This information is "circa 2023" and may not apply to all devices.
- Parameters:
capture- New capture value. Default value is null- Returns:
FileIteminstance, for chaining setter calls
-
getCapture
This attribute enables camera capture functionality for mobile devices, accepting the following values:- Set it to "user" to capture using the front-facing camera.
- Set it to "environment" to capture using the rear-facing camera.
Please note that in the latest versions of Android and iOS, utilizing this attribute will consistently load the rear camera. This behavior is due to the direct camera software's ability to switch between the two cameras seamlessly.
When working with the capture functionality of iPhones and Android devices, it's important to consider the supported DataSourceField.mimeTypes for audio, video, and image files that can be used with the fileItem.accept attribute. Here's a list of commonly supported mime types for capturing on these devices:
Supported Image Mime Types:
- image/jpeg: JPEG image format (.jpg, .jpeg)
- image/png: Portable Network Graphics format (.png)
- audio/3gpp: 3GPP format, commonly used for audio capture.
- audio/mp4: MP4 format, widely supported for audio capture.
- video/3gpp: 3GPP format, commonly used for video capture.
- video/mp4: MP4 format, widely supported for video capture.
The behavior of using the capture attribute depends on the value used in the accept attribute. For example:
- accept="image/*" will load the camera ready to take pictures.
- accept="audio/*" will load the default audio recorder, not the camera.
- accept="video/*" will load the camera in video mode, ready to capture videos.
Lastly, keep in mind that these settings have no effect on desktop browsers; they apply exclusively to mobile devices.
This information is "circa 2023" and may not apply to all devices.
- Returns:
- Current capture value. Default value is null
-
getDisplayCanvas
TheCanvascreated automatically whencanEditis false and the field is of any type other than "blob".If the field is of type "imageFile", and
showFileInlineis true, the contents of the canvas are set to HTML that streams the image file for display. Otherwise, the item renders icons that allow the file to beviewedordownloaded.This component is an
com.smartgwt.client.types.AutoChildand as such may be customized viafileItem.displayCanvasDefaultsandfileItem.displayCanvasProperties.This component is an AutoChild named "displayCanvas". For an overview of how to use and configure AutoChildren, see
Using AutoChildren.- Returns:
- Current displayCanvas value. Default value is null
- See Also:
-
getDisplayForm
TheDynamicFormcreated automatically whencanEditis false and the field is of type "blob". Displays a singleitemfor viewing the content of a blob file.This component is an
com.smartgwt.client.types.AutoChildand as such may be customized viafileItem.displayFormDefaultsandfileItem.displayFormProperties.This component is an AutoChild named "displayForm". For an overview of how to use and configure AutoChildren, see
Using AutoChildren.- Returns:
- Current displayForm value. Default value is null
- See Also:
-
getDisplayItem
TheStaticTextItemcreated automatically and displayed in thedisplayFormwhencanEditis false and the field type is "blob".This component is an
com.smartgwt.client.types.AutoChildand as such may be customized viafileItem.displayItemDefaultsandfileItem.displayItemProperties.This component is an AutoChild named "displayItem". For an overview of how to use and configure AutoChildren, see
Using AutoChildren.- Returns:
- Current displayItem value. Default value is null
- See Also:
-
setDownloadIconSrc
Returns the URL for an Icon that will allow the file to be downloaded- Parameters:
downloadIconSrc- New downloadIconSrc value. Default value is "[SKIN]actions/download.png"- Returns:
FileIteminstance, for chaining setter calls- See Also:
-
getDownloadIconSrc
Returns the URL for an Icon that will allow the file to be downloaded- Returns:
- Current downloadIconSrc value. Default value is "[SKIN]actions/download.png"
- See Also:
-
getEditForm
TheDynamicFormcreated automatically whencanEditis true. Displays a singleitemfor manipulating a file.This component is an
com.smartgwt.client.types.AutoChildand as such may be customized viafileItem.editFormDefaultsandfileItem.editFormProperties.This component is an AutoChild named "editForm". For an overview of how to use and configure AutoChildren, see
Using AutoChildren.- Returns:
- Current editForm value. Default value is null
- See Also:
-
setEditProxyConstructor
Default class used to construct theEditProxyfor this component when the component isfirst placed into edit mode.- Overrides:
setEditProxyConstructorin classFormItem- Parameters:
editProxyConstructor- New editProxyConstructor value. Default value is "FileItemEditProxy"- Returns:
FileIteminstance, for chaining setter calls- See Also:
-
getEditProxyConstructor
Default class used to construct theEditProxyfor this component when the component isfirst placed into edit mode.- Overrides:
getEditProxyConstructorin classFormItem- Returns:
- Current editProxyConstructor value. Default value is "FileItemEditProxy"
- See Also:
-
setMultiple
When true, allow the file-selection dialog shelled by the browser to select multiple files.Support is not full-cycle at the server - that is, there are server APIs for retrieving each file that was uploaded, but no built-in support for storing multiple files against a single DataSource field. However, you can write custom server DMI code to do something with the files - for instance, you could create multiple new DataSource records for each file via a server DMI like this below:
String fileNameStr = (String)dsRequest.getValues().get("image_filename").toString(); String[] fileNames = fileNameStr.split(", "); List files = dsRequest.getUploadedFiles(); for (int i = 0; i < files.size(); i++) { ISCFileItem file = (ISCFileItem)files.get(i); InputStream fileData = file.getInputStream(); DSRequest inner = new DSRequest("mediaLibrary", "add"); Map values = new HashMap(); values.put("title", dsRequest.getValues().get("title")); values.put("image", fileData); values.put("image_filename", fileNames[i]); values.put("image_filesize", file.getSize()); values.put("image_date_created", new Date()); inner.setValues(values); inner.execute(); } DSResponse dsResponse = new DSResponse(); dsResponse.setStatus(0); return dsResponse;
If this method is called after the component has been drawn/initialized: Updates themultiplesetting at runtime, propagating it to the Browser's file dialog. Causes a redraw.- Overrides:
setMultiplein classCanvasItem- Parameters:
multiple- the HTML of the view link. Default value is true- Returns:
FileIteminstance, for chaining setter calls- See Also:
-
getMultiple
When true, allow the file-selection dialog shelled by the browser to select multiple files.Support is not full-cycle at the server - that is, there are server APIs for retrieving each file that was uploaded, but no built-in support for storing multiple files against a single DataSource field. However, you can write custom server DMI code to do something with the files - for instance, you could create multiple new DataSource records for each file via a server DMI like this below:
String fileNameStr = (String)dsRequest.getValues().get("image_filename").toString(); String[] fileNames = fileNameStr.split(", "); List files = dsRequest.getUploadedFiles(); for (int i = 0; i < files.size(); i++) { ISCFileItem file = (ISCFileItem)files.get(i); InputStream fileData = file.getInputStream(); DSRequest inner = new DSRequest("mediaLibrary", "add"); Map values = new HashMap(); values.put("title", dsRequest.getValues().get("title")); values.put("image", fileData); values.put("image_filename", fileNames[i]); values.put("image_filesize", file.getSize()); values.put("image_date_created", new Date()); inner.setValues(values); inner.execute(); } DSResponse dsResponse = new DSResponse(); dsResponse.setStatus(0); return dsResponse;- Overrides:
getMultiplein classCanvasItem- Returns:
- Current multiple value. Default value is true
- See Also:
-
setShouldSaveValue
Should this item's value be saved in the form's values and hence returned fromform.getValues()?shouldSaveValue:falseis used to mark formItems which do not correspond to the underlying data model and should not save a value into the form'svalues. Example includes visual separators, password re-type fields, or checkboxes used to show/hide other form items.A
shouldSaveValue:falseitem should be given a value either viaFormItem.defaultValueor by callingform.setValue(item, value)orformItem.setValue(value). Providing a value viaform.valuesorform.setValues()will automatically switch the item toshouldSaveValue:true.Note that
- if an item is shouldSaveValue true, but has no name, a warning is logged, and shouldSaveValue will be set to false.
- Overrides:
setShouldSaveValuein classCanvasItem- Parameters:
shouldSaveValue- New shouldSaveValue value. Default value is true- Returns:
FileIteminstance, for chaining setter calls
-
getShouldSaveValue
Should this item's value be saved in the form's values and hence returned fromform.getValues()?shouldSaveValue:falseis used to mark formItems which do not correspond to the underlying data model and should not save a value into the form'svalues. Example includes visual separators, password re-type fields, or checkboxes used to show/hide other form items.A
shouldSaveValue:falseitem should be given a value either viaFormItem.defaultValueor by callingform.setValue(item, value)orformItem.setValue(value). Providing a value viaform.valuesorform.setValues()will automatically switch the item toshouldSaveValue:true.Note that
- if an item is shouldSaveValue true, but has no name, a warning is logged, and shouldSaveValue will be set to false.
- Overrides:
getShouldSaveValuein classCanvasItem- Returns:
- Current shouldSaveValue value. Default value is true
-
setShowFileInline
Indicates whether to stream the image and display it inline or to display the View and Download icons.- Parameters:
showFileInline- New showFileInline value. Default value is null- Returns:
FileIteminstance, for chaining setter calls
-
getShowFileInline
Indicates whether to stream the image and display it inline or to display the View and Download icons.- Returns:
- Current showFileInline value. Default value is null
-
getUploadItem
TheUploadItemcreated automatically and displayed in theeditFormwhencanEditis true.This component is an
com.smartgwt.client.types.AutoChildand as such may be customized viafileItem.uploadItemDefaultsandfileItem.uploadItemProperties.This component is an AutoChild named "uploadItem". For an overview of how to use and configure AutoChildren, see
Using AutoChildren.- Returns:
- Current uploadItem value. Default value is null
- See Also:
-
setViewIconSrc
Returns the URL for an Icon that will allow the file to be viewed.- Parameters:
viewIconSrc- New viewIconSrc value. Default value is "[SKIN]actions/view.png"- Returns:
FileIteminstance, for chaining setter calls- See Also:
-
getViewIconSrc
Returns the URL for an Icon that will allow the file to be viewed.- Returns:
- Current viewIconSrc value. Default value is "[SKIN]actions/view.png"
- See Also:
-
setDefaultProperties
Class level method to set the default properties of this class. If set, then all existing and subsequently created instances of this class will automatically have default properties corresponding to the properties of the class instance passed to this function. This is a powerful feature that eliminates the need for users to create a separate hierarchy of subclasses that only alter the default properties of this class. Can also be used for skinning / styling purposes.Note: This method is intended for setting default attributes only and will affect all instances of the underlying class (including those automatically generated in JavaScript). This method should not be used to apply standard EventHandlers or override methods for a class - use a custom subclass instead. Calling this method after instances have been created can result in undefined behavior, since it bypasses any setters and a class instance may have already examined a particular property and not be expecting any changes through this route.
- Parameters:
fileItemProperties- properties that should be used as new defaults when instances of this class are created- See Also:
-