Class TextAreaItem
- All Implemented Interfaces:
HasHandlers,HasBlurHandlers,HasChangedHandlers,HasChangeHandlers,HasClickHandlers,HasDoubleClickHandlers,HasEditorEnterHandlers,HasEditorExitHandlers,HasFocusHandlers,HasIconClickHandlers,HasIconKeyPressHandlers,HasItemHoverHandlers,HasKeyDownHandlers,HasKeyPressHandlers,HasKeyUpHandlers,HasPendingStatusChangedHandlers,HasPickerIconClickHandlers,HasShowContextMenuHandlers,HasTitleClickHandlers,HasTitleDoubleClickHandlers,HasTitleHoverHandlers,HasValueHoverHandlers,HasValueIconClickHandlers
- Direct Known Subclasses:
AutoFitTextAreaItem
<TEXTAREA> object)-
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
ConstructorsConstructorDescriptionTextAreaItem(JavaScriptObject jsObj) TextAreaItem(String name) TextAreaItem(String name, String title) -
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) voidIf this item currently has focus, clear the current selection.voiddeselectValue(Boolean start) If this item currently has focus, clear the current selection.In Mobile Safari, should automatic correction be offered for text in the item's text box? Ifnull, then Mobile Safari determines automatically whether to enable autocorrect.Should this form item fire itschangehandler (and store its value in the form) on every keypress? Set tofalseto suppress the 'change' handler firing (and the value stored) on every keypress.Default class used to construct theEditProxyfor this component when the component isfirst placed into edit mode.booleanIf alengthis specified for this item, should user input be limited to the specified length? If set to true, user input and values passed tosetValue()will be trimmed to the specified length.Returns the raw text value that currently appears in the text field, which can differ fromFormItem.getValue()in various cases - for example: for items that constrain the value range, such as aDateItemwithenforceDate:true, or aComboBoxItemwithaddUnknownValues:false for items with a defined valueMap or edit value formatter and parser functions which converts display value to data value while the item has focus ifchangeOnKeypressis falseBy default HTML characters will be escaped whencanEditis false andreadOnlyDisplayis "static", so that the raw value of the field (for example"<b>AAA</b>") is displayed to the user rather than the interpreted HTML (for example"AAA").WithformatOnBlurenabled, this textAreaItem will format its value according to the rules described inFormItem.mapValueToDisplay()as long as the item does not have focus.intDefault height of this itemAlign icons with the top edge of text area icons by default.If set, maximum number of characters for this field.intMinimum valid height for this TextAreaItem in px.static TextAreaItemgetOrCreateRef(JavaScriptObject jsObj) TextAreaItem has an explicit pickerIconHeight as we don't want the picker icon, if shown, to size itself to match the height of the item.When generating a print-view of the component containing this TextArea, should the form item expand to accommodate its value? If set to false the text box not expand to fit its content in the print view, instead showing exactly as it does in the live form, possibly with scrollbars.int[]For text-based items, this method returns the indices of the start/end of the current selection if the item currently has the focus.Allows theselectOnClickbehavior to be configured on a per-FormItem basis.Allows theselectOnFocusbehavior to be configured on a per-FormItem basis.Ifshowing a hint for this form item, should the hint be shown within the field?booleanWhen set to false, prevents this item's input element from being written into the DOM.Height of the FormItem whencanEditis false andreadOnlyDisplayis "static".booleanDoes the current formItem support native cut and paste events?Base CSS class to apply to this item's input element.booleanIfshowing the hint in fieldand if supported by the browser, should the HTML5placeholderattribute be used to display the hint within the field? If set tofalse, then use of theplaceholderattribute is disabled and an alternative technique to display the hint in-field is used instead.Return the value tracked by this form item.intgetWidth()default width of this itemgetWrap()Text wrapping style.voidPut focus in this item and select the entire value.setBrowserAutoCapitalize(Boolean browserAutoCapitalize) Note : This is an advanced settingsetBrowserAutoCorrect(Boolean browserAutoCorrect) In Mobile Safari, should automatic correction be offered for text in the item's text box? Ifnull, then Mobile Safari determines automatically whether to enable autocorrect.setChangeOnKeypress(Boolean changeOnKeypress) Should this form item fire itschangehandler (and store its value in the form) on every keypress? Set tofalseto suppress the 'change' handler firing (and the value stored) on every keypress.static voidsetDefaultProperties(TextAreaItem textAreaItemProperties) Class level method to set the default properties of this class.setEditProxyConstructor(String editProxyConstructor) Default class used to construct theEditProxyfor this component when the component isfirst placed into edit mode.setEnforceLength(boolean enforceLength) If alengthis specified for this item, should user input be limited to the specified length? If set to true, user input and values passed tosetValue()will be trimmed to the specified length.setEscapeHTML(Boolean escapeHTML) By default HTML characters will be escaped whencanEditis false andreadOnlyDisplayis "static", so that the raw value of the field (for example"<b>AAA</b>") is displayed to the user rather than the interpreted HTML (for example"AAA").setFormatOnBlur(Boolean formatOnBlur) WithformatOnBlurenabled, this textAreaItem will format its value according to the rules described inFormItem.mapValueToDisplay()as long as the item does not have focus.setHeight(int height) Default height of this itemsetIconVAlign(VerticalAlignment iconVAlign) Align icons with the top edge of text area icons by default.If set, maximum number of characters for this field.setMinHeight(int minHeight) Minimum valid height for this TextAreaItem in px.setPickerIconHeight(Integer pickerIconHeight) TextAreaItem has an explicit pickerIconHeight as we don't want the picker icon, if shown, to size itself to match the height of the item.setPrintFullText(Boolean printFullText) When generating a print-view of the component containing this TextArea, should the form item expand to accommodate its value? If set to false the text box not expand to fit its content in the print view, instead showing exactly as it does in the live form, possibly with scrollbars.voidsetSelectionRange(int start, int end) Puts focus into this form item and selects characters between the given indices.setSelectOnClick(Boolean selectOnClick) Allows theselectOnClickbehavior to be configured on a per-FormItem basis.setSelectOnFocus(Boolean selectOnFocus) Allows theselectOnFocusbehavior to be configured on a per-FormItem basis.setShowHintInField(Boolean showHintInField) Ifshowing a hint for this form item, should the hint be shown within the field?setShowInputElement(boolean showInputElement) When set to false, prevents this item's input element from being written into the DOM.setStaticHeight(Integer staticHeight) Height of the FormItem whencanEditis false andreadOnlyDisplayis "static".setSupportsCutPasteEvents(boolean supportsCutPasteEvents) Does the current formItem support native cut and paste events?setTextBoxStyle(String textBoxStyle) Base CSS class to apply to this item's input element.setUsePlaceholderForHint(boolean usePlaceholderForHint) Ifshowing the hint in fieldand if supported by the browser, should the HTML5placeholderattribute be used to display the hint within the field? If set tofalse, then use of theplaceholderattribute is disabled and an alternative technique to display the hint in-field is used instead.setWidth(int width) default width of this itemvoidsetWrap(TextAreaWrap wrap) Text wrapping style.transformPastedValue(FormItem item, DynamicForm form, String pastedValue) Notification fired in response to a clipboard "paste" event on freeform text items, giving developers an opportunity to reformat the pasted text.Methods 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, 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, getExportFormat, getFetchMissingValues, getFieldName, getFilterLocally, getForeignDisplayField, getForm, getFormat, getFormItemAutoChild, getFormula, getFullDataPath, getGlobalTabIndex, getGridColNum, getGridRowNum, getHeightAsString, getHidden, getHint, getHintStyle, getHoverAlign, getHoverDelay, getHoverFocusKey, getHoverHeight, getHoverHeightAsString, getHoverOpacity, getHoverPersist, getHoverStyle, getHoverVAlign, getHoverWidth, getHoverWidthAsString, getIcon, getIconBaseStyle, getIconHeight, getIconHSpace, getIconPageRect, getIconPrompt, getIconRect, getIcons, getIconTabPosition, 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, getPickerIconName, getPickerIconPrompt, getPickerIconProperties, getPickerIconSrc, getPickerIconStyle, getPickerIconTabPosition, getPickerIconWidth, getPixelHeight, getPixelWidth, getPrintReadOnlyTextBoxStyle, getPrintTextBoxStyle, getPrintTitleStyle, getPrompt, getReadOnlyCanSelectText, getReadOnlyControlStyle, getReadOnlyDisplay, getReadOnlyHover, getReadOnlyTextBoxStyle, getReadOnlyWhen, getRect, getRedrawOnChange, getRejectInvalidValueOnChange, getRequired, getRequiredMessage, getRequiredWhen, getRowSpan, getSaveOnEnter, getScClassName, getSelectedRecord, 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, getShowTitle, getShowValueIconOnly, getStartRow, getStopOnError, getStoreDisplayValues, getSuppressValueIcon, getSynchronousValidation, getTabIndex, getTextAlign, 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, getWidthAsString, getWrapHintText, getWrapStaticValue, 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, 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, setCanEditCriterionPredicate, setCanEditOpaqueValues, setCanFocus, setCanHover, setCanSelectText, setCanTabToIcons, setCellHeight, setCellStyle, setClipStaticValue, setClipTitle, setColSpan, setColSpan, 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, setEmptyDisplayValue, setEmptyValueIcon, setEndRow, setErrorFormatter, setErrorIconHeight, setErrorIconProperties, setErrorIconSrc, setErrorIconWidth, setErrorMessageWidth, setErrorOrientation, setErrors, setErrors, setExportFormat, setFetchMissingValues, setFilterLocally, setForeignDisplayField, setFormat, setFormula, setGlobalTabIndex, setHeight, setHidden, setHint, setHintStyle, setHoverAlign, setHoverDelay, setHoverFocusKey, setHoverHeight, setHoverHeight, setHoverOpacity, setHoverPersist, setHoverStyle, setHoverVAlign, setHoverWidth, setHoverWidth, setIconBaseStyle, setIconDisabled, setIconHeight, setIconHSpace, setIconPrompt, setIcons, setIconShowOnFocus, 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, setPickerIconName, setPickerIconPrompt, setPickerIconProperties, setPickerIconSrc, setPickerIconStyle, setPickerIconWidth, setPrintReadOnlyTextBoxStyle, setPrintTextBoxStyle, setPrintTitleStyle, setPrompt, setProperty, setProperty, setProperty, setProperty, setProperty, setReadOnlyCanSelectText, setReadOnlyControlStyle, setReadOnlyDisplay, setReadOnlyHover, setReadOnlyTextBoxStyle, setReadOnlyWhen, setRedrawOnChange, setRejectInvalidValueOnChange, setRequired, setRequiredMessage, setRequiredWhen, setRowSpan, setSaveOnEnter, setScClassName, 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, setShowTitle, setShowValueIconOnly, setStartRow, setStateCustomizer, setStopOnError, setStoreDisplayValues, setSuppressValueIcon, setSynchronousValidation, setTabIndex, setTextAlign, 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, setWrapHintText, setWrapStaticValue, setWrapTitle, shouldApplyHeightToTextBox, shouldFetchMissingValue, shouldSaveOnEnter, shouldStopKeyPressBubbling, show, showIcon, showPicker, stopHover, storeValue, 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
-
TextAreaItem
public TextAreaItem() -
TextAreaItem
-
TextAreaItem
-
TextAreaItem
-
-
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
-
setBrowserAutoCapitalize
Note : This is an advanced setting
- Parameters:
browserAutoCapitalize- New browserAutoCapitalize value. Default value is null- Returns:
TextAreaIteminstance, for chaining setter calls
-
getBrowserAutoCapitalize
- Returns:
- Current browserAutoCapitalize value. Default value is null
-
setBrowserAutoCorrect
In Mobile Safari, should automatic correction be offered for text in the item's text box? Ifnull, then Mobile Safari determines automatically whether to enable autocorrect.When enabled, Mobile Safari displays "autocorrect bubbles" to suggest automatic corrections:
Note : This is an advanced setting
- Parameters:
browserAutoCorrect- New browserAutoCorrect value. Default value is null- Returns:
TextAreaIteminstance, for chaining setter calls
-
getBrowserAutoCorrect
In Mobile Safari, should automatic correction be offered for text in the item's text box? Ifnull, then Mobile Safari determines automatically whether to enable autocorrect.When enabled, Mobile Safari displays "autocorrect bubbles" to suggest automatic corrections:
- Returns:
- Current browserAutoCorrect value. Default value is null
-
setChangeOnKeypress
Should this form item fire itschangehandler (and store its value in the form) on every keypress? Set tofalseto suppress the 'change' handler firing (and the value stored) on every keypress.Note: If
false, the value returned bygetValuewill not reflect the value displayed in the form item element as long as focus is in the form item element.- Overrides:
setChangeOnKeypressin classFormItem- Parameters:
changeOnKeypress- New changeOnKeypress value. Default value is true- Returns:
TextAreaIteminstance, for chaining setter calls
-
getChangeOnKeypress
Should this form item fire itschangehandler (and store its value in the form) on every keypress? Set tofalseto suppress the 'change' handler firing (and the value stored) on every keypress.Note: If
false, the value returned bygetValuewill not reflect the value displayed in the form item element as long as focus is in the form item element.- Overrides:
getChangeOnKeypressin classFormItem- Returns:
- Current changeOnKeypress value. Default value is true
-
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 "TextAreaItemEditProxy"- Returns:
TextAreaIteminstance, 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 "TextAreaItemEditProxy"
- See Also:
-
setEnforceLength
If alengthis specified for this item, should user input be limited to the specified length? If set to true, user input and values passed tosetValue()will be trimmed to the specified length. Otherwise values exceeding the specified length will raise an error on validation.Note that having this value set to true limits user interactivity in some ways. For example users would be unable to paste a longer string into the field for editing without seeing it be truncated. Given how text areas are typically used to edit longer values than non-wrapping
TextItems, this value is false by default for textAreaItems.- Parameters:
enforceLength- New enforceLength value. Default value is false- Returns:
TextAreaIteminstance, for chaining setter calls
-
getEnforceLength
public boolean getEnforceLength()If alengthis specified for this item, should user input be limited to the specified length? If set to true, user input and values passed tosetValue()will be trimmed to the specified length. Otherwise values exceeding the specified length will raise an error on validation.Note that having this value set to true limits user interactivity in some ways. For example users would be unable to paste a longer string into the field for editing without seeing it be truncated. Given how text areas are typically used to edit longer values than non-wrapping
TextItems, this value is false by default for textAreaItems.- Returns:
- Current enforceLength value. Default value is false
-
setEscapeHTML
By default HTML characters will be escaped whencanEditis false andreadOnlyDisplayis "static", so that the raw value of the field (for example"<b>AAA</b>") is displayed to the user rather than the interpreted HTML (for example"AAA"). SettingescapeHTMLfalse will instead force HTML values in a textAreaItem to be interpreted by the browser in that situation.- Overrides:
setEscapeHTMLin classFormItem- Parameters:
escapeHTML- New escapeHTML value. Default value is true- Returns:
TextAreaIteminstance, for chaining setter calls- See Also:
-
getEscapeHTML
By default HTML characters will be escaped whencanEditis false andreadOnlyDisplayis "static", so that the raw value of the field (for example"<b>AAA</b>") is displayed to the user rather than the interpreted HTML (for example"AAA"). SettingescapeHTMLfalse will instead force HTML values in a textAreaItem to be interpreted by the browser in that situation.- Overrides:
getEscapeHTMLin classFormItem- Returns:
- Current escapeHTML value. Default value is true
- See Also:
-
setFormatOnBlur
WithformatOnBlurenabled, this textAreaItem will format its value according to the rules described inFormItem.mapValueToDisplay()as long as the item does not have focus. Once the user puts focus into the item the formatter will be removed. This provides a simple way for developers to show a nicely formatted display value in a freeform text field, without the need for an explicitFormItem.formatEditorValue()andFormItem.parseEditorValue()pair.- Parameters:
formatOnBlur- New formatOnBlur value. Default value is false- Returns:
TextAreaIteminstance, for chaining setter calls
-
getFormatOnBlur
WithformatOnBlurenabled, this textAreaItem will format its value according to the rules described inFormItem.mapValueToDisplay()as long as the item does not have focus. Once the user puts focus into the item the formatter will be removed. This provides a simple way for developers to show a nicely formatted display value in a freeform text field, without the need for an explicitFormItem.formatEditorValue()andFormItem.parseEditorValue()pair.- Returns:
- Current formatOnBlur value. Default value is false
-
setHeight
Default height of this itemNote that when item is rendered as read-only with
readOnlyDisplayas "static" the propertyFormItem.staticHeightis used instead.- Overrides:
setHeightin classFormItem- Parameters:
height- New height value. Default value is 100- Returns:
TextAreaIteminstance, for chaining setter calls- See Also:
-
getHeight
public int getHeight()Default height of this itemNote that when item is rendered as read-only with
readOnlyDisplayas "static" the propertyFormItem.staticHeightis used instead. -
setIconVAlign
Align icons with the top edge of text area icons by default.- Overrides:
setIconVAlignin classFormItem- Parameters:
iconVAlign- New iconVAlign value. Default value is Canvas.TOP- Returns:
TextAreaIteminstance, for chaining setter calls
-
getIconVAlign
Align icons with the top edge of text area icons by default.- Overrides:
getIconVAlignin classFormItem- Returns:
- Current iconVAlign value. Default value is Canvas.TOP
-
setLength
If set, maximum number of characters for this field. IfenforceLengthis set to true, user input will be limited to this value, and values exceeding this length passed tosetValue()will be trimmed. Otherwise values exceeding the specified length will raise an error on validation.See also
DataSourceField.length.- Parameters:
length- New length value. Default value is null- Returns:
TextAreaIteminstance, for chaining setter calls- See Also:
-
getLength
If set, maximum number of characters for this field. IfenforceLengthis set to true, user input will be limited to this value, and values exceeding this length passed tosetValue()will be trimmed. Otherwise values exceeding the specified length will raise an error on validation.See also
DataSourceField.length.- Returns:
- Current length value. Default value is null
- See Also:
-
setMinHeight
Minimum valid height for this TextAreaItem in px. If the specifiedheightis less than this value, the text area will still render at this height.- Parameters:
minHeight- New minHeight value. Default value is 16- Returns:
TextAreaIteminstance, for chaining setter calls
-
getMinHeight
public int getMinHeight()Minimum valid height for this TextAreaItem in px. If the specifiedheightis less than this value, the text area will still render at this height.- Returns:
- Current minHeight value. Default value is 16
-
setPickerIconHeight
TextAreaItem has an explicit pickerIconHeight as we don't want the picker icon, if shown, to size itself to match the height of the item.- Overrides:
setPickerIconHeightin classFormItem- Parameters:
pickerIconHeight- New pickerIconHeight value. Default value is 20- Returns:
TextAreaIteminstance, for chaining setter calls
-
getPickerIconHeight
TextAreaItem has an explicit pickerIconHeight as we don't want the picker icon, if shown, to size itself to match the height of the item.- Overrides:
getPickerIconHeightin classFormItem- Returns:
- Current pickerIconHeight value. Default value is 20
-
setPrintFullText
When generating a print-view of the component containing this TextArea, should the form item expand to accommodate its value? If set to false the text box not expand to fit its content in the print view, instead showing exactly as it does in the live form, possibly with scrollbars.- Parameters:
printFullText- New printFullText value. Default value is true- Returns:
TextAreaIteminstance, for chaining setter calls- See Also:
-
getPrintFullText
When generating a print-view of the component containing this TextArea, should the form item expand to accommodate its value? If set to false the text box not expand to fit its content in the print view, instead showing exactly as it does in the live form, possibly with scrollbars.- Returns:
- Current printFullText value. Default value is true
- See Also:
-
setSelectOnClick
Allows theselectOnClickbehavior to be configured on a per-FormItem basis. Normally all items in a form default to the value ofDynamicForm.selectOnClick.- Overrides:
setSelectOnClickin classFormItem- Parameters:
selectOnClick- New selectOnClick value. Default value is null- Returns:
TextAreaIteminstance, for chaining setter calls- See Also:
-
getSelectOnClick
Allows theselectOnClickbehavior to be configured on a per-FormItem basis. Normally all items in a form default to the value ofDynamicForm.selectOnClick.- Overrides:
getSelectOnClickin classFormItem- Returns:
- Current selectOnClick value. Default value is null
- See Also:
-
setSelectOnFocus
Allows theselectOnFocusbehavior to be configured on a per-FormItem basis. Normally all items in a form default to the value ofDynamicForm.selectOnFocus.- Overrides:
setSelectOnFocusin classFormItem- Parameters:
selectOnFocus- New selectOnFocus value. Default value is null- Returns:
TextAreaIteminstance, for chaining setter calls- See Also:
-
getSelectOnFocus
Allows theselectOnFocusbehavior to be configured on a per-FormItem basis. Normally all items in a form default to the value ofDynamicForm.selectOnFocus.- Overrides:
getSelectOnFocusin classFormItem- Returns:
- Current selectOnFocus value. Default value is null
- See Also:
-
setShowHintInField
Ifshowing a hint for this form item, should the hint be shown within the field?Unless the HTML5
placeholderattribute is used to display the hint (seeusePlaceholderForHint), the value of the <input> element for this item will be set to the hint whenever this item is not focused. Also, when displaying the hint, the CSS style of the data element will be set to thetextBoxStylewith the suffix "Hint" appended to it; or, if the item is disabled, the suffix "DisabledHint" will be used. InRTL modewhenshowRTListrue, an additional "RTL" suffix will be appended; i.e. the CSS style of the data element when the hint is displayed will be thetextBoxStyleplus "HintRTL" or "DisabledHintRTL".To change this attribute after being drawn, it is necessary to call
FormItem.redraw()or redraw the form.Styling the in-field hint
The in-field hint can be styled with CSS for thetextBoxStyle+ "Hint" / "HintRTL" / "DisabledHint" / "DisabledHintRTL" styles. For example, if this item'stextBoxStyleis set to "mySpecialItem", then changing the hint color to blue can be accomplished with the following CSS:.mySpecialItemHint, .mySpecialItemHintRTL, .mySpecialItemDisabledHint, .mySpecialItemDisabledHintRTL { color: blue; }In
DynamicForm.linearMode, this property will be defaulted true if left unset.- Parameters:
showHintInField- New showHintInField value. Default value is null- Returns:
TextAreaIteminstance, for chaining setter calls- See Also:
-
getShowHintInField
Ifshowing a hint for this form item, should the hint be shown within the field?Unless the HTML5
placeholderattribute is used to display the hint (seeusePlaceholderForHint), the value of the <input> element for this item will be set to the hint whenever this item is not focused. Also, when displaying the hint, the CSS style of the data element will be set to thetextBoxStylewith the suffix "Hint" appended to it; or, if the item is disabled, the suffix "DisabledHint" will be used. InRTL modewhenshowRTListrue, an additional "RTL" suffix will be appended; i.e. the CSS style of the data element when the hint is displayed will be thetextBoxStyleplus "HintRTL" or "DisabledHintRTL".To change this attribute after being drawn, it is necessary to call
FormItem.redraw()or redraw the form.Styling the in-field hint
The in-field hint can be styled with CSS for thetextBoxStyle+ "Hint" / "HintRTL" / "DisabledHint" / "DisabledHintRTL" styles. For example, if this item'stextBoxStyleis set to "mySpecialItem", then changing the hint color to blue can be accomplished with the following CSS:.mySpecialItemHint, .mySpecialItemHintRTL, .mySpecialItemDisabledHint, .mySpecialItemDisabledHintRTL { color: blue; }In
DynamicForm.linearMode, this property will be defaulted true if left unset.- Returns:
- Current showHintInField value. Default value is null
- See Also:
-
setShowInputElement
When set to false, prevents this item's input element from being written into the DOM. If there arevalueIconsor apicker icon, these are displayed as normal, and the item will auto-sizing to that content if itswidthis set to null.Note : This is an advanced setting
- Parameters:
showInputElement- New showInputElement value. Default value is true- Returns:
TextAreaIteminstance, for chaining setter calls
-
getShowInputElement
public boolean getShowInputElement()When set to false, prevents this item's input element from being written into the DOM. If there arevalueIconsor apicker icon, these are displayed as normal, and the item will auto-sizing to that content if itswidthis set to null.- Returns:
- Current showInputElement value. Default value is true
-
setStaticHeight
Height of the FormItem whencanEditis false andreadOnlyDisplayis "static". The normalheightis used if this property is not set.- Overrides:
setStaticHeightin classFormItem- Parameters:
staticHeight- New staticHeight value. Default value is 1- Returns:
TextAreaIteminstance, for chaining setter calls- See Also:
-
getStaticHeight
Height of the FormItem whencanEditis false andreadOnlyDisplayis "static". The normalheightis used if this property is not set.- Overrides:
getStaticHeightin classFormItem- Returns:
- Current staticHeight value. Default value is 1
- See Also:
-
setSupportsCutPasteEvents
Does the current formItem support native cut and paste events?This attribute only applies to freeform text entry fields such as
TextItemandTextAreaItem, and only ifchangeOnKeypressis true. If true, developers can detect the user editing the value via cut or paste interactions (triggered from keyboard shortcuts or the native browser menu options) using theFormItem.isCutEvent()andFormItem.isPasteEvent()methods. This allows custom cut/paste handling to be added to the various change notification flow methods includingFormItem.change(), andFormItem.transformInput().- Overrides:
setSupportsCutPasteEventsin classFormItem- Parameters:
supportsCutPasteEvents- New supportsCutPasteEvents value. Default value is true- Returns:
TextAreaIteminstance, for chaining setter calls
-
getSupportsCutPasteEvents
public boolean getSupportsCutPasteEvents()Does the current formItem support native cut and paste events?This attribute only applies to freeform text entry fields such as
TextItemandTextAreaItem, and only ifchangeOnKeypressis true. If true, developers can detect the user editing the value via cut or paste interactions (triggered from keyboard shortcuts or the native browser menu options) using theFormItem.isCutEvent()andFormItem.isPasteEvent()methods. This allows custom cut/paste handling to be added to the various change notification flow methods includingFormItem.change(), andFormItem.transformInput().- Overrides:
getSupportsCutPasteEventsin classFormItem- Returns:
- Current supportsCutPasteEvents value. Default value is true
-
setTextBoxStyle
Base CSS class to apply to this item's input element. NOTE: See theCompoundFormItem_skinningdiscussion for special skinning considerations.- Overrides:
setTextBoxStylein classFormItem- Parameters:
textBoxStyle- New textBoxStyle value. Default value is "textItem"- Returns:
TextAreaIteminstance, for chaining setter calls- See Also:
-
getTextBoxStyle
Base CSS class to apply to this item's input element. NOTE: See theCompoundFormItem_skinningdiscussion for special skinning considerations.- Overrides:
getTextBoxStylein classFormItem- Returns:
- Current textBoxStyle value. Default value is "textItem"
- See Also:
-
setUsePlaceholderForHint
Ifshowing the hint in fieldand if supported by the browser, should the HTML5placeholderattribute be used to display the hint within the field? If set tofalse, then use of theplaceholderattribute is disabled and an alternative technique to display the hint in-field is used instead.The HTML5
placeholderattribute is supported in the following major browsers:- Chrome 4+
- Firefox 4+
- Internet Explorer 10+
- Safari 5+
- Opera 11.50+
- Android 2.1+
WebView(used by the stock Browser app and whenpackaging with PhoneGap) - Mobile Safari for iOS 3.2+
In browsers other than the above, in-field hints are implemented via a different technique.
Note that placeholder behavior is known to differ in Internet Explorer and certain old versions of the above browsers due to a recent change in the HTML5 specification regarding the
placeholderattribute. Under the old rules, the placeholder is cleared when the element is focused. In the latest HTML5 spec as published by WHATWG, the placeholder is still displayed when the element is focused as long as the value is an empty string.Styling the placeholder
While there isn't a standard way to style the placeholder text, Chrome, Firefox, Internet Explorer, and Safari provide vendor-prefixed pseudo-classes and/or pseudo-elements that can be used in CSS selectors:Browser Pseudo-class or pseudo-element Chrome, Safari ::-webkit-input-placeholderFirefox 4 - 18 :-moz-placeholderFirefox 19+ ::-moz-placeholderInternet Explorer :-ms-input-placeholderNote that unlike other browsers, Firefox 19+ applies opacity:0.4 to the placeholder text. See Bug 556145 - Placeholder text default style should use opacity instead of GrayText
Because browsers are required to ignore the entire rule if a selector is invalid, separate rules are needed for each browser. For example:
::-webkit-input-placeholder { color: blue; opacity: 1; } :-moz-placeholder { color: blue; opacity: 1; } ::-moz-placeholder { color: blue; opacity: 1; } :-ms-input-placeholder { color: blue; opacity: 1; }If using Sass, it may be useful to utilize Sass' parent selector feature. For example:
.myCustomItem, .myCustomItemRTL, .myCustomItemDisabled, .myCustomItemDisabledRTL, .myCustomItemError, .myCustomItemErrorRTL, .myCustomItemFocused, .myCustomItemFocusedRTL, .myCustomItemHint, .myCustomItemHintRTL, .myCustomItemDisabledHint, .myCustomItemDisabledHintRTL { // ... &::-webkit-input-placeholder { color: blue; opacity: 1; } &:-moz-placeholder { color: blue; opacity: 1; } &::-moz-placeholder { color: blue; opacity: 1; } &:-ms-input-placeholder { color: blue; opacity: 1; } }If using Compass, the
input-placeholdermixin that was added in version 1.0 can further simplify the code to style the placeholder text For example:.myCustomItem, .myCustomItemRTL, .myCustomItemDisabled, .myCustomItemDisabledRTL, .myCustomItemError, .myCustomItemErrorRTL, .myCustomItemFocused, .myCustomItemFocusedRTL, .myCustomItemHint, .myCustomItemHintRTL, .myCustomItemDisabledHint, .myCustomItemDisabledHintRTL { // ... @include input-placeholder { color: blue; opacity: 1; } }Accessibility concerns
The HTML5 specification notes that a placeholder should not be used as a replacement for a title. The placeholder is intended to be a short hint that assists the user who is entering a value into the empty field. The placeholder can be mistaken by some users for a pre-filled value, particularly in Internet Explorer because the same color is used, and the placeholder text color may provide insufficient contrast, particularly in Firefox 19+ because of the default 0.4 opacity. Furthermore, not having a title reduces the hit area available for setting focus on the item.Note : This is an advanced setting
- Parameters:
usePlaceholderForHint- New usePlaceholderForHint value. Default value is true- Returns:
TextAreaIteminstance, for chaining setter calls- See Also:
-
getUsePlaceholderForHint
public boolean getUsePlaceholderForHint()Ifshowing the hint in fieldand if supported by the browser, should the HTML5placeholderattribute be used to display the hint within the field? If set tofalse, then use of theplaceholderattribute is disabled and an alternative technique to display the hint in-field is used instead.The HTML5
placeholderattribute is supported in the following major browsers:- Chrome 4+
- Firefox 4+
- Internet Explorer 10+
- Safari 5+
- Opera 11.50+
- Android 2.1+
WebView(used by the stock Browser app and whenpackaging with PhoneGap) - Mobile Safari for iOS 3.2+
In browsers other than the above, in-field hints are implemented via a different technique.
Note that placeholder behavior is known to differ in Internet Explorer and certain old versions of the above browsers due to a recent change in the HTML5 specification regarding the
placeholderattribute. Under the old rules, the placeholder is cleared when the element is focused. In the latest HTML5 spec as published by WHATWG, the placeholder is still displayed when the element is focused as long as the value is an empty string.Styling the placeholder
While there isn't a standard way to style the placeholder text, Chrome, Firefox, Internet Explorer, and Safari provide vendor-prefixed pseudo-classes and/or pseudo-elements that can be used in CSS selectors:Browser Pseudo-class or pseudo-element Chrome, Safari ::-webkit-input-placeholderFirefox 4 - 18 :-moz-placeholderFirefox 19+ ::-moz-placeholderInternet Explorer :-ms-input-placeholderNote that unlike other browsers, Firefox 19+ applies opacity:0.4 to the placeholder text. See Bug 556145 - Placeholder text default style should use opacity instead of GrayText
Because browsers are required to ignore the entire rule if a selector is invalid, separate rules are needed for each browser. For example:
::-webkit-input-placeholder { color: blue; opacity: 1; } :-moz-placeholder { color: blue; opacity: 1; } ::-moz-placeholder { color: blue; opacity: 1; } :-ms-input-placeholder { color: blue; opacity: 1; }If using Sass, it may be useful to utilize Sass' parent selector feature. For example:
.myCustomItem, .myCustomItemRTL, .myCustomItemDisabled, .myCustomItemDisabledRTL, .myCustomItemError, .myCustomItemErrorRTL, .myCustomItemFocused, .myCustomItemFocusedRTL, .myCustomItemHint, .myCustomItemHintRTL, .myCustomItemDisabledHint, .myCustomItemDisabledHintRTL { // ... &::-webkit-input-placeholder { color: blue; opacity: 1; } &:-moz-placeholder { color: blue; opacity: 1; } &::-moz-placeholder { color: blue; opacity: 1; } &:-ms-input-placeholder { color: blue; opacity: 1; } }If using Compass, the
input-placeholdermixin that was added in version 1.0 can further simplify the code to style the placeholder text For example:.myCustomItem, .myCustomItemRTL, .myCustomItemDisabled, .myCustomItemDisabledRTL, .myCustomItemError, .myCustomItemErrorRTL, .myCustomItemFocused, .myCustomItemFocusedRTL, .myCustomItemHint, .myCustomItemHintRTL, .myCustomItemDisabledHint, .myCustomItemDisabledHintRTL { // ... @include input-placeholder { color: blue; opacity: 1; } }Accessibility concerns
The HTML5 specification notes that a placeholder should not be used as a replacement for a title. The placeholder is intended to be a short hint that assists the user who is entering a value into the empty field. The placeholder can be mistaken by some users for a pre-filled value, particularly in Internet Explorer because the same color is used, and the placeholder text color may provide insufficient contrast, particularly in Firefox 19+ because of the default 0.4 opacity. Furthermore, not having a title reduces the hit area available for setting focus on the item.- Returns:
- Current usePlaceholderForHint value. Default value is true
- See Also:
-
setWidth
default width of this item- Overrides:
setWidthin classFormItem- Parameters:
width- New width value. Default value is 150- Returns:
TextAreaIteminstance, for chaining setter calls- See Also:
-
getWidth
public int getWidth()default width of this item -
deselectValue
public void deselectValue()If this item currently has focus, clear the current selection. leaving focus in the item. Has no effect if the item is undrawn or unfocused. Only applies to text-based items. -
deselectValue
If this item currently has focus, clear the current selection. leaving focus in the item. Has no effect if the item is undrawn or unfocused. Only applies to text-based items.- Parameters:
start- By default the text insertion cursor will be moved to the end of the current value - pass in this parameter to move to the start instead
-
getEnteredValue
Returns the raw text value that currently appears in the text field, which can differ fromFormItem.getValue()in various cases - for example:- for items that constrain the value range, such as a
DateItemwithenforceDate:true, or aComboBoxItemwithaddUnknownValues:false - for items with a defined valueMap or edit value formatter and parser functions which converts display value to data value
- while the item has focus if
changeOnKeypressis false
- Returns:
- current entered value
- for items that constrain the value range, such as a
-
getSelectionRange
public int[] getSelectionRange()For text-based items, this method returns the indices of the start/end of the current selection if the item currently has the focus. In browsers other than Internet Explorer 6-9, if this item does not have focus, then this method returns the indices of the start/end of the selection the last time that this item had focus. In IE 6-9, returns null if the item does not have focus.In all browsers, clicking anywhere outside of the item causes the item to lose focus; hence, in IE 6-9, this method will not work in other components' event handlers for certain events. For example, within the
click()handler of a button, this item will have already lost focus, so in IE 6-9, this method will return null if called within the button's click() handler. One cross-browser solution to this issue is to save the selection range for later in amouseDown()ormouseOver()handler.Notes:
- In browsers other
than IE 6-9, calling
setValue()or otherwise changing theentered valueinvalidates the past selection range. - The returned indices are indices within the entered value rather than the item's value as
returned by
getValue(). The distinction is particularly important forTextAreaItems because browsers normalize the line endings in the<textarea>element's value. Internet Explorer 6, 7, and 8 convert line endings to "\r\n" while other browsers convert line endings to "\n" as specified by the HTML5 standard.
- Returns:
- 2 element array showing character index of the current or past selection's start and end points within this item's
entered value. In IE 6-9, returns null if the item does not have focus.
- In browsers other
than IE 6-9, calling
-
selectValue
public void selectValue()Put focus in this item and select the entire value. Only applies to text based items -
setSelectionRange
public void setSelectionRange(int start, int end) Puts focus into this form item and selects characters between the given indices. Only applies to drawn text based items.- Parameters:
start- selection starting character indexend- end of selection character index
-
transformPastedValue
Notification fired in response to a clipboard "paste" event on freeform text items, giving developers an opportunity to reformat the pasted text. ThepastedValueargument contains the text pasted from the clipboard. This method should return the text value to actually insert into the input element.- Parameters:
item- Item into which the user pasted a valueform- Pointer to the item's formpastedValue- Pasted text value- Returns:
- Reformatted version of the pasted text.
-
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:
textAreaItemProperties- properties that should be used as new defaults when instances of this class are created- See Also:
-
setWrap
Text wrapping style.- Parameters:
wrap- wrap Default value isTextAreaWrap.SOFT
-
getWrap
Text wrapping style.- Returns:
- TextAreaWrap
-
getValueAsString
Return the value tracked by this form item.- Returns:
- value of this element
-