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.StateCustomizer
configOnly, scClassName, warnOnEditorTypeConversion, warnOnEditorTypeConversionDefault
id
factoryCreated, factoryProperties
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,
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.String |
getColSpanAsString()
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
|
HiddenItem |
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. |
HiddenItem |
setColSpan(int colSpan)
hidden fields don't take up any columns
|
HiddenItem |
setColSpan(java.lang.String 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.
|
HiddenItem |
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. |
HiddenItem |
setRowSpan(int rowSpan)
hidden fields don't take up any rows
|
HiddenItem |
setShowTitle(java.lang.Boolean showTitle)
we never show a separate title cell for hidden fields
|
_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, 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, getEditProxyConstructor, getEmptyDisplayValue, getEmptyValueIcon, getEndRow, getErrorIconHeight, getErrorIconProperties, getErrorIconSrc, getErrorIconWidth, getErrorMessageWidth, getErrors, getEscapeHTML, getExportFormat, getFieldName, getFilterLocally, getForeignDisplayField, getForm, getFormat, getFormItemAutoChild, getFormula, getFullDataPath, getGlobalTabIndex, getGridColNum, getGridRowNum, getHeight, getHeightAsString, 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, getMultiple, 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, getPrompt, getReadOnlyCanSelectText, getReadOnlyDisplay, getReadOnlyHover, getReadOnlyTextBoxStyle, getReadOnlyWhen, getRect, getRedrawOnChange, getRejectInvalidValueOnChange, getRequired, getRequiredMessage, getRequiredWhen, getSaveOnEnter, getScClassName, getSelectedRecord, getSelectOnClick, getSelectOnFocus, getShouldSaveValue, 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, 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, hasAdvancedCriteria, hasErrors, hide, hideIcon, invalidateDisplayValueCache, isAssignableFrom, isConfigOnly, isCreated, isCutEvent, isDisabled, isDrawn, isFocused, isInGrid, isPasteEvent, isVisible, linkToInstanceUponCreate, mapDisplayToValue, mapValueToDisplay, mapValueToDisplay, mapValueToDisplay, redraw, redraw, removeIcon, selectedRecordChanged, setAccessKey, setAlign, setAllowExpressions, 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, setCanEditCriterionPredicate, setCanEditOpaqueValues, setCanFocus, setCanHover, setCanSelectText, setCanTabToIcons, setCellHeight, setCellStyle, setChangeOnKeypress, setClipStaticValue, setClipTitle, setConfigOnly, setControlStyle, setCriteriaField, setCriterion, setCriterionGetter, setCriterionSetter, 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, setErrorIconProperties, setErrorIconSrc, setErrorIconWidth, setErrorMessageWidth, setErrorOrientation, setErrors, setErrors, setEscapeHTML, setExportFormat, setFilterLocally, setForeignDisplayField, setFormat, setFormula, setGlobalTabIndex, setHeight, setHeight, 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, setMultiple, setMultipleValueSeparator, setName, setNullOriginalValueText, setNullProperty, setOperator, setOptionCriteria, setOptionDataSource, setOptionDataSource, setOptionFilterContext, setOptionOperationId, setOptionTextMatchStyle, setOriginalValueMessage, setPickerIconHeight, setPickerIconName, setPickerIconPrompt, setPickerIconProperties, setPickerIconSrc, setPickerIconStyle, setPickerIconWidth, setPrintReadOnlyTextBoxStyle, setPrintTextBoxStyle, setPrintTitleStyle, setPrompt, setProperty, setProperty, setProperty, setProperty, setProperty, setReadOnlyCanSelectText, setReadOnlyDisplay, setReadOnlyHover, setReadOnlyTextBoxStyle, setReadOnlyWhen, setRedrawOnChange, setRejectInvalidValueOnChange, setRequired, setRequiredMessage, setRequiredWhen, setSaveOnEnter, setScClassName, setSelectOnClick, setSelectOnFocus, setShouldSaveValue, 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, 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, setWrapTitle, shouldApplyHeightToTextBox, shouldFetchMissingValue, shouldSaveOnEnter, shouldStopKeyPressBubbling, show, showIcon, showPicker, stopHover, storeValue, 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 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
.AutoChildUsage
public 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
.AutoChildUsage
public static void changePickerIconDefaults(FormItemIcon defaults)
public HiddenItem 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 FormItem
alwaysFetchMissingValues
- New alwaysFetchMissingValues value. Default value is falseHiddenItem
instance, for chaining setter callspublic 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 FormItem
public HiddenItem setColSpan(int colSpan)
setColSpan
in class FormItem
colSpan
- New colSpan value. Default value is 0HiddenItem
instance, for chaining setter callsAppearance overview and related methods
public int getColSpan()
Note : This method will return -1 if the underlying SmartClient JavaScript
attribute value cannot be expressed as a(n) int. In that case, other
getters, similarly-named but ending in AsString
, AsCanvas
,
etc., may be provided.
Appearance overview and related methods
public HiddenItem setColSpan(java.lang.String colSpan)
setColSpan
in class FormItem
colSpan
- New colSpan value. Default value is 0HiddenItem
instance, for chaining setter callsAppearance overview and related methods
public java.lang.String getColSpanAsString()
Appearance overview and related methods
public HiddenItem 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 FormItem
fetchMissingValues
- New fetchMissingValues value. Default value is trueHiddenItem
instance, for chaining setter callsFormItem.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 FormItem
FormItem.getOptionDataSource()
,
FormItem.getSelectedRecord()
,
FormItem.getFilterLocally()
public HiddenItem setRowSpan(int rowSpan)
setRowSpan
in class FormItem
rowSpan
- New rowSpan value. Default value is 0HiddenItem
instance, for chaining setter callsAppearance overview and related methods
public int getRowSpan()
getRowSpan
in class FormItem
Appearance overview and related methods
public HiddenItem setShowTitle(java.lang.Boolean showTitle)
setShowTitle
in class FormItem
showTitle
- New showTitle value. Default value is falseHiddenItem
instance, for chaining setter callsAppearance overview and related methods
public java.lang.Boolean getShowTitle()
getShowTitle
in class FormItem
Appearance overview and related methods
public 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