com.smartgwt.client.widgets.form.fields
Class TextAreaItem

java.lang.Object
  extended by com.smartgwt.client.core.JsObject
      extended by com.smartgwt.client.core.DataClass
          extended by com.smartgwt.client.core.RefDataClass
              extended by com.smartgwt.client.widgets.form.fields.FormItem
                  extended by com.smartgwt.client.widgets.form.fields.TextAreaItem
All Implemented Interfaces:
com.google.gwt.event.shared.HasHandlers, HasBlurHandlers, HasChangedHandlers, HasChangeHandlers, HasClickHandlers, HasDoubleClickHandlers, HasEditorEnterHandlers, HasEditorExitHandlers, HasFocusHandlers, HasIconClickHandlers, HasIconKeyPressHandlers, HasItemHoverHandlers, HasKeyDownHandlers, HasKeyPressHandlers, HasKeyUpHandlers, HasPickerIconClickHandlers, HasTitleClickHandlers, HasTitleDoubleClickHandlers, HasTitleHoverHandlers, HasValueHoverHandlers
Direct Known Subclasses:
AutoFitTextAreaItem

public class TextAreaItem
extends FormItem

Class for editable multi-line text areas (uses HTML <TEXTAREA> object)


Field Summary
 
Fields inherited from class com.smartgwt.client.widgets.form.fields.FormItem
scClassName
 
Fields inherited from class com.smartgwt.client.core.RefDataClass
id
 
Fields inherited from class com.smartgwt.client.core.JsObject
jsObj
 
Constructor Summary
TextAreaItem()
           
TextAreaItem(com.google.gwt.core.client.JavaScriptObject jsObj)
           
TextAreaItem(java.lang.String name)
           
TextAreaItem(java.lang.String name, java.lang.String title)
           
 
Method Summary
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)
           
 void deselectValue()
          If this item currently has focus, clear the current selection.
 void deselectValue(java.lang.Boolean start)
          If this item currently has focus, clear the current selection.
 java.lang.Boolean getChangeOnKeypress()
          Should this form item fire its change handler (and store its value in the form) on every keypress? Set to false to suppress the 'change' handler firing (and the value stored) on every keypress.
 java.lang.String getEnteredValue()
          Returns the raw text value that currently appears in the text field, which can differ from FormItem.getValue in various cases - for example: for items that constrain the value range, such as a DateItem with enforceDate:true, or a ComboBoxItem with addUnknownValues: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 changeOnKeypress is false
 java.lang.Boolean getFormatOnBlur()
          With formatOnBlur enabled, this textAreaItem will format its value according to any specified static static formatter as long as the item does not have focus.
 int getHeight()
          default height of this item
 VerticalAlignment getIconVAlign()
          Align icons with the top edge of text area icons by default.
 java.lang.Integer getLength()
          Return the length.
 int getMinHeight()
          Minimum valid height for this TextAreaItem in px.
static TextAreaItem getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)
           
 java.lang.Boolean 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.
 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.
 java.lang.Boolean getSelectOnClick()
          Allows the selectOnClick behavior to be configured on a per-FormItem basis.
 java.lang.Boolean getSelectOnFocus()
          Allows the selectOnFocus behavior to be configured on a per-FormItem basis.
 java.lang.Boolean getShowHintInField()
          If showing hint for this form item, should it be shown within the field?
 java.lang.String getTextBoxStyle()
          Base CSS class to apply to this item's input element.
 java.lang.String getValueAsString()
          Return the value tracked by this form item.
 int getWidth()
          default width of this item
 TextAreaWrap getWrap()
          Text wrapping style.
 void selectValue()
          Put focus in this item and select the entire value.
 void setChangeOnKeypress(java.lang.Boolean changeOnKeypress)
          Should this form item fire its change handler (and store its value in the form) on every keypress? Set to false to suppress the 'change' handler firing (and the value stored) on every keypress.
