Class MessageInput
java.lang.Object
com.vaadin.flow.component.Component
com.vaadin.flow.component.messages.MessageInput
- All Implemented Interfaces:
AttachNotifier
,BlurNotifier<MessageInput>
,DetachNotifier
,Focusable<MessageInput>
,FocusNotifier<MessageInput>
,HasElement
,HasEnabled
,HasSize
,HasStyle
,HasTooltip
,Serializable
@Tag("vaadin-message-input")
@NpmPackage(value="@vaadin/polymer-legacy-adapter",version="24.6.3") @NpmPackage(value="@vaadin/message-input",version="24.6.3")
@JsModule("@vaadin/polymer-legacy-adapter/style-modules.js") @JsModule("@vaadin/message-input/src/vaadin-message-input.js")
public class MessageInput
extends Component
implements Focusable<MessageInput>, HasSize, HasStyle, HasEnabled, HasTooltip
Message Input allows users to author and send messages. The component
displays a text-area to input a message and a button to send it. The user can
send the message with one of the following actions:
- by pressing Enter (use Shift + Enter to add a new line)
- by clicking the ?send? button.
MessageList
component to show messages that users have sent.- Author:
- Vaadin Ltd.
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic class
Thesubmit
event which is fired byMessageInput
component.Nested classes/interfaces inherited from interface com.vaadin.flow.component.BlurNotifier
BlurNotifier.BlurEvent<C extends Component>
Nested classes/interfaces inherited from interface com.vaadin.flow.component.FocusNotifier
FocusNotifier.FocusEvent<C extends Component>
-
Constructor Summary
ConstructorsConstructorDescriptionCreates a new message input component.Creates a new message input component with the provided listener that gets invoked when the user submits a new message. -
Method Summary
Modifier and TypeMethodDescriptionAdds a listener that is called when the user submits the value of the input field, which can be obtained withMessageInput.SubmitEvent.getValue()
.getI18n()
Gets the internationalization object previously set for this component.void
setI18n
(MessageInputI18n i18n) Sets the internationalization object for this component.Methods inherited from class com.vaadin.flow.component.Component
addListener, findAncestor, fireEvent, from, get, getChildren, getElement, getEventBus, getId, getListeners, getLocale, getParent, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getUI, hasListener, isAttached, isTemplateMapped, isVisible, onAttach, onDetach, onEnabledStateChanged, removeFromParent, scrollIntoView, scrollIntoView, set, setElement, setId, setVisible
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface com.vaadin.flow.component.AttachNotifier
addAttachListener
Methods inherited from interface com.vaadin.flow.component.BlurNotifier
addBlurListener
Methods inherited from interface com.vaadin.flow.component.DetachNotifier
addDetachListener
Methods inherited from interface com.vaadin.flow.component.Focusable
addFocusShortcut, blur, focus, getTabIndex, setTabIndex
Methods inherited from interface com.vaadin.flow.component.FocusNotifier
addFocusListener
Methods inherited from interface com.vaadin.flow.component.HasElement
getElement
Methods inherited from interface com.vaadin.flow.component.HasEnabled
isEnabled, setEnabled
Methods inherited from interface com.vaadin.flow.component.HasSize
getHeight, getHeightUnit, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getWidth, getWidthUnit, setHeight, setHeight, setHeightFull, setMaxHeight, setMaxHeight, setMaxWidth, setMaxWidth, setMinHeight, setMinHeight, setMinWidth, setMinWidth, setSizeFull, setSizeUndefined, setWidth, setWidth, setWidthFull
Methods inherited from interface com.vaadin.flow.component.HasStyle
addClassName, addClassNames, getClassName, getClassNames, getStyle, hasClassName, removeClassName, removeClassNames, setClassName, setClassName
Methods inherited from interface com.vaadin.flow.component.shared.HasTooltip
getTooltip, setTooltipText
-
Constructor Details
-
MessageInput
public MessageInput()Creates a new message input component. -
MessageInput
Creates a new message input component with the provided listener that gets invoked when the user submits a new message.- Parameters:
listener
- the submit event listener- See Also:
-
-
Method Details
-
addSubmitListener
Adds a listener that is called when the user submits the value of the input field, which can be obtained withMessageInput.SubmitEvent.getValue()
.The event is fired when clicking the Send button or pressing the Enter key.
- Parameters:
listener
- the listener- Returns:
- registration for removal of the listener
-
getI18n
Gets the internationalization object previously set for this component.NOTE: Updating the instance that is returned from this method will not update the component if not set again using
setI18n(MessageInputI18n)
.- Returns:
- the i18n object or
null
if no i18n object has been set
-
setI18n
Sets the internationalization object for this component. It enabled you to customize and translate the language used in the message input.Note: updating the object properties after setting the i18n will not update the component. To make the changes effective, you need to set the updated object again.
- Parameters:
i18n
- the i18n object, notnull
-