io.jmix.ui.component

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, Field<V>, HasContextHelp, HasConversionErrorMessage, HasDatatype<V>, HasHtmlCaption, HasHtmlDescription, HasHtmlSanitizer, HasInputPrompt, HasValidator<V>, HasValue<V>, HasValueSource<V>, Requirable, TextInputField<V>, TextInputField.CaseConversionSupported, TextInputField.CursorPositionSupported, TextInputField.MaxLengthLimited, TextInputField.TextChangeNotifier, TextInputField.TextSelectionSupported, TextInputField.TrimSupported, Validatable

All Known Subinterfaces:

ResizableTextArea<V>

All Known Implementing Classes:

AbstractTextArea, ResizableTextAreaImpl, TextAreaImpl

@StudioComponent(caption="TextArea",
                 category="Components",
                 xmlElement="textArea",
                 icon="io/jmix/ui/icon/component/textArea.svg",
                 canvasBehaviour=TEXT_AREA,
                 documentationURL="https://docs.jmix.io/jmix/%VERSION%/backoffice-ui/vcl/components/text-area.html")
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 io.jmix.ui.component.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 io.jmix.ui.component.HasValue

HasValue.ValueChangeEvent<V>

Nested classes/interfaces inherited from interface io.jmix.ui.component.Component

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

Nested classes/interfaces inherited from interface io.jmix.ui.component.HasContextHelp

HasContextHelp.ContextHelpIconClickEvent

Field Summary

Fields

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

Fields inherited from interface io.jmix.ui.component.Component

AUTO_SIZE, AUTO_SIZE_PX, FULL_SIZE

Method Summary

Modifier and Type	Method and Description
java.lang.String	getRawValue() Returns a string representation of the value.
int	getRows()
boolean	isWordWrap()
void	setRows(int rows) Sets the number of rows in the text area.
void	setWordWrap(boolean wordWrap) Sets whether word wrapping is enabled or not.

Methods inherited from interface io.jmix.ui.component.data.HasValueSource

getValueSource, setValueSource

Methods inherited from interface io.jmix.ui.component.HasValue

addValueChangeListener, clear, getEmptyValue, getValue, isEmpty, setValue

Methods inherited from interface io.jmix.ui.component.Component.Editable

isEditable, isEditableWithParent, setEditable

Methods inherited from interface io.jmix.ui.component.Component.BelongToFrame

getFrame, setFrame

Methods inherited from interface io.jmix.ui.component.Component

addStyleName, getAlignment, getHeight, getHeightSizeUnit, getId, getParent, getStyleName, getWidth, getWidthSizeUnit, isEnabled, isEnabledRecursive, isResponsive, isVisible, isVisibleRecursive, removeStyleName, 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 io.jmix.ui.component.Validatable

isValid, isValidateOnCommit, validate

Methods inherited from interface io.jmix.ui.component.Component.HasIcon

getIcon, setIcon, setIconFromSet

Methods inherited from interface io.jmix.ui.component.HasContextHelp

getContextHelpIconClickHandler, getContextHelpText, isContextHelpTextHtmlEnabled, setContextHelpIconClickHandler, setContextHelpText, setContextHelpTextHtmlEnabled

Methods inherited from interface io.jmix.ui.component.HasHtmlCaption

isCaptionAsHtml, setCaptionAsHtml

Methods inherited from interface io.jmix.ui.component.Component.HasCaption

getCaption, setCaption

Methods inherited from interface io.jmix.ui.component.Component.HasDescription

getDescription, setDescription

Methods inherited from interface io.jmix.ui.component.HasHtmlDescription

isDescriptionAsHtml, setDescriptionAsHtml

Methods inherited from interface io.jmix.ui.component.HasHtmlSanitizer

isHtmlSanitizerEnabled, setHtmlSanitizerEnabled

Methods inherited from interface io.jmix.ui.component.HasValidator