static void setDefaultProperties(TextAreaItem textAreaItemProperties)
          Class level method to set the default properties of this class.
 void setFormatOnBlur(java.lang.Boolean formatOnBlur)
          With formatOnBlur enabled, this textAreaItem will format its value according to any specified static static formatter as long as the item does not have focus.
 void setHeight(int height)
          default height of this item
 void setIconVAlign(VerticalAlignment iconVAlign)
          Align icons with the top edge of text area icons by default.
 void setLength(java.lang.Integer length)
          Set the length.
 void setMinHeight(int minHeight)
          Minimum valid height for this TextAreaItem in px.
 void setPrintFullText(java.lang.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.
 void setSelectionRange(int start, int end)
          Puts focus into this form item and selects characters between the given indices.
 void setSelectOnClick(java.lang.Boolean selectOnClick)
          Allows the selectOnClick behavior to be configured on a per-FormItem basis.
 void setSelectOnFocus(java.lang.Boolean selectOnFocus)
          Allows the selectOnFocus behavior to be configured on a per-FormItem basis.
 void setShowHintInField(java.lang.Boolean showHintInField)
          If showing hint for this form item, should it be shown within the field?
 void setTextBoxStyle(java.lang.String textBoxStyle)
          Base CSS class to apply to this item's input element.
 void setWidth(int width)
          default width of this item
 void setWrap(TextAreaWrap wrap)
          Text wrapping style.
 
Methods inherited from class com.smartgwt.client.widgets.form.fields.FormItem
_getValue, addBlurHandler, addChangedHandler, addChangeHandler, addClickHandler, addDoubleClickHandler, addEditorEnterHandler, addEditorExitHandler, addFocusHandler, addIconClickHandler, addIconKeyPressHandler, addItemHoverHandler, addKeyDownHandler, addKeyPressHandler, addKeyUpHandler, addPickerIconClickHandler, addTitleClickHandler, addTitleDoubleClickHandler, addTitleHoverHandler, addValueHoverHandler, asSGWTComponent, blurItem, canEditCriterion, clearValue, disable, enable, focusInItem, getAccessKey, getAlign, getAllowExpressions, getAlwaysFetchMissingValues, getApplyHeightToTextBox, getAriaRole, getAttribute, getAttributeAsBoolean, getAttributeAsDate, getAttributeAsDouble, getAttributeAsFloat, getAttributeAsInt, getAttributeAsJavaScriptObject, getAttributeAsObject, getAttributeAsString, getBrowserSpellCheck, getCanEdit, getCanFocus, getCanvasAutoChild, getCellHeight, getCellStyle, getClassName, getClipTitle, getConfig, getContainerWidget, getControlStyle, getCriteriaField, getCriterion, getCriterion, getDataPath, getDateFormatter, getDecimalPad, getDecimalPrecision, getDefaultIconSrc, getDisabled, getDisableIconsOnReadOnly, getDisplayField, getDisplayFieldName, getDisplayValue, getDisplayValue, getEditorTypeConfig, getEditPendingCSSText, getEmptyDisplayValue, getEmptyValueIcon, getEndRow, getErrorIconHeight, getErrorIconSrc, getErrorIconWidth, getErrorMessageWidth, getExportFormat, getFetchMissingValues, getFieldName, getFilterLocally, getForm, getFormat, getFormItemAutoChild, getFullDataPath, getGlobalTabIndex, getHeightAsString, getHint, getHintStyle, getHoverAlign, getHoverDelay, getHoverHeight, getHoverOpacity, getHoverStyle, getHoverVAlign, getHoverWidth, getIcon, getIconHeight, getIconHSpace, getIconPageRect, getIconPrompt, getIconRect, getIconWidth, getImageURLPrefix, getImageURLSuffix, getImplicitSave, getImplicitSaveOnBlur, getInputFormat, getLeft, getLoadingDisplayValue, getLocateItemBy, getMultipleValueSeparator, getName, getOperator, getOptionCriteria, getOptionFilterContext, getOptionOperationId, getPageLeft, getPageRect, getPageTop, getPicker, getPickerIconHeight, getPickerIconName, getPickerIconPrompt, getPickerIconProperties, getPickerIconSrc, getPickerIconStyle, getPickerIconWidth, getPixelHeight, getPixelWidth, getPrintTextBoxStyle, getPrintTitleStyle, getPrompt, getReadOnlyClipValue, getReadOnlyDisplay, getReadOnlyTextBoxStyle, getRect, getRedrawOnChange, getRejectInvalidValueOnChange, getRequired, getRequiredMessage, getRowSpan, getSaveOnEnter, getScClassName, getSelectedRecord, getShouldSaveValue, getShowClippedTitleOnHover, getShowClippedValueOnHover, getShowDisabled, getShowErrorIcon, getShowErrorStyle, getShowErrorText, getShowFocused, getShowFocusedErrorState, getShowFocusedIcons, getShowFocusedPickerIcon, getShowHint, getShowIcons, getShowOverIcons, getShowPickerIcon, getShowRTL, getShowTitle, getShowValueIconOnly, getStartRow, getStopOnError, getSuppressValueIcon, getSynchronousValidation, getTabIndex, getTextAlign, getTimeFormatter, getTitle, getTitleAlign, getTitleColSpan, getTitleOrientation, getTitleStyle, getTitleVAlign, getTooltip, getTop, getType, getValidateOnChange, getValidateOnExit, getValidOperators, getVAlign, getValue, getValueAsRecordList, getValueField, getValueFieldName, getValueIconHeight, getValueIconLeftPadding, getValueIconRightPadding, getValueIconSize, getValueIconWidth, getVisible, getVisibleHeight, getVisibleWidth, getWidthAsString, getWrapTitle, hasAdvancedCriteria, hide, hideIcon, invalidateDisplayValueCache, isCreated, isDisabled, isDrawn, isVisible, redraw, setAccessKey, setAlign, setAllowExpressions, setAlwaysFetchMissingValues, setApplyHeightToTextBox, setAriaRole, setAriaState, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAutoChildConstructor, setAutoChildProperties, setAutoChildProperties, setAutoChildVisibility, setBrowserSpellCheck, setCanEdit, setCanEditCriterionPredicate, setCanFocus, setCellHeight, setCellStyle, setClipTitle, setColSpan, setColSpan, setControlStyle, setCriteriaField, setCriterion, setCriterionGetter, setCriterionSetter, 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, setEmptyDisplayValue, setEmptyValueIcon, setEndRow, setErrorFormatter, setErrorIconHeight, setErrorIconSrc, setErrorIconWidth, setErrorMessageWidth, setErrorOrientation, setExportFormat, setFetchMissingValues, setFilterLocally, setFormat, setGlobalTabIndex, setHeight, setHint, setHintStyle, setHoverAlign, setHoverDelay, setHoverHeight, setHoverOpacity, setHoverStyle, setHoverVAlign, setHoverWidth, setIconHeight, setIconHSpace, setIconPrompt, setIcons, setIconWidth, setImageURLPrefix, setImageURLSuffix, setImplicitSave, setImplicitSaveOnBlur, setInitHandler, setInputFormat, setInputTransformer, setItemHoverFormatter, setItemTitleHoverFormatter, setItemValueHoverFormatter, setLeft, setLoadingDisplayValue, setLocateItemBy, setMultipleValueSeparator, setName, setOperator, setOptionCriteria, setOptionDataSource, setOptionFilterContext, setOptionOperationId, setPickerIconHeight, setPickerIconName, setPickerIconPrompt, setPickerIconProperties, setPickerIconSrc, setPickerIconStyle, setPickerIconWidth, setPrintTextBoxStyle, setPrintTitleStyle, setPrompt, setProperty, setProperty, setProperty, setProperty, setProperty, setReadOnlyClipValue, setReadOnlyDisplay, setReadOnlyTextBoxStyle, setRedrawOnChange, setRejectInvalidValueOnChange, setRequired, setRequiredMessage, setRowSpan, setSaveOnEnter, setScClassName, setShouldSaveValue, setShowClippedTitleOnHover, setShowClippedValueOnHover, setShowDisabled, setShowErrorIcon, setShowErrorStyle, setShowErrorText, setShowFocused, setShowFocusedErrorState, setShowFocusedIcons, setShowFocusedPickerIcon, setShowHint, setShowIcons, setShowIfCondition, setShowOverIcons, setShowPickerIcon, setShowRTL, setShowTitle, setShowValueIconOnly, setStartRow, setStopOnError, setSuppressValueIcon, setSynchronousValidation, setTabIndex, setTextAlign, setTimeFormatter, setTitle, setTitleAlign, setTitleColSpan, setTitleHoverFormatter, setTitleOrientation, setTitleStyle, setTitleVAlign, setTooltip, setTop, setType, setValidateOnChange, setValidateOnExit, setValidators, setValidOperators, setVAlign, setValue, setValue, setValue, setValue, setValue, setValue, setValueField, setValueFormatter, setValueHoverFormatter, setValueIconHeight, setValueIconLeftPadding, setValueIconMapper, setValueIconRightPadding, setValueIcons, setValueIconSize, setValueIconWidth, setValueMap, setValueMap, setVisible, setWidth, setWrapTitle, shouldApplyHeightToTextBox, shouldFetchMissingValue, shouldSaveOnEnter, show, showIcon, showPicker, stopHover, storeValue, storeValue, updateState, validate, valueClipped
 
Methods inherited from class com.smartgwt.client.core.RefDataClass
getRef, getRef, internalSetID
 
Methods inherited from class com.smartgwt.client.core.DataClass
doAddHandler, fireEvent, getAttributeAsDoubleArray, getAttributeAsIntArray, getAttributeAsLong, getAttributeAsMap, getAttributeAsObject, getAttributeAsRecord, getAttributeAsStringArray, getAttributes, getHandlerCount, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttributeAsJavaObject
 
Methods inherited from class com.smartgwt.client.core.JsObject
equals, getJsObj, hashCode, setJavaScriptObject, setJsObj
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.google.gwt.event.shared.HasHandlers
fireEvent
 

Constructor Detail

TextAreaItem

public TextAreaItem()

TextAreaItem

public TextAreaItem(com.google.gwt.core.client.JavaScriptObject jsObj)

TextAreaItem

public TextAreaItem(java.lang.String name)

TextAreaItem

public TextAreaItem(java.lang.String name,
                    java.lang.String title)
Method Detail

getOrCreateRef

public static TextAreaItem getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)

