public class HiddenItem extends FormItem
When using
Smart GWT databinding it is usually not necessary to use a HiddenItem, since the DynamicForm will track values for which
no actual form control exists, and will submit these 'extra' values when DynamicForm.saveData() is called. HiddenItems only apply to
forms that are submitted like ordinary HTML forms, via the DynamicForm.submitForm() method.
FormItem.CustomStateGetter, FormItem.StateCustomizerscClassName, warnOnEditorTypeConversion, warnOnEditorTypeConversionDefaultidfactoryCreated, factoryProperties, readOnly| Constructor and Description |
|---|
HiddenItem() |
HiddenItem(com.google.gwt.core.client.JavaScriptObject jsObj) |
HiddenItem(java.lang.String name) |
| Modifier and Type | Method and Description |
|---|---|
static void |
changeAutoChildDefaults(java.lang.String autoChildName,
Canvas defaults)
Changes the defaults for Canvas AutoChildren named
autoChildName. |
static void |
changeAutoChildDefaults(java.lang.String autoChildName,
DrawItem defaults)
Changes the defaults for DrawItem AutoChildren named
autoChildName. |
static void |
changeAutoChildDefaults(java.lang.String autoChildName,
FormItem defaults)
Changes the defaults for FormItem AutoChildren named
autoChildName. |
static void |
changePickerIconDefaults(FormItemIcon defaults) |
java.lang.Boolean |
getAlwaysFetchMissingValues()
If this form item has a specified
FormItem.optionDataSource and FormItem.fetchMissingValues is true, when the item value changes, a fetch will be performed against the
optionDataSource to retrieve the related record if FormItem.displayField is specified and the new item
value is not present in any valueMap explicitly specified on the item. |
int |
getColSpan()
hidden fields don't take up any columns
|
java.lang.Boolean |
getFetchMissingValues()
If this form item has a specified
FormItem.optionDataSource, should the item ever perform a fetch against this dataSource to retrieve the related record. |
static HiddenItem |
getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj) |
int |
getRowSpan()
hidden fields don't take up any rows
|
java.lang.Boolean |
getShowTitle()
we never show a separate title cell for hidden fields
|
void |
setAlwaysFetchMissingValues(java.lang.Boolean alwaysFetchMissingValues)
If this form item has a specified
FormItem.optionDataSource and FormItem.fetchMissingValues is true, when the item value changes, a fetch will be performed against the
optionDataSource to retrieve the related record if FormItem.displayField is specified and the new item
value is not present in any valueMap explicitly specified on the item. |
void |
setColSpan(int colSpan)
hidden fields don't take up any columns
|
static void |
setDefaultProperties(HiddenItem hiddenItemProperties)
Class level method to set the default properties of this class.
|
void |
setFetchMissingValues(java.lang.Boolean fetchMissingValues)
If this form item has a specified
FormItem.optionDataSource, should the item ever perform a fetch against this dataSource to retrieve the related record. |
void |
setRowSpan(int rowSpan)
hidden fields don't take up any rows
|
void |
setShowTitle(java.lang.Boolean showTitle)
we never show a separate title cell for hidden fields
|
_getValue, addBlurHandler, addChangedHandler, addChangeHandler, addClickHandler, addDoubleClickHandler, addEditorEnterHandler, addEditorExitHandler, addFocusHandler, addIconClickHandler, addIconKeyPressHandler, addItemHoverHandler, addKeyDownHandler, addKeyPressHandler, addKeyUpHandler, addPendingStatusChangedHandler, addPickerIconClickHandler, addTitleClickHandler, addTitleDoubleClickHandler, addTitleHoverHandler, addValueHoverHandler, addValueIconClickHandler, asSGWTComponent, blurItem, canEditCriterion, clearErrors, clearValue, disable, disableIcon, enable, enableIcon, error, error, errorIfNotCreated, focusInItem, getAccessKey, getAlign, getAllowExpressions, getApplyAlignToText, getApplyHeightToTextBox, getAriaRole, getAttribute, getAttributeAsBoolean, getAttributeAsBoolean, getAttributeAsDate, getAttributeAsDouble, getAttributeAsFloat, getAttributeAsInt, getAttributeAsJavaScriptObject, getAttributeAsObject, getAttributeAsString, getAutoComplete, getBrowserInputType, getBrowserSpellCheck, getCanEdit, getCanEditOpaqueValues, getCanFocus, getCanSelectText, getCanvasAutoChild, getCellHeight, getCellStyle, getChangeOnKeypress, getClassName, getClipStaticValue, getClipTitle, getConfig, getContainerWidget, getControlStyle, getCriteriaField, getCriterion, getCriterion, getCursorPosition, getCustomState, getDataPath, getDateFormatter, getDecimalPad, getDecimalPrecision, getDefaultIconSrc, getDisabled, getDisableIconsOnReadOnly, getDisplayField, getDisplayFieldName, getDisplayValue, getDisplayValue, getEditorTypeConfig, getEditPendingCSSText, getEditProxyConstructor, getEmptyDisplayValue, getEmptyValueIcon, getEndRow, getErrorIconHeight, getErrorIconSrc, getErrorIconWidth, getErrorMessageWidth, getErrors, getExportFormat, getFieldName, getFilterLocally, getForeignDisplayField, getForm, getFormat, getFormItemAutoChild, getFullDataPath, getGlobalTabIndex, getGridColNum, getGridRowNum, getHeight, getHeightAsString, getHidden, getHint, getHintStyle, getHoverAlign, getHoverDelay, getHoverHeight, getHoverOpacity, getHoverStyle, getHoverVAlign, getHoverWidth, getIcon, getIconHeight, getIconHSpace, getIconPageRect, getIconPrompt, getIconRect, getIconVAlign, getIconWidth, getImageURLPrefix, getImageURLSuffix, getImplicitSave, getImplicitSaveOnBlur, getInputFormat, getLeft, getLoadingDisplayValue, getLocateItemBy, getMultipleValueSeparator, getName, getOperator, getOptionCriteria, getOptionFilterContext, getOptionOperationId, getOriginalValueMessage, getPageLeft, getPageRect, getPageTop, getPicker, getPickerIconHeight, getPickerIconName, getPickerIconPrompt, getPickerIconProperties, getPickerIconSrc, getPickerIconStyle, getPickerIconWidth, getPixelHeight, getPixelWidth, getPrintTextBoxStyle, getPrintTitleStyle, getPrompt, getReadOnlyDisplay, getReadOnlyHover, getReadOnlyTextBoxStyle, getRect, getRedrawOnChange, getRejectInvalidValueOnChange, getRequired, getRequiredMessage, getSaveOnEnter, getScClassName, getSelectedRecord, getSelectOnClick, getSelectOnFocus, getShouldSaveValue, getShowClippedTitleOnHover, getShowClippedValueOnHover, getShowDeletions, getShowDisabled, getShowErrorIcon, getShowErrorStyle, getShowErrorText, getShowFocused, getShowFocusedErrorState, getShowFocusedIcons, getShowFocusedPickerIcon, getShowHint, getShowIcons, getShowOldValueInHover, getShowOverIcons, getShowPending, getShowPickerIcon, getShowRTL, getShowValueIconOnly, getStartRow, getStaticHeight, getStopOnError, getSupportsCutPasteEvents, getSuppressValueIcon, getSynchronousValidation, getTabIndex, getTextAlign, getTextBoxStyle, getTimeFormatter, getTitle, getTitleAlign, getTitleColSpan, getTitleOrientation, getTitleStyle, getTitleVAlign, getTooltip, getTop, getType, getUseDisabledHintStyleForReadOnly, getValidateOnChange, getValidateOnExit, getValidOperators, getVAlign, getValue, getValueAsRecordList, getValueDeselectedCSSText, getValueField, getValueFieldName, getValueIconHeight, getValueIconLeftPadding, getValueIconRightPadding, getValueIconSize, getValueIconWidth, getVisible, getVisibleHeight, getVisibleTitleWidth, getVisibleWidth, getWarnOnEditorTypeConversion, getWarnOnEditorTypeConversionDefault, getWidth, getWidthAsString, getWrapTitle, handleWarnOnEditorTypeConversion, hasAdvancedCriteria, hasErrors, hide, hideIcon, invalidateDisplayValueCache, isCreated, isCutEvent, isDisabled, isDrawn, isFocused, isInGrid, isPasteEvent, isVisible, linkToInstanceUponCreate, mapDisplayToValue, mapValueToDisplay, mapValueToDisplay, mapValueToDisplay, redraw, redraw, setAccessKey, setAlign, setAllowExpressions, 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, setBrowserInputType, setBrowserSpellCheck, setCanEdit, setCanEditCriterionPredicate, setCanEditOpaqueValues, setCanFocus, setCanSelectText, setCellHeight, setCellStyle, setChangeOnKeypress, setClipStaticValue, setClipTitle, setColSpan, setControlStyle, setCriteriaField, setCriterion, setCriterionGetter, setCriterionSetter, setCustomStateGetter, setDataPath, setDateFormatter, setDecimalPad, setDecimalPrecision, setDefaultIconSrc, setDefaultProperties, setDefaultValue, setDefaultValue, setDefaultValue, setDefaultValue, setDefaultValue, setDefaultValue, setDefaultValue, setDisabled, setDisableIconsOnReadOnly, setDisplayField, setDisplayFormat, setDisplayFormat, setEditorProperties, setEditorType, setEditorType, setEditorType, setEditorValueFormatter, setEditorValueParser, setEditPendingCSSText, setEditProxyConstructor, setEmptyDisplayValue, setEmptyValueIcon, setEndRow, setErrorFormatter, setErrorIconHeight, setErrorIconSrc, setErrorIconWidth, setErrorMessageWidth, setErrorOrientation, setErrors, setErrors, setExportFormat, setFilterLocally, setForeignDisplayField, setFormat, setGlobalTabIndex, setHeight, setHeight, setHidden, setHint, setHintStyle, setHoverAlign, setHoverDelay, setHoverHeight, setHoverOpacity, setHoverStyle, setHoverVAlign, setHoverWidth, setIconDisabled, setIconHeight, setIconHSpace, setIconPrompt, setIcons, setIconVAlign, setIconWidth, setImageURLPrefix, setImageURLSuffix, setImplicitSave, setImplicitSaveOnBlur, setInitHandler, setInputFormat, setInputTransformer, setItemHoverFormatter, setItemTitleHoverFormatter, setItemValueHoverFormatter, setJavaScriptObject, setLeft, setLoadingDisplayValue, setLocateItemBy, setMultipleValueSeparator, setName, setNullProperty, setOperator, setOptionCriteria, setOptionDataSource, setOptionFilterContext, setOptionOperationId, setOriginalValueMessage, setPickerIconHeight, setPickerIconName, setPickerIconPrompt, setPickerIconProperties, setPickerIconSrc, setPickerIconStyle, setPickerIconWidth, setPrintTextBoxStyle, setPrintTitleStyle, setPrompt, setProperty, setProperty, setProperty, setProperty, setProperty, setReadOnlyDisplay, setReadOnlyHover, setReadOnlyTextBoxStyle, setRedrawOnChange, setRejectInvalidValueOnChange, setRequired, setRequiredMessage, setSaveOnEnter, setScClassName, setSelectOnClick, setSelectOnFocus, setShouldSaveValue, setShowClippedTitleOnHover, setShowClippedValueOnHover, setShowDeletions, setShowDisabled, setShowErrorIcon, setShowErrorStyle, setShowErrorText, setShowFocused, setShowFocusedErrorState, setShowFocusedIcons, setShowFocusedPickerIcon, setShowHint, setShowIcons, setShowIfCondition, setShowOldValueInHover, setShowOverIcons, setShowPending, setShowPickerIcon, setShowRTL, setShowValueIconOnly, setStartRow, setStateCustomizer, setStaticHeight, setStopOnError, setSupportsCutPasteEvents, setSuppressValueIcon, setSynchronousValidation, setTabIndex, setTextAlign, setTextBoxStyle, setTimeFormatter, setTitle, setTitleAlign, setTitleColSpan, setTitleHoverFormatter, setTitleOrientation, setTitleStyle, setTitleVAlign, setTooltip, setTop, setType, setUseDisabledHintStyleForReadOnly, 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, setWarnOnEditorTypeConversion, setWarnOnEditorTypeConversionDefault, setWidth, setWidth, setWrapTitle, shouldApplyHeightToTextBox, shouldFetchMissingValue, shouldSaveOnEnter, shouldStopKeyPressBubbling, show, showIcon, showPicker, stopHover, storeValue, storeValue, updateState, validate, valueClippedgetRef, getRef, internalSetIDapplyFactoryProperties, doAddHandler, fireEvent, getAttributeAsDoubleArray, getAttributeAsIntArray, getAttributeAsLong, getAttributeAsMap, getAttributeAsObject, getAttributeAsRecord, getAttributeAsStringArray, getAttributes, getHandlerCount, getReadOnly, isFactoryCreated, logConfiguration, setAttribute, setAttribute, setAttribute, setAttributeAsJavaObject, setFactoryCreated, setReadOnlypublic HiddenItem()
public HiddenItem(com.google.gwt.core.client.JavaScriptObject jsObj)
public HiddenItem(java.lang.String name)
public static HiddenItem getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)
public static void changeAutoChildDefaults(java.lang.String autoChildName,
Canvas defaults)
autoChildName.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, see SGWTProperties.AutoChildUsagepublic static void changeAutoChildDefaults(java.lang.String autoChildName,
FormItem defaults)
autoChildName.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, see SGWTProperties.AutoChildUsagepublic static void changeAutoChildDefaults(java.lang.String autoChildName,
DrawItem defaults)
autoChildName.autoChildName - name of an AutoChild to customize the defaults for.defaults - DrawItem defaults to apply. These defaults override any existing properties
without destroying or wiping out non-overridden properties. For usage tips on this
param, see SGWTProperties.AutoChildUsagepublic static void changePickerIconDefaults(FormItemIcon defaults)
public void setAlwaysFetchMissingValues(java.lang.Boolean alwaysFetchMissingValues)
FormItem.optionDataSource and FormItem.fetchMissingValues is true, when the item value changes, a fetch will be performed against the
optionDataSource to retrieve the related record if FormItem.displayField is specified and the new item
value is not present in any valueMap explicitly specified on the item. Setting this property to true means that a
fetch will occur against the optionDataSource to retrieve the related record even if FormItem.displayField is unset, or the item has a
valueMap which explicitly contains this field's value.
An example of a use case where this might be set would be if
FormItem.formatValue() or FormItem.formatEditorValue() were written to display
properties from the selected record.
Note
- for efficiency we cache the associated record once a fetch has been performed, meaning if the value changes, then
reverts to a previously seen value, we do not kick off an additional fetch even if this property is true. If necessary
this cache may be explicitly invalidated via a call to FormItem.invalidateDisplayValueCache()
Note: For hiddenItem fetchMissingValues
is defaulted to false so developers wishing to get access to the record related to the current hiddenItem
value would need to explicitly set both that property, and this one to true.
Note : This is an advanced setting
setAlwaysFetchMissingValues in class FormItemalwaysFetchMissingValues - Default value is falsepublic java.lang.Boolean getAlwaysFetchMissingValues()
FormItem.optionDataSource and FormItem.fetchMissingValues is true, when the item value changes, a fetch will be performed against the
optionDataSource to retrieve the related record if FormItem.displayField is specified and the new item
value is not present in any valueMap explicitly specified on the item. Setting this property to true means that a
fetch will occur against the optionDataSource to retrieve the related record even if FormItem.displayField is unset, or the item has a
valueMap which explicitly contains this field's value.
An example of a use case where this might be set would be if
FormItem.formatValue() or FormItem.formatEditorValue() were written to display
properties from the selected record.
Note
- for efficiency we cache the associated record once a fetch has been performed, meaning if the value changes, then
reverts to a previously seen value, we do not kick off an additional fetch even if this property is true. If necessary
this cache may be explicitly invalidated via a call to FormItem.invalidateDisplayValueCache()
Note: For hiddenItem fetchMissingValues
is defaulted to false so developers wishing to get access to the record related to the current hiddenItem
value would need to explicitly set both that property, and this one to true.
getAlwaysFetchMissingValues in class FormItempublic void setColSpan(int colSpan)
setColSpan in class FormItemcolSpan - Default value is 0Appearance overview and related methodspublic int getColSpan()
Appearance overview and related methodspublic void setFetchMissingValues(java.lang.Boolean fetchMissingValues)
FormItem.optionDataSource, should the item ever perform a fetch against this dataSource to retrieve the related record.
This is disabled by default for hiddenItems as there is typically no need to perform a fetch and retrieve a
display-field value to show the user for a hidden item. This does mean that if a developer needs access to the related
record for a hidden-item's value, they will need to enable both this setting and FormItem.alwaysFetchMissingValues.
Note : This is an advanced setting
setFetchMissingValues in class FormItemfetchMissingValues - Default value is trueFormItem.setOptionDataSource(com.smartgwt.client.data.DataSource),
FormItem.getSelectedRecord(),
FormItem.setFilterLocally(java.lang.Boolean)public java.lang.Boolean getFetchMissingValues()
FormItem.optionDataSource, should the item ever perform a fetch against this dataSource to retrieve the related record.
This is disabled by default for hiddenItems as there is typically no need to perform a fetch and retrieve a
display-field value to show the user for a hidden item. This does mean that if a developer needs access to the related
record for a hidden-item's value, they will need to enable both this setting and FormItem.alwaysFetchMissingValues.
getFetchMissingValues in class FormItemcom.smartgwt.client.widgets.form.fields.FormItem#getOptionDataSource,
FormItem.getSelectedRecord(),
FormItem.getFilterLocally()public void setRowSpan(int rowSpan)
setRowSpan in class FormItemrowSpan - Default value is 0Appearance overview and related methodspublic int getRowSpan()
getRowSpan in class FormItemAppearance overview and related methodspublic void setShowTitle(java.lang.Boolean showTitle)
setShowTitle in class FormItemshowTitle - Default value is falseAppearance overview and related methodspublic java.lang.Boolean getShowTitle()
getShowTitle in class FormItemAppearance overview and related methodspublic static void setDefaultProperties(HiddenItem hiddenItemProperties)
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.
hiddenItemProperties - properties that should be used as new defaults when instances of this class are createdSGWTProperties