com.haulmont.cuba.gui.components

Interface TextArea<V>

Type Parameters:

V - type of value

All Superinterfaces:

Buffered, Component, Component.BelongToFrame, Component.Editable, Component.Focusable, Component.HasCaption, Component.HasDescription, Component.HasIcon, DatasourceComponent<V>, Field<V>, HasContextHelp, HasConversionErrorMessage, HasDatatype<V>, HasHtmlCaption, HasHtmlDescription, HasHtmlSanitizer, HasInputPrompt, HasValue<V>, HasValueSource<V>, TextInputField<V>, TextInputField.CaseConversionSupported, TextInputField.CursorPositionSupported, TextInputField.MaxLengthLimited, TextInputField.TextChangeNotifier, TextInputField.TextSelectionSupported, TextInputField.TrimSupported, Validatable

All Known Subinterfaces:

ResizableTextArea<V>

public interface TextArea<V>
extends TextInputField<V>, HasDatatype<V>, TextInputField.MaxLengthLimited, TextInputField.CursorPositionSupported, TextInputField.TrimSupported, TextInputField.TextChangeNotifier, TextInputField.TextSelectionSupported, TextInputField.CaseConversionSupported, HasInputPrompt, HasConversionErrorMessage

A text field that supports multi line editing.

Nested Class Summary

Nested classes/interfaces inherited from interface com.haulmont.cuba.gui.components.TextInputField

TextInputField.CaseConversion, TextInputField.CaseConversionSupported, TextInputField.CursorPositionSupported, TextInputField.EnterPressEvent, TextInputField.EnterPressNotifier, TextInputField.HtmlNameSupported, TextInputField.MaxLengthLimited, TextInputField.TextChangeEvent, TextInputField.TextChangeEventMode, TextInputField.TextChangeNotifier, TextInputField.TextSelectionSupported, TextInputField.TrimSupported

Nested classes/interfaces inherited from interface com.haulmont.cuba.gui.components.Field

Field.Validator<T>

Nested classes/interfaces inherited from interface com.haulmont.cuba.gui.components.HasValue

HasValue.ValueChangeEvent<V>

Nested classes/interfaces inherited from interface com.haulmont.cuba.gui.components.Component

Component.Alignment, Component.BelongToFrame, Component.Disposable, Component.Editable, Component.Focusable, Component.HasCaption, Component.HasDescription, Component.HasIcon, Component.HasXmlDescriptor, Component.OptionsStyleProvider, Component.Wrapper

Nested classes/interfaces inherited from interface com.haulmont.cuba.gui.components.HasContextHelp

HasContextHelp.ContextHelpIconClickEvent

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NAME
static com.google.common.reflect.TypeToken<TextArea<java.math.BigDecimal>>	TYPE_BIGDECIMAL
static com.google.common.reflect.TypeToken<TextArea<java.sql.Date>>	TYPE_DATE
static com.google.common.reflect.TypeToken<TextArea<java.util.Date>>	TYPE_DATETIME
static com.google.common.reflect.TypeToken<TextArea<java.lang.String>>	TYPE_DEFAULT
static com.google.common.reflect.TypeToken<TextArea<java.lang.Double>>	TYPE_DOUBLE
static com.google.common.reflect.TypeToken<TextArea<java.lang.Integer>>	TYPE_INTEGER
static com.google.common.reflect.TypeToken<TextArea<java.time.LocalDate>>	TYPE_LOCALDATE
static com.google.common.reflect.TypeToken<TextArea<java.time.LocalDateTime>>	TYPE_LOCALDATETIME
static com.google.common.reflect.TypeToken<TextArea<java.lang.Long>>	TYPE_LONG
static com.google.common.reflect.TypeToken<TextArea<java.time.OffsetTime>>	TYPE_OFFSETTIME
static com.google.common.reflect.TypeToken<TextArea<java.lang.String>>	TYPE_STRING
static com.google.common.reflect.TypeToken<TextArea<java.sql.Time>>	TYPE_TIME