changeAutoChildDefaults

public static void changeAutoChildDefaults(java.lang.String autoChildName,
                                           Canvas defaults)
Changes the defaults for Canvas AutoChildren named autoChildName.

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.
See Also:
AutoChildUsage

changeAutoChildDefaults

public static void changeAutoChildDefaults(java.lang.String autoChildName,
                                           FormItem defaults)
Changes the defaults for FormItem AutoChildren named autoChildName.

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.
See Also:
AutoChildUsage

changePickerIconDefaults

public static void changePickerIconDefaults(FormItemIcon defaults)

setChangeOnKeypress

public void setChangeOnKeypress(java.lang.Boolean changeOnKeypress)
Should this form item fire its change handler (and store its value in the form) on every keypress? Set to false to suppress the 'change' handler firing (and the value stored) on every keypress.

Note: If false, the value returned by getValue will not reflect the value displayed in the form item element as long as focus is in the form item element.

Overrides:
setChangeOnKeypress in class FormItem
Parameters:
changeOnKeypress - Default value is true

getChangeOnKeypress

public java.lang.Boolean getChangeOnKeypress()
Should this form item fire its change handler (and store its value in the form) on every keypress? Set to false to suppress the 'change' handler firing (and the value stored) on every keypress.

Note: If false, the value returned by getValue will not reflect the value displayed in the form item element as long as focus is in the form item element.

