Class TextArea
- java.lang.Object
-
- com.google.gwt.user.client.ui.UIObject
-
- com.google.gwt.user.client.ui.Widget
-
- com.google.gwt.user.client.ui.FocusWidget
-
- de.knightsoftnet.validators.client.editor.ValueBoxBase<T>
-
- de.knightsoftnet.mtwidgets.client.ui.widget.ValueBoxBaseWithEditorErrors<String>
-
- de.knightsoftnet.mtwidgets.client.ui.widget.TextBoxBase
-
- de.knightsoftnet.mtwidgets.client.ui.widget.TextArea
-
- All Implemented Interfaces:
com.google.gwt.event.dom.client.HasAllDragAndDropHandlers,com.google.gwt.event.dom.client.HasAllFocusHandlers,com.google.gwt.event.dom.client.HasAllGestureHandlers,com.google.gwt.event.dom.client.HasAllKeyHandlers,com.google.gwt.event.dom.client.HasAllMouseHandlers,com.google.gwt.event.dom.client.HasAllTouchHandlers,com.google.gwt.event.dom.client.HasBlurHandlers,com.google.gwt.event.dom.client.HasChangeHandlers,com.google.gwt.event.dom.client.HasClickHandlers,com.google.gwt.event.dom.client.HasDoubleClickHandlers,com.google.gwt.event.dom.client.HasDragEndHandlers,com.google.gwt.event.dom.client.HasDragEnterHandlers,com.google.gwt.event.dom.client.HasDragHandlers,com.google.gwt.event.dom.client.HasDragLeaveHandlers,com.google.gwt.event.dom.client.HasDragOverHandlers,com.google.gwt.event.dom.client.HasDragStartHandlers,com.google.gwt.event.dom.client.HasDropHandlers,com.google.gwt.event.dom.client.HasFocusHandlers,com.google.gwt.event.dom.client.HasGestureChangeHandlers,com.google.gwt.event.dom.client.HasGestureEndHandlers,com.google.gwt.event.dom.client.HasGestureStartHandlers,com.google.gwt.event.dom.client.HasKeyDownHandlers,com.google.gwt.event.dom.client.HasKeyPressHandlers,com.google.gwt.event.dom.client.HasKeyUpHandlers,com.google.gwt.event.dom.client.HasMouseDownHandlers,com.google.gwt.event.dom.client.HasMouseMoveHandlers,com.google.gwt.event.dom.client.HasMouseOutHandlers,com.google.gwt.event.dom.client.HasMouseOverHandlers,com.google.gwt.event.dom.client.HasMouseUpHandlers,com.google.gwt.event.dom.client.HasMouseWheelHandlers,com.google.gwt.event.dom.client.HasTouchCancelHandlers,com.google.gwt.event.dom.client.HasTouchEndHandlers,com.google.gwt.event.dom.client.HasTouchMoveHandlers,com.google.gwt.event.dom.client.HasTouchStartHandlers,com.google.gwt.event.logical.shared.HasAttachHandlers,com.google.gwt.event.logical.shared.HasValueChangeHandlers<String>,com.google.gwt.event.shared.HasHandlers,com.google.gwt.i18n.client.AutoDirectionHandler.Target,com.google.gwt.i18n.client.HasDirection,com.google.gwt.i18n.shared.HasDirectionEstimator,com.google.gwt.user.client.EventListener,com.google.gwt.user.client.TakesValue<String>,com.google.gwt.user.client.ui.Focusable,com.google.gwt.user.client.ui.HasEnabled,com.google.gwt.user.client.ui.HasFocus,com.google.gwt.user.client.ui.HasName,com.google.gwt.user.client.ui.HasText,com.google.gwt.user.client.ui.HasValue<String>,com.google.gwt.user.client.ui.HasVisibility,com.google.gwt.user.client.ui.IsWidget,com.google.gwt.user.client.ui.SourcesClickEvents,com.google.gwt.user.client.ui.SourcesFocusEvents,com.google.gwt.user.client.ui.SourcesKeyboardEvents,com.google.gwt.user.client.ui.SourcesMouseEvents,HasAutocomplete,HasAutofocus,HasDataList,HasFormNoValidate,HasPlaceholder,HasRequired,HasValidationMessageElement<String,ValueBoxEditor<String>>,HasValidationPattern,HasValidity,org.gwtproject.editor.client.Editor<String>,org.gwtproject.editor.client.HasEditorErrors<String>,org.gwtproject.editor.client.IsEditor<ValueBoxEditor<String>>,org.gwtproject.editor.client.TakesValue<String>
public class TextArea extends TextBoxBase
A text box that allows multiple lines of text to be entered.<img class='gallery' src='doc-files/TextArea.png'/>
CSS Style Rules
- .gwt-TextArea { primary style }
- .gwt-TextArea-readonly { dependent style set when the text area is read-only }
Built-in Bidi Text Support
This widget is capable of automatically adjusting its direction according to the input text. This feature is controlled by
ValueBoxBase.setDirectionEstimator(boolean), and is available by default when at least one of the application's locales is right-to-left.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class de.knightsoftnet.validators.client.editor.ValueBoxBase
ValueBoxBase.TextAlignment
-
Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject
com.google.gwt.user.client.ui.UIObject.DebugIdImpl, com.google.gwt.user.client.ui.UIObject.DebugIdImplEnabled
-
-
Field Summary
-
Fields inherited from class de.knightsoftnet.mtwidgets.client.ui.widget.ValueBoxBaseWithEditorErrors
validationMessageElement
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description booleancheckValidity()Returns false if the element is a candidate for constraint validation, and it does not satisfy its constraints.StringgetAutocomplete()get autocomplete attribute value.intgetCharacterWidth()Gets the requested width of the text box (this is not an exact value, as not all characters are created equal).intgetCursorPos()elemental2.dom.HTMLInputElementgetInputElement()intgetMaxLength()Gets the maximum allowable length of the text box.StringgetPattern()get validation pattern.StringgetPlaceholder()get place holder text.intgetSelectionLength()StringgetValidationMessage()A localized message that describes the validation constraints that the control does not satisfy (if any).elemental2.dom.ValidityStategetValidity()The validity states that this element is in.intgetVisibleLines()Gets the number of text lines that are visible.booleanisAutofocus()get autofocus value.booleanisFormNoValidate()check if validation of the widget is enabled (doesn't affect bean validation).booleanisRequired()Reflects therequiredHTML attribute, indicating that the user must fill in a value before submitting a form.voidsetAutocomplete(String arg)set autocomplete attribute value.voidsetAutofocus(boolean arg)set autofocus value.voidsetCharacterWidth(int width)Sets the requested width of the text box (this is not an exact value, as not all characters are created equal).voidsetCustomValidity(String message)set custom validity if supported.voidsetFormNoValidate(boolean arg)enable/disable validation of the widget (doesn't affect bean validation).voidsetMaxLength(int length)Sets the maximum allowable length of the text box.voidsetPattern(String arg)set validation pattern.voidsetPlaceholder(String arg)set place holder text.voidsetRequired(boolean arg)Reflects therequiredHTML attribute, indicating that the user must fill in a value before submitting a form.voidsetVisibleLines(int lines)Sets the number of text lines that are visible.static TextAreawrap(com.google.gwt.dom.client.Element element)Creates a TextArea widget that wraps an existing <textarea> element.-
Methods inherited from class de.knightsoftnet.mtwidgets.client.ui.widget.TextBoxBase
getValue
-
Methods inherited from class de.knightsoftnet.mtwidgets.client.ui.widget.ValueBoxBaseWithEditorErrors
getValidationMessageElement, setDataListWidget, setValidationMessageElement
-
Methods inherited from class de.knightsoftnet.validators.client.editor.ValueBoxBase
addChangeHandler, addValueChangeHandler, asEditor, cancelKey, getDirection, getDirectionEstimator, getImpl, getName, getSelectedText, getText, getValueOrThrow, hasParser, isReadOnly, oldToNew, oldToNew, onBrowserEvent, onLoad, removeChangeListener, selectAll, setAlignment, setCursorPos, setDirection, setDirectionEstimator, setDirectionEstimator, setKey, setName, setReadOnly, setSelectionRange, setText, setValue, setValue
-
Methods inherited from class com.google.gwt.user.client.ui.FocusWidget
addBlurHandler, addClickHandler, addClickListener, addDoubleClickHandler, addDragEndHandler, addDragEnterHandler, addDragHandler, addDragLeaveHandler, addDragOverHandler, addDragStartHandler, addDropHandler, addFocusHandler, addFocusListener, addGestureChangeHandler, addGestureEndHandler, addGestureStartHandler, addKeyboardListener, addKeyDownHandler, addKeyPressHandler, addKeyUpHandler, addMouseDownHandler, addMouseListener, addMouseMoveHandler, addMouseOutHandler, addMouseOverHandler, addMouseUpHandler, addMouseWheelHandler, addMouseWheelListener, addTouchCancelHandler, addTouchEndHandler, addTouchMoveHandler, addTouchStartHandler, getFocusImpl, getTabIndex, isEnabled, onAttach, removeClickListener, removeFocusListener, removeKeyboardListener, removeMouseListener, removeMouseWheelListener, setAccessKey, setEnabled, setFocus, setTabIndex
-
Methods inherited from class com.google.gwt.user.client.ui.Widget
addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, doAttachChildren, doDetachChildren, fireEvent, getHandlerCount, getLayoutData, getParent, isAttached, isOrWasAttached, onDetach, onUnload, removeFromParent, setLayoutData, sinkEvents, unsinkEvents
-
Methods inherited from class com.google.gwt.user.client.ui.UIObject
addStyleDependentName, addStyleName, ensureDebugId, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getElement, getOffsetHeight, getOffsetWidth, getStyleElement, getStyleName, getStyleName, getStylePrimaryName, getStylePrimaryName, getTitle, isVisible, isVisible, onEnsureDebugId, removeStyleDependentName, removeStyleName, resolvePotentialElement, setElement, setElement, setHeight, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setTitle, setVisible, setVisible, setWidth, sinkBitlessEvent, toString
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface de.knightsoftnet.mtwidgets.client.ui.widget.features.HasValidationMessageElement
editorErrorMatches, setTitle, showErrors, showErrors
-
-
-
-
Constructor Detail
-
TextArea
public TextArea()
Creates an empty text area.
-
TextArea
protected TextArea(com.google.gwt.dom.client.Element element)
This constructor may be used by subclasses to explicitly use an existing element. This element must be a <textarea> element.- Parameters:
element- the element to be used
-
-
Method Detail
-
wrap
public static TextArea wrap(com.google.gwt.dom.client.Element element)
Creates a TextArea widget that wraps an existing <textarea> element.This element must already be attached to the document. If the element is removed from the document, you must call
RootPanel.detachNow(Widget).- Parameters:
element- the element to be wrapped- Returns:
- text area widget
-
getCharacterWidth
public int getCharacterWidth()
Gets the requested width of the text box (this is not an exact value, as not all characters are created equal).- Returns:
- the requested width, in characters
-
getCursorPos
public int getCursorPos()
- Overrides:
getCursorPosin classValueBoxBase<String>
-
getSelectionLength
public int getSelectionLength()
- Overrides:
getSelectionLengthin classValueBoxBase<String>
-
getVisibleLines
public int getVisibleLines()
Gets the number of text lines that are visible.- Returns:
- the number of visible lines
-
setCharacterWidth
public void setCharacterWidth(int width)
Sets the requested width of the text box (this is not an exact value, as not all characters are created equal).- Parameters:
width- the requested width, in characters
-
setVisibleLines
public void setVisibleLines(int lines)
Sets the number of text lines that are visible.- Parameters:
lines- the number of visible lines
-
setCustomValidity
public void setCustomValidity(String message)
Description copied from class:ValueBoxBaseWithEditorErrorsset custom validity if supported.- Specified by:
setCustomValidityin interfaceHasValidationMessageElement<String,ValueBoxEditor<String>>- Overrides:
setCustomValidityin classValueBoxBaseWithEditorErrors<String>- Parameters:
message- message to set
-
getInputElement
public elemental2.dom.HTMLInputElement getInputElement()
- Overrides:
getInputElementin classValueBoxBaseWithEditorErrors<String>
-
getValidationMessage
public String getValidationMessage()
Description copied from interface:HasValidityA localized message that describes the validation constraints that the control does not satisfy (if any). This is the empty string if the control is not a candidate for constraint validation (willValidate is false), or it satisfies its constraints.- Specified by:
getValidationMessagein interfaceHasValidity- Overrides:
getValidationMessagein classValueBoxBaseWithEditorErrors<String>- Returns:
- localized validation message
-
getValidity
public elemental2.dom.ValidityState getValidity()
Description copied from interface:HasValidityThe validity states that this element is in.- Specified by:
getValidityin interfaceHasValidity- Overrides:
getValidityin classValueBoxBaseWithEditorErrors<String>- Returns:
- ValidityState
-
checkValidity
public boolean checkValidity()
Description copied from interface:HasValidityReturns false if the element is a candidate for constraint validation, and it does not satisfy its constraints. In this case, it also fires aninvalidevent at the element. It returns true if the element is not a candidate for constraint validation, or if it satisfies its constraints.- Specified by:
checkValidityin interfaceHasValidity- Overrides:
checkValidityin classValueBoxBaseWithEditorErrors<String>- Returns:
- true if input is valid
-
isFormNoValidate
public boolean isFormNoValidate()
Description copied from interface:HasFormNoValidatecheck if validation of the widget is enabled (doesn't affect bean validation).- Specified by:
isFormNoValidatein interfaceHasFormNoValidate- Overrides:
isFormNoValidatein classValueBoxBaseWithEditorErrors<String>- Returns:
- true if validation is disabled
-
setFormNoValidate
public void setFormNoValidate(boolean arg)
Description copied from interface:HasFormNoValidateenable/disable validation of the widget (doesn't affect bean validation).- Specified by:
setFormNoValidatein interfaceHasFormNoValidate- Overrides:
setFormNoValidatein classValueBoxBaseWithEditorErrors<String>- Parameters:
arg- true if validation should be disabled
-
isRequired
public boolean isRequired()
Description copied from interface:HasRequiredReflects therequiredHTML attribute, indicating that the user must fill in a value before submitting a form.- Specified by:
isRequiredin interfaceHasRequired- Overrides:
isRequiredin classValueBoxBaseWithEditorErrors<String>- Returns:
- required true/false
-
setRequired
public void setRequired(boolean arg)
Description copied from interface:HasRequiredReflects therequiredHTML attribute, indicating that the user must fill in a value before submitting a form.- Specified by:
setRequiredin interfaceHasRequired- Overrides:
setRequiredin classValueBoxBaseWithEditorErrors<String>- Parameters:
arg- required true/false
-
getPattern
public String getPattern()
Description copied from interface:HasValidationPatternget validation pattern.- Specified by:
getPatternin interfaceHasValidationPattern- Overrides:
getPatternin classValueBoxBaseWithEditorErrors<String>- Returns:
- regular expression used to validate
-
setPattern
public void setPattern(String arg)
Description copied from interface:HasValidationPatternset validation pattern.- Specified by:
setPatternin interfaceHasValidationPattern- Overrides:
setPatternin classValueBoxBaseWithEditorErrors<String>- Parameters:
arg- regular expression should be used to validate
-
getPlaceholder
public String getPlaceholder()
Description copied from interface:HasPlaceholderget place holder text.- Specified by:
getPlaceholderin interfaceHasPlaceholder- Overrides:
getPlaceholderin classValueBoxBaseWithEditorErrors<String>- Returns:
- place holder text displayed when value is empty
-
setPlaceholder
public void setPlaceholder(String arg)
Description copied from interface:HasPlaceholderset place holder text.- Specified by:
setPlaceholderin interfaceHasPlaceholder- Overrides:
setPlaceholderin classValueBoxBaseWithEditorErrors<String>- Parameters:
arg- place holder text displayed when value is empty
-
isAutofocus
public boolean isAutofocus()
Description copied from interface:HasAutofocusget autofocus value.- Specified by:
isAutofocusin interfaceHasAutofocus- Overrides:
isAutofocusin classValueBoxBaseWithEditorErrors<String>- Returns:
- true if input field has autofocus
-
setAutofocus
public void setAutofocus(boolean arg)
Description copied from interface:HasAutofocusset autofocus value.- Specified by:
setAutofocusin interfaceHasAutofocus- Overrides:
setAutofocusin classValueBoxBaseWithEditorErrors<String>- Parameters:
arg- true if input field has autofocus
-
getAutocomplete
public String getAutocomplete()
Description copied from interface:HasAutocompleteget autocomplete attribute value.- Specified by:
getAutocompletein interfaceHasAutocomplete- Overrides:
getAutocompletein classValueBoxBaseWithEditorErrors<String>- Returns:
- input field autocomplete attribute value
-
setAutocomplete
public void setAutocomplete(String arg)
Description copied from interface:HasAutocompleteset autocomplete attribute value.- Specified by:
setAutocompletein interfaceHasAutocomplete- Overrides:
setAutocompletein classValueBoxBaseWithEditorErrors<String>- Parameters:
arg- input field autocomplete attribute value to set
-
getMaxLength
public int getMaxLength()
Gets the maximum allowable length of the text box.- Returns:
- the maximum length, in characters
-
setMaxLength
public void setMaxLength(int length)
Sets the maximum allowable length of the text box.- Parameters:
length- the maximum length, in characters
-
-