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:
HasHandlers, HasBlurHandlers, HasChangedHandlers, HasChangeHandlers, HasClickHandlers, HasDoubleClickHandlers, HasFocusHandlers, HasIconClickHandlers, HasIconKeyPressHandlers, HasItemHoverHandlers, HasKeyDownHandlers, HasKeyPressHandlers, HasKeyUpHandlers, HasTitleHoverHandlers
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.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
 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.
static TextAreaItem getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)
           
 java.lang.Boolean getSelectOnFocus()
          Allows the selectOnFocus behavior to be configured on a per-FormItem basis.
 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.
 int getWidth()
          default width of this item
 TextAreaWrap getWrap()
          Text wrapping style.
 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 setSelectOnFocus(java.lang.Boolean selectOnFocus)
          Allows the selectOnFocus behavior to be configured on a per-FormItem basis.
 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.
 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
addBlurHandler, addChangedHandler, addChangeHandler, addClickHandler, addDoubleClickHandler, addFocusHandler, addIconClickHandler, addIconKeyPressHandler, addItemHoverHandler, addKeyDownHandler, addKeyPressHandler, addKeyUpHandler, addTitleHoverHandler, blurItem, disable, enable, focusInItem, getAccessKey, getAlign, getAttribute, getAttributeAsBoolean, getAttributeAsDate, getAttributeAsDouble, getAttributeAsFloat, getAttributeAsInt, getAttributeAsJavaScriptObject, getAttributeAsString, getCellStyle, getConfig, getCriteriaField, getCriterion, getDateFormatter, getDefaultIconSrc, getDisabled, getDisplayField, getDisplayFieldName, getDisplayValue, getDisplayValue, getEmptyDisplayValue, getEmptyValueIcon, getEndRow, getErrorIconHeight, getErrorIconSrc, getErrorIconWidth, getErrorMessageWidth, getFetchMissingValues, getFieldName, getFilterLocally, getGlobalTabIndex, getHint, getHintStyle, getHoverAlign, getHoverDelay, getHoverHeight, getHoverOpacity, getHoverStyle, getHoverVAlign, getHoverWidth, getIconHeight, getIconPageRect, getIconPrompt, getIconRect, getIconWidth, getImageURLPrefix, getImageURLSuffix, getLeft, getName, getOperator, getPickerIconHeight, getPickerIconSrc, getPickerIconWidth, getPrompt, getRejectInvalidValueOnChange, getRequired, getRowSpan, getShouldSaveValue, getShowDisabled, getShowErrorIcon, getShowErrorStyle, getShowErrorText, getShowFocused, getShowFocusedIcons, getShowFocusedPickerIcon, getShowHint, getShowIcons, getShowOverIcons, getShowPickerIcon, getShowTitle, getShowValueIconOnly, getStartRow, getSuppressValueIcon, getTabIndex, getTextAlign, getTimeFormatter, getTitle, getTitleAlign, getTitleOrientation, getTitleStyle, getTooltip, getTop, getType, getValidateOnChange, getValue, getValueField, getValueFieldName, getValueIconHeight, getValueIconLeftPadding, getValueIconRightPadding, getValueIconSize, getValueIconWidth, getVisible, getWrapTitle, hide, isCreated, isDisabled, isDrawn, redraw, setAccessKey, setAlign, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setCellStyle, setColSpan, setColSpan, setCriteriaField, setDateFormatter, setDefaultIconSrc, setDefaultValue, setDefaultValue, setDefaultValue, setDefaultValue, setDefaultValue, setDisabled, setDisplayField, setEditorType, setEmptyDisplayValue, setEmptyValueIcon, setEndRow, setErrorFormatter, setErrorIconHeight, setErrorIconSrc, setErrorIconWidth, setErrorMessageWidth, setErrorOrientation, setFetchMissingValues, setFilterLocally, setGlobalTabIndex, setHeight, setHint, setHintStyle, setHoverAlign, setHoverDelay, setHoverHeight, setHoverOpacity, setHoverStyle, setHoverVAlign, setHoverWidth, setIconHeight, setIconPrompt, setIcons, setIconWidth, setImageURLPrefix, setImageURLSuffix, setInputTransformer, setItemHoverFormatter, setItemTitleHoverFormatter, setLeft, setName, setOperator, setOptionDataSource, setPickerIconHeight, setPickerIconSrc, setPickerIconWidth, setPrompt, setProperty, setProperty, setProperty, setProperty, setRedrawOnChange, setRejectInvalidValueOnChange, setRequired, setRowSpan, setShouldSaveValue, setShowDisabled, setShowErrorIcon, setShowErrorStyle, setShowErrorText, setShowFocused, setShowFocusedIcons, setShowFocusedPickerIcon, setShowHint, setShowIcons, setShowIfCondition, setShowOverIcons, setShowPickerIcon, setShowTitle, setShowValueIconOnly, setStartRow, setSuppressValueIcon, setTabIndex, setTextAlign, setTimeFormatter, setTitle, setTitleAlign, setTitleOrientation, setTitleStyle, setTooltip, setTop, setType, setValidateOnChange, setValidators, setValue, setValue, setValue, setValue, setValue, setValue, setValueField, setValueIconHeight, setValueIconLeftPadding, setValueIconRightPadding, setValueIcons, setValueIconSize, setValueIconWidth, setValueMap, setValueMap, setVisible, setWidth, setWrapTitle, show, stopHover, updateState
 
Methods inherited from class com.smartgwt.client.core.RefDataClass
getRef, getRef
 
Methods inherited from class com.smartgwt.client.core.DataClass
doAddHandler, fireEvent, getAttributeAsIntArray, getAttributeAsMap, getAttributeAsObject, getAttributeAsStringArray, getAttributes, getHandlerCount, getJsObj, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute
 
Methods inherited from class com.smartgwt.client.core.JsObject
setJsObj
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.google.gwt.event.shared.HasHandlers
fireEvent
 
Methods inherited from interface com.google.gwt.event.shared.HasHandlers
fireEvent
 
Methods inherited from interface com.google.gwt.event.shared.HasHandlers
fireEvent
 
Methods inherited from interface com.google.gwt.event.shared.HasHandlers
fireEvent
 
Methods inherited from interface com.google.gwt.event.shared.HasHandlers
fireEvent
 
Methods inherited from interface com.google.gwt.event.shared.HasHandlers
fireEvent
 
Methods inherited from interface com.google.gwt.event.shared.HasHandlers
fireEvent
 
Methods inherited from interface com.google.gwt.event.shared.HasHandlers
fireEvent
 
Methods inherited from interface com.google.gwt.event.shared.HasHandlers
fireEvent
 
Methods inherited from interface com.google.gwt.event.shared.HasHandlers
fireEvent
 
Methods inherited from interface com.google.gwt.event.shared.HasHandlers
fireEvent
 
Methods inherited from interface com.google.gwt.event.shared.HasHandlers
fireEvent
 
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)

setWidth

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

Overrides:
setWidth in class FormItem
Parameters:
width - width Default value is 150

getWidth

public int getWidth()
default width of this item

Overrides:
getWidth in class FormItem
Returns:
int

setHeight

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

Overrides:
setHeight in class FormItem
Parameters:
height - height Default value is 100

getHeight

public int getHeight()
default height of this item

Overrides:
getHeight in class FormItem
Returns:
int

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 - textBoxStyle Default value is "textItem"

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:
String

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 - 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

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 - selectOnFocus Default value is null

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

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