Overrides:
getChangeOnKeypress in class FormItem
Returns:
Boolean

setFormatOnBlur

public void setFormatOnBlur(java.lang.Boolean formatOnBlur)
With formatOnBlur enabled, this textAreaItem will format its value according to any specified static static formatter 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 simply way for developers to show a nicely formatted display value in a freeform text field, without the need for an explicit FormItem.formatEditorValue and FormItem.parseEditorValue pair.

Parameters:
formatOnBlur - Default value is false

getFormatOnBlur

public java.lang.Boolean getFormatOnBlur()
With formatOnBlur enabled, this textAreaItem will format its value according to any specified static static formatter 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 simply way for developers to show a nicely formatted display value in a freeform text field, without the need for an explicit FormItem.formatEditorValue and FormItem.parseEditorValue pair.

Returns:
Boolean

setHeight

public void setHeight(int height)
default height of this item

Overrides:
setHeight in class FormItem
Parameters:
height - Default value is 100
See Also:
Appearance overview and related methods

getHeight

public int getHeight()
default height of this item

Overrides:
getHeight in class FormItem
Returns:
int
See Also:
Appearance overview and related methods

setIconVAlign

public void setIconVAlign(VerticalAlignment iconVAlign)
Align icons with the top edge of text area icons by default.

Overrides:
setIconVAlign in class FormItem
Parameters:
iconVAlign - Default value is Canvas.TOP

getIconVAlign

public VerticalAlignment getIconVAlign()
Align icons with the top edge of text area icons by default.

Overrides:
getIconVAlign in class FormItem
Returns:
VerticalAlignment

setMinHeight

public void setMinHeight(int minHeight)
Minimum valid height for this TextAreaItem in px. If the specified height is less than this value, the text area will still render at this height.

Parameters:
minHeight - Default value is 16

getMinHeight

