com.sencha.gxt.widget.core.client.form

Class TextArea

java.lang.Object

com.google.gwt.user.client.ui.UIObject

com.google.gwt.user.client.ui.Widget

com.sencha.gxt.widget.core.client.Component

com.sencha.gxt.widget.core.client.cell.CellComponent<T>

com.sencha.gxt.widget.core.client.form.Field<T>

com.sencha.gxt.widget.core.client.form.ValueBaseField<String>

com.sencha.gxt.widget.core.client.form.TextArea

All Implemented Interfaces:

Editor<String>, HasEditorDelegate<String>, HasEditorErrors<String>, LeafValueEditor<String>, ValueAwareEditor<String>, HasChangeHandlers, HasKeyDownHandlers, HasKeyPressHandlers, HasKeyUpHandlers, HasAttachHandlers, HasResizeHandlers, HasValueChangeHandlers<String>, HasHandlers, AutoDirectionHandler.Target, HasDirection, HasDirectionEstimator, EventListener, TakesValue<String>, HasEnabled, HasName, HasText, HasValue<String>, HasVisibility, IsWidget, HasKeyProvider<String>, BeforeHideEvent.HasBeforeHideHandlers, BeforeShowContextMenuEvent.HasBeforeShowContextMenuHandler, BeforeShowEvent.HasBeforeShowHandlers, BlurEvent.HasBlurHandlers, DisableEvent.HasDisableHandlers, EnableEvent.HasEnableHandlers, FocusEvent.HasFocusHandlers, HideEvent.HasHideHandlers, InvalidEvent.HasInvalidHandlers, MoveEvent.HasMoveHandlers, ParseErrorEvent.HasParseErrorHandlers, ShowContextMenuEvent.HasShowContextMenuHandler, ShowEvent.HasShowHandlers, ValidEvent.HasValidHandlers, HasErrorHandler, IsField<String>, HasFocusSupport, HasItemId

public class TextArea
extends ValueBaseField<String>

A multiple line text input field.

Nested Class Summary

Nested classes/interfaces inherited from class com.sencha.gxt.widget.core.client.form.Field

Field.FieldStyles

Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject

UIObject.DebugIdImpl, UIObject.DebugIdImplEnabled

Nested classes/interfaces inherited from interface com.google.gwt.i18n.client.HasDirection

HasDirection.Direction

Field Summary

Fields inherited from class com.google.gwt.user.client.ui.UIObject

DEBUG_ID_PREFIX

Constructor Summary

Constructors

Constructor and Description
TextArea() Creates a new TextArea
TextArea(TextAreaInputCell cell) Creates a new text area with the specified cell.

Method Summary

Methods