Fields inherited from interface com.haulmont.cuba.gui.components.Component

AUTO_SIZE, AUTO_SIZE_PX, FULL_SIZE, UNITS_PERCENTAGE, UNITS_PIXELS

Method Summary

Modifier and Type	Method and Description
int	getColumns() Deprecated. Use Component.getWidth() instead
java.lang.String	getRawValue() Returns a string representation of the value.
int	getRows()
boolean	isWordWrap()
void	setColumns(int columns) Deprecated. Use Component.setWidth(String) instead
void	setRows(int rows)
void	setWordWrap(boolean wordWrap) Sets whether word wrapping is enabled or not.

Methods inherited from interface com.haulmont.cuba.gui.components.Field

addValidator, addValidators, getRequiredMessage, getValidators, isRequired, removeValidator, setRequired, setRequiredMessage

Methods inherited from interface com.haulmont.cuba.gui.components.DatasourceComponent

getDatasource, getMetaProperty, getMetaPropertyPath, setDatasource

Methods inherited from interface com.haulmont.cuba.gui.components.HasValue

addValueChangeListener, clear, getEmptyValue, getValue, isEmpty, removeValueChangeListener, setValue

Methods inherited from interface com.haulmont.cuba.gui.components.Component

addStyleName, getAlignment, getHeight, getHeightSizeUnit, getHeightUnits, getId, getParent, getStyleName, getWidth, getWidthSizeUnit, getWidthUnits, isEnabled, isEnabledItself, isEnabledRecursive, isResponsive, isVisible, isVisibleItself, isVisibleRecursive, removeStyleName, requestFocus, setAlignment, setEnabled, setHeight, setHeightAuto, setHeightFull, setId, setParent, setResponsive, setSizeAuto, setSizeFull, setStyleName, setVisible, setWidth, setWidthAuto, setWidthFull, unwrap, unwrapComposition, unwrapCompositionOrNull, unwrapOrNull, withUnwrapped, withUnwrappedComposition

Methods inherited from interface com.haulmont.cuba.gui.components.data.HasValueSource

getValueSource, setValueSource

Methods inherited from interface com.haulmont.cuba.gui.components.Component.Editable

isEditable, isEditableWithParent, setEditable

Methods inherited from interface com.haulmont.cuba.gui.components.Component.BelongToFrame

getFrame, setFrame

Methods inherited from interface com.haulmont.cuba.gui.components.Validatable

isValid, isValidateOnCommit, validate

Methods inherited from interface com.haulmont.cuba.gui.components.Component.HasIcon

getIcon, setIcon, setIconFromSet

Methods inherited from interface com.haulmont.cuba.gui.components.HasContextHelp

getContextHelpIconClickHandler, getContextHelpText, isContextHelpTextHtmlEnabled, setContextHelpIconClickHandler, setContextHelpText, setContextHelpTextHtmlEnabled

Methods inherited from interface com.haulmont.cuba.gui.components.HasHtmlCaption

isCaptionAsHtml, setCaptionAsHtml

Methods inherited from interface com.haulmont.cuba.gui.components.Component.HasCaption

getCaption, setCaption

Methods inherited from interface com.haulmont.cuba.gui.components.Component.HasDescription

getDescription, setDescription

Methods inherited from interface com.haulmont.cuba.gui.components.HasHtmlDescription

isDescriptionAsHtml, setDescriptionAsHtml

Methods inherited from interface com.haulmont.cuba.gui.components.HasHtmlSanitizer

isHtmlSanitizerEnabled, setHtmlSanitizerEnabled

Methods inherited from interface com.haulmont.cuba.gui.components.Buffered

commit, discard, isBuffered, isModified, setBuffered

Methods inherited from interface com.haulmont.cuba.gui.components.Component.Focusable

