io.jmix.ui.component

Interface ResizableTextArea<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, TextArea<V>, TextInputField<V>, TextInputField.CaseConversionSupported, TextInputField.CursorPositionSupported, TextInputField.MaxLengthLimited, TextInputField.TextChangeNotifier, TextInputField.TextSelectionSupported, TextInputField.TrimSupported, Validatable

All Known Implementing Classes:

ResizableTextAreaImpl

@StudioComponent(caption="ResizableTextArea",
                 category="Components",
                 xmlElement="resizableTextArea",
                 icon="io/jmix/ui/icon/component/resizableTextArea.svg",
                 canvasBehaviour=TEXT_AREA,
                 documentationURL="https://docs.jmix.io/jmix/%VERSION%/backoffice-ui/vcl/components/resizable-text-area.html")
public interface ResizableTextArea<V>
extends TextArea<V>

Resizable text area component.

See Also:

TextArea

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ResizableTextArea.ResizeDirection Represents directions in which textArea can be resized.
static class	ResizableTextArea.ResizeEvent

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

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

TYPE_BIGDECIMAL, TYPE_DATE, TYPE_DATETIME, TYPE_DEFAULT, TYPE_DOUBLE, TYPE_INTEGER, TYPE_LOCALDATE, TYPE_LOCALDATETIME, TYPE_LONG, TYPE_OFFSETTIME, TYPE_STRING, 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
io.jmix.core.common.event.Subscription	addResizeListener(java.util.function.Consumer<ResizableTextArea.ResizeEvent> listener) Adds a listener that is fired when the component is resized.
ResizableTextArea.ResizeDirection	getResizableDirection() Get the direction in which the textArea size changes.
void	setResizableDirection(ResizableTextArea.ResizeDirection direction) Allows resizing textArea in a given direction.

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

getRawValue, getRows, isWordWrap, setRows, setWordWrap

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

Method Detail

setResizableDirection

@StudioProperty(name="resizableDirection",
                type=ENUMERATION,
                defaultValue="BOTH",
                options={"HORIZONTAL","VERTICAL","BOTH","NONE"})
void setResizableDirection(ResizableTextArea.ResizeDirection direction)

Allows resizing textArea in a given direction.

Parameters:

direction - the direction in which resizes textArea.

getResizableDirection

ResizableTextArea.ResizeDirection getResizableDirection()

Get the direction in which the textArea size changes.

Returns:

direction.

addResizeListener

io.jmix.core.common.event.Subscription addResizeListener(java.util.function.Consumer<ResizableTextArea.ResizeEvent> listener)

Adds a listener that is fired when the component is resized.

Parameters:

listener - a listener to add

Returns:

a subscription