Modifier and Type	Method and Description
int	getCursorPos() Gets the cursor position.
TextAreaInputCell.Resizable	getResizable() Returns the resizable value.
int	getSelectionLength() Gets the selection length
boolean	isPreventScrollbars() Returns true if scroll bars are disabled.
void	setPreventScrollbars(boolean preventScrollbars) True to prevent scrollbars from appearing regardless of how much text is in the field (equivalent to setting overflow: hidden, defaults to false.
void	setResizable(TextAreaInputCell.Resizable resizable) Sets whether the field can be resized (defaults to NONE).

Methods inherited from class com.sencha.gxt.widget.core.client.form.ValueBaseField

addChangeHandler, addKeyDownHandler, addKeyPressHandler, addKeyUpHandler, addParseErrorHandler, clear, getCell, getCurrentValue, getDirection, getDirectionEstimator, getEmptyText, getPropertyEditor, getSelectedText, getText, getValueOrThrow, isAllowBlank, isClearValueOnParseError, isCurrentValid, isCurrentValid, isReadOnly, isSelectOnFocus, select, selectAll, setAllowBlank, setClearValueOnParseError, setCursorPos, setDirection, setDirectionEstimator, setDirectionEstimator, setEmptyText, setId, setPropertyEditor, setReadOnly, setSelectionRange, setSelectOnFocus, setTabIndex, setText, setValue, validateCurrent

Methods inherited from class com.sencha.gxt.widget.core.client.form.Field

addInvalidHandler, addValidator, addValidHandler, addValueChangeHandler, clearInvalid, finishEditing, flush, forceInvalid, getErrors, getErrorSupport, getName, getOriginalValue, getValidateOnBlur, getValidationDelay, getValidators, isAutoValidate, isEditing, isValid, isValid, markInvalid, onBrowserEvent, onPropertyChange, removeValidator, reset, setAutoValidate, setDelegate, setErrorSupport, setName, setOriginalValue, setValidateOnBlur, setValidationDelay, setValue, showErrors, validate, validate

Methods inherited from class com.sencha.gxt.widget.core.client.cell.CellComponent

getElement, getKeyProvider, getValue, redraw, setValue

Methods inherited from class com.sencha.gxt.widget.core.client.Component

addBeforeHideHandler, addBeforeShowContextMenuHandler, addBeforeShowHandler, addBlurHandler, addDisableHandler, addEnableHandler, addFocusHandler, addHideHandler, addMoveHandler, addResizeHandler, addShowContextMenuHandler, addShowHandler, addStyleOnOver, clearSizeCache, disable, disableEvents, enable, enableEvents, fireEvent, focus, getData, getFocusSupport, getHideMode, getId, getItemId, getOffsetHeight, getOffsetWidth, getShadow, getShadowPosition, getStateId, getTabIndex, getToolTip, hide, hideToolTip, isAllowTextSelection, isAutoHeight, isAutoWidth, isDeferHeight, isEnabled, isRendered, isStateful, isVisible, isVisible, mask, mask, removeToolTip, setAllowTextSelection, setBorders, setBounds, setBounds, setContextMenu, setData, setDeferHeight, setEnabled, setHeight, setHeight, setHideMode, setItemId, setPagePosition, setPixelSize, setPosition, setShadow, setShadowPosition, setSize, setStateful, setStateId, setToolTip, setToolTip, setToolTipConfig, setVisible, setWidth, setWidth, show, sync, syncSize, unmask

Methods inherited from class com.google.gwt.user.client.ui.Widget

addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, getLayoutData, getParent, isAttached, removeFromParent, setLayoutData, sinkEvents, unsinkEvents

Methods inherited from class com.google.gwt.user.client.ui.UIObject

addStyleDependentName, addStyleName, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getOffsetHeight, getOffsetWidth, getStyleName, getStylePrimaryName, getTitle, isVisible, removeStyleDependentName, removeStyleName, setStyleDependentName, setStyleName, setStyleName, setStylePrimaryName, setTitle, setVisible, sinkBitlessEvent, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.gwt.event.shared.HasHandlers

fireEvent

Methods inherited from interface com.google.gwt.user.client.ui.IsWidget

asWidget

Methods inherited from interface com.google.gwt.user.client.TakesValue

getValue

Methods inherited from interface com.sencha.gxt.widget.core.client.event.BlurEvent.HasBlurHandlers

addBlurHandler

Methods inherited from interface com.google.gwt.user.client.ui.HasValue

getValue, setValue

Constructor Detail

TextArea

public TextArea()

Creates a new TextArea

TextArea

public TextArea(TextAreaInputCell cell)

Creates a new text area with the specified cell.

Parameters:

cell - a text area input cell that renders the text area

Method Detail

getCursorPos

public int getCursorPos()

Gets the cursor position.

Overrides:

getCursorPos in class ValueBaseField<String>

Returns:

returns the cursor position.

getResizable

public TextAreaInputCell.Resizable getResizable()

Returns the resizable value.

Returns:

the resize value

getSelectionLength

public int getSelectionLength()

Gets the selection length

Overrides:

getSelectionLength in class ValueBaseField<String>

Returns:

returns the selection length.

isPreventScrollbars

public boolean isPreventScrollbars()

Returns true if scroll bars are disabled.

Returns:

the scroll bar state

setPreventScrollbars

public void setPreventScrollbars(boolean preventScrollbars)

True to prevent scrollbars from appearing regardless of how much text is in the field (equivalent to setting overflow: hidden, defaults to false.

Parameters:

preventScrollbars - true to disable scroll bars

setResizable

public void setResizable(TextAreaInputCell.Resizable resizable)

Sets whether the field can be resized (defaults to NONE). This method uses the CSS resize property which is only supported on browsers that support CSS3.

Parameters:

resizable - the resizable value