public int getMinHeight()
Minimum valid height for this TextAreaItem in px. If the specified height is less than this value, the text area will still render at this height.

Returns:
int

setPrintFullText

public void setPrintFullText(java.lang.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.

Parameters:
printFullText - Default value is true
See Also:
Printing overview and related methods

getPrintFullText

public java.lang.Boolean 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:
Boolean
See Also:
Printing overview and related methods

setSelectOnClick

public void setSelectOnClick(java.lang.Boolean selectOnClick)
Allows the selectOnClick behavior to be configured on a per-FormItem basis. Normally all items in a form default to the value of selectOnClick.

Overrides:
setSelectOnClick in class FormItem
Parameters:
selectOnClick - Default value is null
See Also:
Focus overview and related methods

getSelectOnClick

public java.lang.Boolean getSelectOnClick()
Allows the selectOnClick behavior to be configured on a per-FormItem basis. Normally all items in a form default to the value of selectOnClick.

Overrides:
getSelectOnClick in class FormItem
Returns:
Boolean
See Also:
Focus overview and related methods

setSelectOnFocus

public void setSelectOnFocus(java.lang.Boolean selectOnFocus)
Allows the selectOnFocus behavior to be configured on a per-FormItem basis. Normally all items in a form default to the value of selectOnFocus.

Overrides:
setSelectOnFocus in class FormItem
Parameters:
selectOnFocus - Default value is null
See Also:
Focus overview and related methods

getSelectOnFocus

public java.lang.Boolean getSelectOnFocus()
Allows the selectOnFocus behavior to be configured on a per-FormItem basis. Normally all items in a form default to the value of selectOnFocus.

Overrides:
getSelectOnFocus in class FormItem
Returns:
Boolean
See Also:
Focus overview and related methods

setShowHintInField

public void setShowHintInField(java.lang.Boolean showHintInField)
If showing hint for this form item, should it be shown within the field?

CSS style for the hint is textBoxStyle with the suffix "Hint" appended to it.

Note : This is an advanced setting

Parameters:
showHintInField - Default value is null
See Also:
FormItem.setHint(java.lang.String), Appearance overview and related methods

getShowHintInField

public java.lang.Boolean getShowHintInField()
If showing hint for this form item, should it be shown within the field?

CSS style for the hint is textBoxStyle with the suffix "Hint" appended to it.

Returns:
Boolean
See Also:
FormItem.getHint(), Appearance overview and related methods

setTextBoxStyle

public void setTextBoxStyle(java.lang.String textBoxStyle)
Base CSS class to apply to this item's input element. NOTE: See the CompoundFormItem_skinning discussion for special skinning considerations.

Overrides:
setTextBoxStyle in class FormItem
Parameters:
textBoxStyle - See FormItemBaseStyle . Default value is "textItem"
See Also:
Appearance overview and related methods

getTextBoxStyle

public java.lang.String getTextBoxStyle()
Base CSS class to apply to this item's input element. NOTE: See the CompoundFormItem_skinning discussion for special skinning considerations.

Overrides:
getTextBoxStyle in class FormItem
Returns:
See FormItemBaseStyle
See Also:
Appearance overview and related methods

setWidth

public void setWidth(int width)
default width of this item

Overrides:
setWidth in class FormItem
Parameters:
width - Default value is 150
See Also:
Appearance overview and related methods

getWidth

public int getWidth()
default width of this item

Overrides:
getWidth in class FormItem
Returns:
int
See Also:
Appearance overview and related methods

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

public void deselectValue(java.lang.Boolean start)
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

public java.lang.String getEnteredValue()
Returns the raw text value that currently appears in the text field, which can differ from FormItem.getValue in various cases - for example:

Returns:
current entered value

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 a mouseDown() or mouseOver() handler.

Notes:

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.

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 index
end - end of selection character index

setDefaultProperties

public static void setDefaultProperties(TextAreaItem textAreaItemProperties)
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

setLength

public void setLength(java.lang.Integer length)
Set the length.

Parameters:
length - the length

getLength

public java.lang.Integer getLength()
Return the length.

Returns:
the length

setWrap

public void setWrap(TextAreaWrap wrap)
Text wrapping style.

Parameters:
wrap - wrap Default value is TextAreaWrap.SOFT

getWrap

public TextAreaWrap getWrap()
Text wrapping style.

Returns:
TextAreaWrap

getValueAsString

public java.lang.String getValueAsString()
Return the value tracked by this form item.

Returns:
value of this element