focus, getTabIndex, isFocusable, setFocusable, setTabIndex

Methods inherited from interface com.haulmont.cuba.gui.components.HasDatatype

getDatatype, setDatatype

Methods inherited from interface com.haulmont.cuba.gui.components.TextInputField.MaxLengthLimited

getMaxLength, setMaxLength

Methods inherited from interface com.haulmont.cuba.gui.components.TextInputField.CursorPositionSupported

setCursorPosition

Methods inherited from interface com.haulmont.cuba.gui.components.TextInputField.TrimSupported

isTrimming, setTrimming

Methods inherited from interface com.haulmont.cuba.gui.components.TextInputField.TextChangeNotifier

addTextChangeListener, getTextChangeEventMode, getTextChangeTimeout, removeTextChangeListener, setTextChangeEventMode, setTextChangeTimeout

Methods inherited from interface com.haulmont.cuba.gui.components.TextInputField.TextSelectionSupported

selectAll, setSelectionRange

Methods inherited from interface com.haulmont.cuba.gui.components.TextInputField.CaseConversionSupported

getCaseConversion, setCaseConversion

Methods inherited from interface com.haulmont.cuba.gui.components.HasInputPrompt

getInputPrompt, setInputPrompt

Methods inherited from interface com.haulmont.cuba.gui.components.HasConversionErrorMessage

getConversionErrorMessage, setConversionErrorMessage

Field Detail

NAME

static final java.lang.String NAME

See Also:

Constant Field Values

TYPE_DEFAULT

static final com.google.common.reflect.TypeToken<TextArea<java.lang.String>> TYPE_DEFAULT

TYPE_STRING

static final com.google.common.reflect.TypeToken<TextArea<java.lang.String>> TYPE_STRING

TYPE_INTEGER

static final com.google.common.reflect.TypeToken<TextArea<java.lang.Integer>> TYPE_INTEGER

TYPE_LONG

static final com.google.common.reflect.TypeToken<TextArea<java.lang.Long>> TYPE_LONG

TYPE_DOUBLE

static final com.google.common.reflect.TypeToken<TextArea<java.lang.Double>> TYPE_DOUBLE

TYPE_BIGDECIMAL

static final com.google.common.reflect.TypeToken<TextArea<java.math.BigDecimal>> TYPE_BIGDECIMAL

TYPE_DATE

static final com.google.common.reflect.TypeToken<TextArea<java.sql.Date>> TYPE_DATE

TYPE_DATETIME

static final com.google.common.reflect.TypeToken<TextArea<java.util.Date>> TYPE_DATETIME

TYPE_LOCALDATE

static final com.google.common.reflect.TypeToken<TextArea<java.time.LocalDate>> TYPE_LOCALDATE

TYPE_LOCALDATETIME

static final com.google.common.reflect.TypeToken<TextArea<java.time.LocalDateTime>> TYPE_LOCALDATETIME

TYPE_TIME

static final com.google.common.reflect.TypeToken<TextArea<java.sql.Time>> TYPE_TIME

TYPE_OFFSETTIME

static final com.google.common.reflect.TypeToken<TextArea<java.time.OffsetTime>> TYPE_OFFSETTIME

Method Detail

getRows

int getRows()

setRows

void setRows(int rows)

getColumns

@Deprecated
int getColumns()

Deprecated. Use Component.getWidth() instead

Returns:

the number of columns

setColumns

@Deprecated
void setColumns(int columns)

Deprecated. Use Component.setWidth(String) instead

Sets width according to the number of columns.

Parameters:

columns - the number of columns to set

isWordWrap

boolean isWordWrap()

Returns:

whether word wrapping is enabled or not

setWordWrap

void setWordWrap(boolean wordWrap)

Sets whether word wrapping is enabled or not.

Parameters:

wordWrap - wordWrap

getRawValue

java.lang.String getRawValue()

Returns a string representation of the value.