We use cookies to serve our customers and website visitors in the best possible way. Cookies are used for the proper functioning of the website and for improving the user experience, monitoring visitor traffic and marketing purposes. By continuing to browse the site, you agree to our use of cookies. You can read more about cookies here.
com.vaadin.collaborationengine.
Package com.vaadin.collaborationengine
Class CollaborationMessageInput
java.lang.Object
com.vaadin.flow.component.Component
com.vaadin.flow.component.Composite<MessageInput>
com.vaadin.collaborationengine.CollaborationMessageInput
All Implemented Interfaces:
AttachNotifier, BlurNotifier<CollaborationMessageInput>, DetachNotifier, Focusable<CollaborationMessageInput>, FocusNotifier<CollaborationMessageInput>, HasElement, HasEnabled, HasSize, HasStyle, HasTooltip, Serializable
public class CollaborationMessageInput
extends Composite<MessageInput>
implements Focusable<CollaborationMessageInput>, HasSize, HasStyle, HasEnabled, HasTooltip
Extension of the MessageInput component which integrates with the
CollaborationMessageList. The user can type a message and submit it.
The messages will be displayed in any CollaborationMessageList that
is connected to the same topic as the list passed as the argument of this
component constructor. The text area and button will be disabled while the
connection to the topic is not active or the topic is set to
null (see CollaborationMessageList.setTopic(String)).
Since:
3.1
Author:
Vaadin Ltd
See Also:
-
Nested Class Summary
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 collaboration message input component which submits messages to the provided
CollaborationMessageList. -
Method Summary
Modifier and TypeMethodDescriptiongetI18n()Gets the internationalization object previously set for this component.
Gets the tooltip handle of the component.
voidsetI18n(MessageInputI18n i18n) Sets the internationalization properties for this component.
setTooltipText(String text) Sets a tooltip text for the component.
Methods inherited from class com.vaadin.flow.component.Composite
getChildren, getContent, getElement, initContentMethods inherited from class com.vaadin.flow.component.Component
addListener, findAncestor, fireEvent, from, get, 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, setVisibleMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface com.vaadin.flow.component.AttachNotifier
addAttachListenerMethods inherited from interface com.vaadin.flow.component.BlurNotifier
addBlurListenerMethods inherited from interface com.vaadin.flow.component.DetachNotifier
addDetachListenerMethods inherited from interface com.vaadin.flow.component.Focusable
addFocusShortcut, blur, focus, getTabIndex, setTabIndexMethods inherited from interface com.vaadin.flow.component.FocusNotifier
addFocusListenerMethods inherited from interface com.vaadin.flow.component.HasElement
getElementMethods inherited from interface com.vaadin.flow.component.HasEnabled
isEnabled, setEnabledMethods 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, setWidthFullMethods inherited from interface com.vaadin.flow.component.HasStyle
addClassName, addClassNames, getClassName, getClassNames, getStyle, hasClassName, removeClassName, removeClassNames, setClassName, setClassName
-
Constructor Details
-
CollaborationMessageInput
Creates a new collaboration message input component which submits messages to the provided
CollaborationMessageList.Parameters:
list- the list which will display the submitted messages, not null
-
-
Method Details
-
getI18n
Gets the internationalization object previously set for this component.
Note: updating the object content returned by this method will not update the component if not set back using
MessageInput.setI18n(MessageInputI18n).Returns:
the i18n object, or
nullif one has not been set withsetI18n(MessageInputI18n) -
setI18n
Sets the internationalization properties 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 -
setTooltipText
Sets a tooltip text for the component.
Specified by:
setTooltipTextin interfaceHasTooltipParameters:
text- The tooltip textReturns:
the tooltip handle
-
getTooltip
Gets the tooltip handle of the component.
Specified by:
getTooltipin interfaceHasTooltipReturns:
the tooltip handle
-