addValidator, addValidators, getValidators, removeValidator

Methods inherited from interface io.jmix.ui.component.Requirable

getRequiredMessage, isRequired, setRequired, setRequiredMessage

Methods inherited from interface io.jmix.ui.component.Buffered

commit, discard, isBuffered, isModified, setBuffered

Methods inherited from interface io.jmix.ui.component.Component.Focusable

focus, getTabIndex, isFocusable, setFocusable, setTabIndex

Methods inherited from interface io.jmix.ui.component.HasDatatype

getDatatype, setDatatype

Methods inherited from interface io.jmix.ui.component.TextInputField.MaxLengthLimited

getMaxLength, setMaxLength

Methods inherited from interface io.jmix.ui.component.TextInputField.CursorPositionSupported

setCursorPosition

Methods inherited from interface io.jmix.ui.component.TextInputField.TrimSupported

isTrimming, setTrimming

Methods inherited from interface io.jmix.ui.component.TextInputField.TextChangeNotifier

addTextChangeListener, getTextChangeEventMode, getTextChangeTimeout, setTextChangeEventMode, setTextChangeTimeout

Methods inherited from interface io.jmix.ui.component.TextInputField.TextSelectionSupported

selectAll, setSelectionRange

Methods inherited from interface io.jmix.ui.component.TextInputField.CaseConversionSupported

getCaseConversion, setCaseConversion

Methods inherited from interface io.jmix.ui.component.HasInputPrompt

getInputPrompt, setInputPrompt

Methods inherited from interface io.jmix.ui.component.HasConversionErrorMessage

getConversionErrorMessage, setConversionErrorMessage

Field Detail

NAME

static final java.lang.String NAME

See Also:

Constant Field Values

TYPE_DEFAULT

static final org.springframework.core.ParameterizedTypeReference<TextArea<java.lang.String>> TYPE_DEFAULT

TYPE_STRING

static final org.springframework.core.ParameterizedTypeReference<TextArea<java.lang.String>> TYPE_STRING

TYPE_INTEGER

static final org.springframework.core.ParameterizedTypeReference<TextArea<java.lang.Integer>> TYPE_INTEGER

TYPE_LONG

static final org.springframework.core.ParameterizedTypeReference<TextArea<java.lang.Long>> TYPE_LONG

TYPE_DOUBLE

static final org.springframework.core.ParameterizedTypeReference<TextArea<java.lang.Double>> TYPE_DOUBLE

TYPE_BIGDECIMAL

static final org.springframework.core.ParameterizedTypeReference<TextArea<java.math.BigDecimal>> TYPE_BIGDECIMAL

TYPE_DATE

static final org.springframework.core.ParameterizedTypeReference<TextArea<java.sql.Date>> TYPE_DATE

TYPE_DATETIME

static final org.springframework.core.ParameterizedTypeReference<TextArea<java.util.Date>> TYPE_DATETIME

TYPE_LOCALDATE

static final org.springframework.core.ParameterizedTypeReference<TextArea<java.time.LocalDate>> TYPE_LOCALDATE

TYPE_LOCALDATETIME

static final org.springframework.core.ParameterizedTypeReference<TextArea<java.time.LocalDateTime>> TYPE_LOCALDATETIME

TYPE_TIME

static final org.springframework.core.ParameterizedTypeReference<TextArea<java.sql.Time>> TYPE_TIME

TYPE_OFFSETTIME

static final org.springframework.core.ParameterizedTypeReference<TextArea<java.time.OffsetTime>> TYPE_OFFSETTIME

Method Detail

getRows

int getRows()

Returns:

the number of rows

setRows

@StudioProperty(defaultValue="5")
void setRows(int rows)

Sets the number of rows in the text area.

Parameters:

rows - the number of rows

isWordWrap

boolean isWordWrap()

Returns:

whether word wrapping is enabled or not

setWordWrap

@StudioProperty(defaultValue="true")
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.