Index
All Classes and Interfaces|All Packages|Serialized Form
A
- AbstractCollaborationManager - Class in com.vaadin.collaborationengine
-
The common abstract superclass of Collaboration Managers.
- AbstractCollaborationManager(UserInfo, String, CollaborationEngine) - Constructor for class com.vaadin.collaborationengine.AbstractCollaborationManager
-
Deprecated, for removal: This API element is subject to removal in a future version.This constructor is not compatible with serialization
- AbstractCollaborationManager(UserInfo, String, SerializableSupplier<CollaborationEngine>) - Constructor for class com.vaadin.collaborationengine.AbstractCollaborationManager
-
Constructs a new manager instance.
- AbstractCollaborationManager.ActivationHandler - Interface in com.vaadin.collaborationengine
-
The callback executed when the manager is activated, i.e.
- AccessResponse - Class in com.vaadin.collaborationengine
-
Response object when access to Collaboration Engine is requested for a user.
- ActionDispatcher - Interface in com.vaadin.collaborationengine
-
Allows dispatching actions to be executed in background.
- ActivationHandler - Interface in com.vaadin.collaborationengine
-
Defines when to execute the connection callback
- addComponent(Component) - Method in class com.vaadin.collaborationengine.ComponentConnectionContext
-
Adds a component instance to track for this context.
- addEditor(TopicConnection, String, UserInfo) - Static method in class com.vaadin.collaborationengine.CollaborationBinderUtil
-
Signals that the user is currently editing the field that is bound to the property.
- addEditor(TopicConnection, String, UserInfo, int) - Static method in class com.vaadin.collaborationengine.CollaborationBinderUtil
-
Signals that the user is currently editing the field that is bound to the property.
- addMembershipListener(MembershipListener) - Method in class com.vaadin.collaborationengine.Backend
-
Adds a listener of membership events.
- addMembershipListener(MembershipListener) - Method in class com.vaadin.collaborationengine.LocalBackend
- addReinitializer(Consumer<VaadinService>) - Static method in class com.vaadin.collaborationengine.CollaborationEngineServiceInitListener
- addThemeVariants(AvatarGroupVariant...) - Method in class com.vaadin.collaborationengine.CollaborationAvatarGroup
-
Adds theme variants to the avatar group component.
- addUserEntry(String, YearMonth, String) - Method in interface com.vaadin.collaborationengine.LicenseStorage
-
Deprecated.Adds a user entry for the specified month.
- appendMessage(String) - Method in interface com.vaadin.collaborationengine.CollaborationMessageSubmitter.ActivationContext
-
Appends a message.
- apply(ListOperation) - Method in interface com.vaadin.collaborationengine.CollaborationList
-
Performs the given list operation.
B
- Backend - Class in com.vaadin.collaborationengine
-
The interface between a cluster backend and Collaboration Engine.
- Backend() - Constructor for class com.vaadin.collaborationengine.Backend
- Backend.EventIdNotFoundException - Exception in com.vaadin.collaborationengine
-
This exception is thrown by the {@link EventLog::subscribe()} method if the provided
UUIDdoes not exist in the log. - Backend.EventLog - Interface in com.vaadin.collaborationengine
-
A strictly ordered log of submitted events.
- Backend.Snapshot - Class in com.vaadin.collaborationengine
-
The
Snapshotclass is used to submit and retrieve a snapshot payload using the {@link Backend::replaceSnapshot()} and {@link Backend::loadLatestSnapshot()} methods. - BackendFeatureNotEnabledException - Exception in com.vaadin.collaborationengine
-
Exception thrown if the feature-flag for the
BackendAPI is not enabled. - bind(HasValue<?, FIELDVALUE>, ValueProvider<BEAN, FIELDVALUE>, Setter<BEAN, FIELDVALUE>) - Method in class com.vaadin.collaborationengine.CollaborationBinder
-
Deprecated.The method does not work with the collaboration binder. Use
CollaborationBinder.bind(HasValue, String)instead. - bind(HasValue<?, FIELDVALUE>, String) - Method in class com.vaadin.collaborationengine.CollaborationBinder
-
Binds the given field to the property with the given name, as described in
Binder.bind(HasValue, String). - bind(ValueProvider<BEAN, TARGET>, Setter<BEAN, TARGET>) - Method in class com.vaadin.collaborationengine.CollaborationBinder.CollaborationBindingBuilderImpl
- bind(String) - Method in class com.vaadin.collaborationengine.CollaborationBinder.CollaborationBindingBuilderImpl
- bindInstanceFields(Object) - Method in class com.vaadin.collaborationengine.CollaborationBinder
-
Binds the member fields found in the given object, as described in
Binder.bindInstanceFields(Object).
C
- close() - Method in class com.vaadin.collaborationengine.AbstractCollaborationManager
-
Closes the manager connection to the topic.
- CollaborationAvatarGroup - Class in com.vaadin.collaborationengine
-
Extension of the
AvatarGroupcomponent which integrates with theCollaborationEngine. - CollaborationAvatarGroup(UserInfo, String) - Constructor for class com.vaadin.collaborationengine.CollaborationAvatarGroup
-
Creates a new collaboration avatar group component with the provided local user and topic id.
- CollaborationAvatarGroup.ImageHandler - Interface in com.vaadin.collaborationengine
-
Callback for creating a download handler for the avatar image for a specific user.
- CollaborationAvatarGroup.ImageProvider - Interface in com.vaadin.collaborationengine
-
Deprecated, for removal: This API element is subject to removal in a future version.
- CollaborationBinder<BEAN> - Class in com.vaadin.collaborationengine
-
Extension of
Binderfor creating collaborative forms withCollaborationEngine. - CollaborationBinder(Class<BEAN>, UserInfo) - Constructor for class com.vaadin.collaborationengine.CollaborationBinder
-
Creates a new collaboration binder.
- CollaborationBinder.CollaborationBindingBuilderImpl<BEAN,
FIELDVALUE, TARGET> - Class in com.vaadin.collaborationengine - CollaborationBinderUtil - Class in com.vaadin.collaborationengine
-
Utility methods for
CollaborationBinder. - CollaborationBindingBuilderImpl(CollaborationBinder<BEAN>, HasValue<?, FIELDVALUE>, Converter<FIELDVALUE, TARGET>, BindingValidationStatusHandler) - Constructor for class com.vaadin.collaborationengine.CollaborationBinder.CollaborationBindingBuilderImpl
- CollaborationEngine - Class in com.vaadin.collaborationengine
-
CollaborationEngine is an API for creating collaborative experiences in Vaadin applications.
- CollaborationEngineConfiguration - Class in com.vaadin.collaborationengine
-
Configuration object for
CollaborationEngine. - CollaborationEngineConfiguration() - Constructor for class com.vaadin.collaborationengine.CollaborationEngineConfiguration
-
Creates a new Collaboration Engine configuration.
- CollaborationEngineConfiguration(LicenseEventHandler) - Constructor for class com.vaadin.collaborationengine.CollaborationEngineConfiguration
-
Deprecated, for removal: This API element is subject to removal in a future version.the provided handler won't receive any events, please prefer using the default constructor with no parameters
- CollaborationEngineServiceInitListener - Class in com.vaadin.collaborationengine
-
A
VaadinServiceInitListenerwhich applies callbacks to the service instance to reinitialize the state of topic connection context after de-serialization. - CollaborationEngineServiceInitListener() - Constructor for class com.vaadin.collaborationengine.CollaborationEngineServiceInitListener
- CollaborationList - Interface in com.vaadin.collaborationengine
-
A list that is shared between multiple users.
- CollaborationMap - Interface in com.vaadin.collaborationengine
-
A map that is shared between multiple users.
- CollaborationMessage - Class in com.vaadin.collaborationengine
-
Message of a
CollaborationMessageList. - CollaborationMessage() - Constructor for class com.vaadin.collaborationengine.CollaborationMessage
-
Creates a new message.
- CollaborationMessage(UserInfo, String, Instant) - Constructor for class com.vaadin.collaborationengine.CollaborationMessage
-
Creates a new message with the specified
useras the message author info,textas the message content andtimeas the message timestamp. - CollaborationMessageInput - Class in com.vaadin.collaborationengine
-
Extension of the
MessageInputcomponent which integrates with theCollaborationMessageList. - CollaborationMessageInput(CollaborationMessageList) - Constructor for class com.vaadin.collaborationengine.CollaborationMessageInput
-
Creates a new collaboration message input component which submits messages to the provided
CollaborationMessageList. - CollaborationMessageList - Class in com.vaadin.collaborationengine
-
Extension of the
MessageListcomponent which integrates with theCollaborationEngine. - CollaborationMessageList(UserInfo, String) - Constructor for class com.vaadin.collaborationengine.CollaborationMessageList
-
Creates a new collaboration message list component with the provided topic id.
- CollaborationMessageList(UserInfo, String, CollaborationMessagePersister) - Constructor for class com.vaadin.collaborationengine.CollaborationMessageList
-
Creates a new collaboration message list component with the provided topic id and persister of
CollaborationMessageitems from/to an external source (e.g. - CollaborationMessageList.MessageConfigurator - Interface in com.vaadin.collaborationengine
-
Configurator callback for messages in a
CollaborationMessageList. - CollaborationMessagePersister - Interface in com.vaadin.collaborationengine
-
Persister of
CollaborationMessageitems, which enables to read and write messages from/to a backend, for example a database. - CollaborationMessagePersister.FetchQuery - Class in com.vaadin.collaborationengine
-
A query to fetch messages from a backend.
- CollaborationMessagePersister.PersistRequest - Class in com.vaadin.collaborationengine
-
A request to persist messages to a backend.
- CollaborationMessageSubmitter - Interface in com.vaadin.collaborationengine
-
Submitter of messages.
- CollaborationMessageSubmitter.ActivationContext - Interface in com.vaadin.collaborationengine
-
The activation context of a
CollaborationMessageSubmitter. - com.vaadin.collaborationengine - package com.vaadin.collaborationengine
- ComponentConnectionContext - Class in com.vaadin.collaborationengine
-
A connection context based on the attach state of a set of component instances.
- ComponentConnectionContext() - Constructor for class com.vaadin.collaborationengine.ComponentConnectionContext
-
Creates an empty component connection context.
- ComponentConnectionContext(Component) - Constructor for class com.vaadin.collaborationengine.ComponentConnectionContext
-
Creates a new component connection context which is initially using a single component.
- configure(VaadinService, CollaborationEngineConfiguration) - Static method in class com.vaadin.collaborationengine.CollaborationEngine
-
Sets the configuration for the Collaboration Engine associated with the given Vaadin service.
- configureBinding(Binder.BindingBuilder<BEAN, ?>, PropertyDefinition<BEAN, ?>) - Method in class com.vaadin.collaborationengine.CollaborationBinder
- configureMessage(MessageListItem, UserInfo) - Method in interface com.vaadin.collaborationengine.CollaborationMessageList.MessageConfigurator
-
Configures the provided message after the
CollaborationMessageListhas generated it. - CONNECTION - Enum constant in enum class com.vaadin.collaborationengine.EntryScope
-
Entries with this scope will be automatically removed once the connection to the topic which created them is deactivated.
- ConnectionContext - Interface in com.vaadin.collaborationengine
-
The context in which a topic connection is active.
- createCompletableFuture() - Method in interface com.vaadin.collaborationengine.ActionDispatcher
-
Gets a completable future that needs to be resolved by the caller.
- createOwnAvatar() - Method in class com.vaadin.collaborationengine.CollaborationAvatarGroup
-
Creates an instance of the user's own
Avatarin this avatar group.
D
- delete(ListKey) - Static method in class com.vaadin.collaborationengine.ListOperation
-
Creates a list operation to delete the value at the position specified by the given key.
- dispatchAction(Command) - Method in interface com.vaadin.collaborationengine.ActionDispatcher
-
Dispatches the given action.
- doCreateBinding(HasValue<?, FIELDVALUE>, Converter<FIELDVALUE, TARGET>, BindingValidationStatusHandler) - Method in class com.vaadin.collaborationengine.CollaborationBinder
E
- EntryScope - Enum Class in com.vaadin.collaborationengine
-
The scope of data in a topic.
- equals(Object) - Method in class com.vaadin.collaborationengine.CollaborationMessage
- equals(Object) - Method in class com.vaadin.collaborationengine.ListKey
- equals(Object) - Method in class com.vaadin.collaborationengine.UserInfo
- EventIdNotFoundException(String) - Constructor for exception com.vaadin.collaborationengine.Backend.EventIdNotFoundException
F
- fetchMessages(CollaborationMessagePersister.FetchQuery) - Method in interface com.vaadin.collaborationengine.CollaborationMessagePersister
-
Reads a stream of
CollaborationMessageitems from a persistence backend. - forField(HasValue<?, FIELDVALUE>) - Method in class com.vaadin.collaborationengine.CollaborationBinder
- forField(HasValue<?, FIELDVALUE>, Class<? super FIELDVALUE>, Class<ELEMENT>) - Method in class com.vaadin.collaborationengine.CollaborationBinder
-
Creates a new binding for the given (multi select) field whose value type is a collection.
- forField(HasValue<?, FIELDVALUE>, Class<FIELDVALUE>) - Method in class com.vaadin.collaborationengine.CollaborationBinder
-
Creates a new binding for the given field and type.
- forMemberField(HasValue<?, FIELDVALUE>) - Method in class com.vaadin.collaborationengine.CollaborationBinder
- forMemberField(HasValue<?, FIELDVALUE>, Class<? super FIELDVALUE>, Class<ELEMENT>) - Method in class com.vaadin.collaborationengine.CollaborationBinder
-
Creates a new binding for the given (multi select) field whose value type is a collection.
- forMemberField(HasValue<?, FIELDVALUE>, Class<FIELDVALUE>) - Method in class com.vaadin.collaborationengine.CollaborationBinder
-
Creates a new binding for the given field and type.
- FormManager - Class in com.vaadin.collaborationengine
-
Manager to handle form values and field highlight state.
- FormManager(ConnectionContext, UserInfo, String, CollaborationEngine) - Constructor for class com.vaadin.collaborationengine.FormManager
-
Deprecated, for removal: This API element is subject to removal in a future version.This constructor is not compatible with serialization
- FormManager(ConnectionContext, UserInfo, String, SerializableSupplier<CollaborationEngine>) - Constructor for class com.vaadin.collaborationengine.FormManager
-
Creates a new manager for the provided connection context.
- FormManager(Component, UserInfo, String) - Constructor for class com.vaadin.collaborationengine.FormManager
-
Creates a new manager for the provided component.
- fromCallbacks(SerializableFunction<CollaborationMessagePersister.FetchQuery, Stream<CollaborationMessage>>, SerializableConsumer<CollaborationMessagePersister.PersistRequest>) - Static method in interface com.vaadin.collaborationengine.CollaborationMessagePersister
-
Creates an instance of
CollaborationMessagePersisterfrom the provided callbacks.
G
- get(String, TypeReference<T>) - Method in interface com.vaadin.collaborationengine.CollaborationMap
-
Gets the map value for the given key as an instance corresponding to the given type reference.
- get(String, Class<T>) - Method in interface com.vaadin.collaborationengine.CollaborationMap
-
Gets the map value for the given key as an instance of the given class.
- getAbbreviation() - Method in class com.vaadin.collaborationengine.UserInfo
-
Gets the user's abbreviation.
- getBackend() - Method in class com.vaadin.collaborationengine.CollaborationEngineConfiguration
-
Gets the configured backend implementation.
- getBeaconPath() - Method in class com.vaadin.collaborationengine.CollaborationEngineConfiguration
-
Gets the configured beacon path.
- getBean() - Method in class com.vaadin.collaborationengine.CollaborationBinder
-
Deprecated.This operation, along with
CollaborationBinder.setBean(Object), is not supported by the collaboration binder. Instead ofCollaborationBinder.setBean(Object), you can provide the bean for populating the fields usingCollaborationBinder.setTopic(java.lang.String, com.vaadin.flow.function.SerializableSupplier<BEAN>), and write the values back to the bean usingBinder.writeBean(BEAN). - getBinder() - Method in class com.vaadin.collaborationengine.CollaborationBinder.CollaborationBindingBuilderImpl
- getCollaborationEngine() - Method in class com.vaadin.collaborationengine.AbstractCollaborationManager
-
Gets the
CollaborationEngineof this manager. - getCollaborationEngine() - Method in class com.vaadin.collaborationengine.Backend
-
Gets the
CollaborationEngineused by this backend. - getColorIndex() - Method in class com.vaadin.collaborationengine.UserInfo
-
Gets the user's color index.
- getCompletableFuture() - Method in class com.vaadin.collaborationengine.ListOperationResult
-
The result of the asynchronous operation.
- getConnection() - Method in interface com.vaadin.collaborationengine.CollaborationList
-
Gets the topic connection which is used to propagate changes to this list.
- getConnection() - Method in interface com.vaadin.collaborationengine.CollaborationMap
-
Gets the topic connection which is used to propagate changes to this map.
- getDataDir() - Method in class com.vaadin.collaborationengine.CollaborationEngineConfiguration
-
Deprecated, for removal: This API element is subject to removal in a future version.the data-directory is not used since 6.3
- getDownloadHandler(UserInfo) - Method in interface com.vaadin.collaborationengine.CollaborationAvatarGroup.ImageHandler
-
Gets a download handler for the avatar image for the given user.
- getExecutorService() - Method in class com.vaadin.collaborationengine.CollaborationEngineConfiguration
-
Gets the configured
ExecutorServicewhich will be used to dispatch actions asynchronously. - getExpirationTimeout() - Method in class com.vaadin.collaborationengine.CollaborationBinder
-
Gets the optional expiration timeout of this binder.
- getExpirationTimeout() - Method in interface com.vaadin.collaborationengine.CollaborationList
-
Gets the optional expiration timeout of this list.
- getExpirationTimeout() - Method in interface com.vaadin.collaborationengine.CollaborationMap
-
Gets the optional expiration timeout of this map.
- getExpirationTimeout() - Method in class com.vaadin.collaborationengine.FormManager
-
Gets the optional expiration timeout of the field property data.
- getExpirationTimeout() - Method in interface com.vaadin.collaborationengine.HasExpirationTimeout
-
Gets the optional expiration timeout of the data.
- getFieldIndex() - Method in interface com.vaadin.collaborationengine.HighlightHandler.HighlightContext
-
Gets the field index.
- getI18n() - Method in class com.vaadin.collaborationengine.CollaborationAvatarGroup
-
Gets the internationalization object previously set for this component.
- getI18n() - Method in class com.vaadin.collaborationengine.CollaborationMessageInput
-
Gets the internationalization object previously set for this component.
- getId() - Method in class com.vaadin.collaborationengine.Backend.Snapshot
- getId() - Method in class com.vaadin.collaborationengine.UserInfo
-
Gets the user's unique identifier.
- getImage() - Method in class com.vaadin.collaborationengine.UserInfo
-
Gets the url of the user's image.
- getImageHandler() - Method in class com.vaadin.collaborationengine.CollaborationAvatarGroup
-
Gets the currently used image handler callback.
- getImageHandler() - Method in class com.vaadin.collaborationengine.CollaborationMessageList
-
Gets the currently used image handler callback.
- getImageProvider() - Method in class com.vaadin.collaborationengine.CollaborationAvatarGroup
-
Deprecated, for removal: This API element is subject to removal in a future version.
- getImageProvider() - Method in class com.vaadin.collaborationengine.CollaborationMessageList
-
Deprecated, for removal: This API element is subject to removal in a future version.
- getImageResource(UserInfo) - Method in interface com.vaadin.collaborationengine.CollaborationAvatarGroup.ImageProvider
-
Deprecated.Gets a stream resource that provides the avatar image for the given user.
- getInstance() - Static method in class com.vaadin.collaborationengine.CollaborationEngine
-
Gets the
CollaborationEngineinstance from the currentVaadinService. - getInstance() - Static method in class com.vaadin.collaborationengine.SystemConnectionContext
-
Gets the system connection context associated with the current Collaboration Engine instance.
- getInstance() - Static method in class com.vaadin.collaborationengine.SystemUserInfo
-
Gets the unique instance of system user info.
- getInstance(VaadinService) - Static method in class com.vaadin.collaborationengine.CollaborationEngine
-
Gets the
CollaborationEngineinstance from the providedVaadinService. - getItem(ListKey, TypeReference<T>) - Method in interface com.vaadin.collaborationengine.CollaborationList
-
Gets the list item identifier by the given key as instance of the given type reference.
- getItem(ListKey, Class<T>) - Method in interface com.vaadin.collaborationengine.CollaborationList
-
Gets the list item identifier by the given key as instance of the given class.
- getItems(TypeReference<T>) - Method in interface com.vaadin.collaborationengine.CollaborationList
-
Gets the list items as instances of the given type reference.
- getItems(Class<T>) - Method in interface com.vaadin.collaborationengine.CollaborationList
-
Gets the list items as instances of the given class.
- getKey() - Method in class com.vaadin.collaborationengine.ListChangeEvent
-
Gets the key of the list item affected by the change.
- getKey() - Method in class com.vaadin.collaborationengine.ListKey
-
Gets the unique value of this key.
- getKey() - Method in class com.vaadin.collaborationengine.ListOperationResult
-
Gets the key of the item.
- getKey() - Method in class com.vaadin.collaborationengine.MapChangeEvent
-
Gets the updated map key.
- getKeys() - Method in interface com.vaadin.collaborationengine.CollaborationList
-
Gets the keys for all the items on the list.
- getKeys() - Method in interface com.vaadin.collaborationengine.CollaborationMap
-
Gets a stream of the currently available keys.
- getLatestLicenseEvents(String) - Method in interface com.vaadin.collaborationengine.LicenseStorage
-
Deprecated.Gets a map of license event names with the date of their last occurrence.
- getLicenseEventHandler() - Method in class com.vaadin.collaborationengine.CollaborationEngineConfiguration
-
Deprecated, for removal: This API element is subject to removal in a future version.the handler is not used since 6.3
- getLicenseStorage() - Method in class com.vaadin.collaborationengine.CollaborationEngineConfiguration
-
Deprecated, for removal: This API element is subject to removal in a future version.license storage is not needed since 6.3
- getLocalUser() - Method in class com.vaadin.collaborationengine.AbstractCollaborationManager
-
Gets the local user of this manager.
- getMaxItemsVisible() - Method in class com.vaadin.collaborationengine.CollaborationAvatarGroup
-
Gets the maximum number of avatars to display, or
nullif no max has been set. - getMessage() - Method in class com.vaadin.collaborationengine.CollaborationMessagePersister.PersistRequest
-
Gets the message to persist.
- getMessage() - Method in class com.vaadin.collaborationengine.LicenseEvent
-
Deprecated.Gets the message describing the event.
- getMessage() - Method in interface com.vaadin.collaborationengine.MessageHandler.MessageContext
-
Gets the message.
- getMessageConfigurator() - Method in class com.vaadin.collaborationengine.CollaborationMessageList
-
Gets the current message configurator, if any.
- getName() - Method in class com.vaadin.collaborationengine.UserInfo
-
Gets the user's name.
- getNamedList(String) - Method in class com.vaadin.collaborationengine.TopicConnection
-
Gets a collaboration list that can be used to track a list of items in a single topic.
- getNamedMap(String) - Method in class com.vaadin.collaborationengine.TopicConnection
-
Gets a collaboration map that can be used to track multiple values in a single topic.
- getNext() - Method in class com.vaadin.collaborationengine.ListChangeEvent
-
Gets the key of the item which is after the current item after the change.
- getNodeId() - Method in class com.vaadin.collaborationengine.Backend
-
Gets the unique identifier of this backend node.
- getNodeId() - Method in class com.vaadin.collaborationengine.LocalBackend
- getNodeId() - Method in class com.vaadin.collaborationengine.MembershipEvent
-
Gets the node identifier.
- getOldNext() - Method in class com.vaadin.collaborationengine.ListChangeEvent
-
Gets the key of the item which was after the current item before the change.
- getOldPrev() - Method in class com.vaadin.collaborationengine.ListChangeEvent
-
Gets the key of the item which was before the current item before the change.
- getOldValue(TypeReference<T>) - Method in class com.vaadin.collaborationengine.ListChangeEvent
-
Gets the old value of the list item affected by the change as instance corresponding to the given type reference.
- getOldValue(TypeReference<T>) - Method in class com.vaadin.collaborationengine.MapChangeEvent
-
Gets the old value as an instance corresponding to the given type reference.
- getOldValue(Class<T>) - Method in class com.vaadin.collaborationengine.ListChangeEvent
-
Gets the old value of the list item affected by the change as instance of the given class.
- getOldValue(Class<T>) - Method in class com.vaadin.collaborationengine.MapChangeEvent
-
Gets the old value as an instance of the given class.
- getPayload() - Method in class com.vaadin.collaborationengine.Backend.Snapshot
- getPrev() - Method in class com.vaadin.collaborationengine.ListChangeEvent
-
Gets the key of the item which is before the current item after the change.
- getPropertyName() - Method in interface com.vaadin.collaborationengine.HighlightHandler.HighlightContext
-
Gets the property name.
- getPropertyName() - Method in interface com.vaadin.collaborationengine.PropertyChangeHandler.PropertyChangeEvent
-
Gets the property name.
- getSince() - Method in class com.vaadin.collaborationengine.CollaborationMessagePersister.FetchQuery
-
Gets the timestamp since when messages should be fetched.
- getSource() - Method in class com.vaadin.collaborationengine.CollaborationMessagePersister.FetchQuery
- getSource() - Method in class com.vaadin.collaborationengine.CollaborationMessagePersister.PersistRequest
- getSource() - Method in class com.vaadin.collaborationengine.LicenseEvent
-
Deprecated.
- getSource() - Method in class com.vaadin.collaborationengine.ListChangeEvent
- getSource() - Method in class com.vaadin.collaborationengine.MapChangeEvent
- getSource() - Method in class com.vaadin.collaborationengine.MembershipEvent
- getSource() - Method in class com.vaadin.collaborationengine.TopicConnectionRegistration.ConnectionFailedEvent
- getSystemContext() - Method in class com.vaadin.collaborationengine.CollaborationEngine
-
Gets a system connection context for this collaboration engine instance.
- getText() - Method in class com.vaadin.collaborationengine.CollaborationMessage
-
Gets the message content.
- getTime() - Method in class com.vaadin.collaborationengine.CollaborationMessage
-
Gets the message timestamp.
- getTooltip() - Method in class com.vaadin.collaborationengine.CollaborationMessageInput
-
Gets the tooltip handle of the component.
- getTopicId() - Method in class com.vaadin.collaborationengine.AbstractCollaborationManager
-
Gets the topic id of this manager.
- getTopicId() - Method in class com.vaadin.collaborationengine.CollaborationMessagePersister.FetchQuery
-
Gets the topic identifier.
- getTopicId() - Method in class com.vaadin.collaborationengine.CollaborationMessagePersister.PersistRequest
-
Gets the topic identifier.
- getType() - Method in class com.vaadin.collaborationengine.LicenseEvent
-
Deprecated.Gets the type of the event.
- getType() - Method in class com.vaadin.collaborationengine.MembershipEvent
-
Gets the type of the event.
- getUser() - Method in class com.vaadin.collaborationengine.CollaborationMessage
-
Gets the message author user-info.
- getUser() - Method in interface com.vaadin.collaborationengine.HighlightHandler.HighlightContext
-
Gets the user.
- getUser() - Method in interface com.vaadin.collaborationengine.PresenceHandler.PresenceContext
-
Gets the user.
- getUserColorIndex(UserInfo) - Method in class com.vaadin.collaborationengine.CollaborationEngine
-
Gets the color index of a user if different to -1, or let Collaboration Engine provide one.
- getUserEntries(String, YearMonth) - Method in interface com.vaadin.collaborationengine.LicenseStorage
-
Deprecated.Gets a list of entries for users seen in the specified month.
- getUserInfo() - Method in class com.vaadin.collaborationengine.TopicConnection
-
Gets the user who is related to this topic connection.
- getValue() - Method in interface com.vaadin.collaborationengine.PropertyChangeHandler.PropertyChangeEvent
-
Gets the new value.
- getValue(TypeReference<T>) - Method in class com.vaadin.collaborationengine.ListChangeEvent
-
Gets the current value of the list item affected by the change as instance corresponding to the given type reference.
- getValue(TypeReference<T>) - Method in class com.vaadin.collaborationengine.MapChangeEvent
-
Gets the new value as an instance corresponding to the given type reference.
- getValue(Class<T>) - Method in class com.vaadin.collaborationengine.ListChangeEvent
-
Gets the current value of the list item affected by the change as instance of the given class.
- getValue(Class<T>) - Method in class com.vaadin.collaborationengine.MapChangeEvent
-
Gets the new value as an instance of the given class.
- GRACE_PERIOD_ENDED - Enum constant in enum class com.vaadin.collaborationengine.LicenseEvent.LicenseEventType
-
Deprecated.An event of this type is fired when the grace period ends.
- GRACE_PERIOD_STARTED - Enum constant in enum class com.vaadin.collaborationengine.LicenseEvent.LicenseEventType
-
Deprecated.An event of this type is fired when the grace period starts.
H
- handleHighlight(HighlightHandler.HighlightContext) - Method in interface com.vaadin.collaborationengine.HighlightHandler
-
Handles a change of highlight for a property in a topic.
- handleLicenseEvent(LicenseEvent) - Method in interface com.vaadin.collaborationengine.LicenseEventHandler
-
Deprecated.Handles a license event.
- handleMembershipEvent(MembershipEvent) - Method in interface com.vaadin.collaborationengine.MembershipListener
-
Handles a membership event.
- handleMessage(MessageHandler.MessageContext) - Method in interface com.vaadin.collaborationengine.MessageHandler
-
Handles a message when it is added to a topic.
- handlePresence(PresenceHandler.PresenceContext) - Method in interface com.vaadin.collaborationengine.PresenceHandler
-
Handles a change of user presence in a topic.
- handlePropertyChange(PropertyChangeHandler.PropertyChangeEvent) - Method in interface com.vaadin.collaborationengine.PropertyChangeHandler
-
Handles a change of value for a property in a topic.
- hasAccess() - Method in class com.vaadin.collaborationengine.AccessResponse
-
Gets the info of whether the user has access to Collaboration Engine or not.
- HasExpirationTimeout - Interface in com.vaadin.collaborationengine
-
Common interface to be implemented by types holding data associated to a topic, which provides methods to set an expiration timeout on the data which will be cleared after the timeout has passed since the last connection to the topic has been closed.
- hashCode() - Method in class com.vaadin.collaborationengine.CollaborationMessage
- hashCode() - Method in class com.vaadin.collaborationengine.ListKey
- hashCode() - Method in class com.vaadin.collaborationengine.UserInfo
- highlight(String, boolean) - Method in class com.vaadin.collaborationengine.FormManager
-
Sets the highlight state of the provided property name for the local user.
- highlight(String, boolean, int) - Method in class com.vaadin.collaborationengine.FormManager
-
Sets the highlight state at the provided field index of the provided property name for the local user.
- HighlightHandler - Interface in com.vaadin.collaborationengine
-
Functional interface that defines how to handle highlight changes for properties in a topic.
- HighlightHandler.HighlightContext - Interface in com.vaadin.collaborationengine
-
The context of the highlight.
I
- ifEmpty() - Method in class com.vaadin.collaborationengine.ListOperation
-
Adds a condition that requires the list to be empty.
- ifFirst(ListKey) - Method in class com.vaadin.collaborationengine.ListOperation
-
Adds a condition that requires the specified
keyto be the first in the list. - ifLast(ListKey) - Method in class com.vaadin.collaborationengine.ListOperation
-
Adds a condition that requires the specified
keyto be the last in the list. - ifNext(ListKey, ListKey) - Method in class com.vaadin.collaborationengine.ListOperation
-
Adds a condition that requires the specified
nextKeyto be right after the specifiedkeywhen the operation is applied. - ifNotEmpty() - Method in class com.vaadin.collaborationengine.ListOperation
-
Adds a condition that requires the list not to be empty.
- ifPrev(ListKey, ListKey) - Method in class com.vaadin.collaborationengine.ListOperation
-
Adds a condition that requires the specified
prevKeyto be right before the specifiedkeywhen the operation is applied. - ifValue(ListKey, Object) - Method in class com.vaadin.collaborationengine.ListOperation
-
Add a condition that requires the specified
keyto have the specifiedvalue. - init(ActivationHandler, Executor) - Method in class com.vaadin.collaborationengine.ComponentConnectionContext
- init(ActivationHandler, Executor) - Method in interface com.vaadin.collaborationengine.ConnectionContext
-
Initializes the connection context with a
ActivationHandlerand anExecutor. - init(ActivationHandler, Executor) - Method in class com.vaadin.collaborationengine.SystemConnectionContext
- INSERT_AFTER - Enum constant in enum class com.vaadin.collaborationengine.ListOperation.OperationType
- INSERT_BEFORE - Enum constant in enum class com.vaadin.collaborationengine.ListOperation.OperationType
- insertAfter(ListKey, Object) - Method in interface com.vaadin.collaborationengine.CollaborationList
-
Inserts the given item just after the given key location.
- insertAfter(ListKey, Object) - Static method in class com.vaadin.collaborationengine.ListOperation
-
Creates a list operation to insert the given value just after the position specified by the given key.
- insertBefore(ListKey, Object) - Method in interface com.vaadin.collaborationengine.CollaborationList
-
Inserts the given item just before the given key location.
- insertBefore(ListKey, Object) - Static method in class com.vaadin.collaborationengine.ListOperation
-
Creates a list operation to insert the given value just before the position specified by the given key.
- insertBetween(ListKey, ListKey, Object) - Static method in class com.vaadin.collaborationengine.ListOperation
-
Creates a list operation to insert the given value between the positions specified by the given keys.
- insertFirst(Object) - Method in interface com.vaadin.collaborationengine.CollaborationList
-
Inserts the given item as the first item of the list.
- insertFirst(Object) - Static method in class com.vaadin.collaborationengine.ListOperation
-
Creates a list operation to insert the given value as the first item of the list.
- insertLast(Object) - Method in interface com.vaadin.collaborationengine.CollaborationList
-
Inserts the given item as the last item of the list.
- insertLast(Object) - Static method in class com.vaadin.collaborationengine.ListOperation
-
Creates a list operation to insert the given value as the last item of the list.
- isAnnounceMessages() - Method in class com.vaadin.collaborationengine.CollaborationMessageList
-
Wrapper method for
MessageList.isAnnounceMessages(). - isAutomaticallyActivatePush() - Method in class com.vaadin.collaborationengine.CollaborationEngineConfiguration
-
Checks whether automatic push activation is enabled.
- isMarkdown() - Method in class com.vaadin.collaborationengine.CollaborationMessageList
-
Wrapper method for
MessageList.isMarkdown(). - isOwnAvatarVisible() - Method in class com.vaadin.collaborationengine.CollaborationAvatarGroup
-
Gets whether the user's own avatar is displayed in the avatar group or not.
J
- JOIN - Enum constant in enum class com.vaadin.collaborationengine.MembershipEvent.MembershipEventType
- JsonConversionException - Exception in com.vaadin.collaborationengine
-
Thrown when unable to convert back and forth between a Java object instance and a Jackson
JsonNodeinstance. - JsonConversionException(String, Throwable) - Constructor for exception com.vaadin.collaborationengine.JsonConversionException
-
Constructs a new Json conversion exception
L
- LEAVE - Enum constant in enum class com.vaadin.collaborationengine.MembershipEvent.MembershipEventType
- LICENSE_EXPIRED - Enum constant in enum class com.vaadin.collaborationengine.LicenseEvent.LicenseEventType
-
Deprecated.An event of this type is fired when the license is expired.
- LICENSE_EXPIRES_SOON - Enum constant in enum class com.vaadin.collaborationengine.LicenseEvent.LicenseEventType
-
Deprecated.An event of this type is fired when the license is expiring in less than 31 days.
- LicenseEvent - Class in com.vaadin.collaborationengine
-
Deprecated, for removal: This API element is subject to removal in a future version.license events will not be received by any listener
- LicenseEvent.LicenseEventType - Enum Class in com.vaadin.collaborationengine
-
Deprecated, for removal: This API element is subject to removal in a future version.license events will not be received by any listener
- LicenseEventHandler - Interface in com.vaadin.collaborationengine
-
Deprecated, for removal: This API element is subject to removal in a future version.any implementation of this interface won't receive any events, prefer using the default
CollaborationEngineConfigurationconstructor - LicenseStorage - Interface in com.vaadin.collaborationengine
-
Deprecated, for removal: This API element is subject to removal in a future version.license storage is not needed since 6.3
- ListChangeEvent - Class in com.vaadin.collaborationengine
-
Event that is fired when the value in a collaboration list changes.
- ListKey - Class in com.vaadin.collaborationengine
-
An object which identifies each item of a
CollaborationList. - ListOperation - Class in com.vaadin.collaborationengine
-
A list operation providing details such as the operation type, related properties and conditions that should be met for the operation to succeed.
- ListOperation.OperationType - Enum Class in com.vaadin.collaborationengine
- ListOperationResult<T> - Class in com.vaadin.collaborationengine
-
The result of a list operation in a
CollaborationList. - ListSubscriber - Interface in com.vaadin.collaborationengine
-
Event handler that gets notified for changes to collaboration lists.
- loadLatestSnapshot(String) - Method in class com.vaadin.collaborationengine.Backend
-
Loads the latest snapshot of data identified by the given name.
- loadLatestSnapshot(String) - Method in class com.vaadin.collaborationengine.LocalBackend
- LocalBackend - Class in com.vaadin.collaborationengine
-
A simple backend implementation that only distributes events locally and assumes that there is no previous history for event logs.
- LocalBackend() - Constructor for class com.vaadin.collaborationengine.LocalBackend
M
- MapChangeEvent - Class in com.vaadin.collaborationengine
-
Event that is fired when the value in a collaboration map changes.
- MapChangeEvent(CollaborationMap, MapChange) - Constructor for class com.vaadin.collaborationengine.MapChangeEvent
-
Creates a new map change event.
- MapSubscriber - Interface in com.vaadin.collaborationengine
-
Event handler that gets notified for changes to collaboration maps.
- markAsPresent(boolean) - Method in class com.vaadin.collaborationengine.PresenceManager
-
Configures the manager to mark the local user present in the topic.
- MembershipEvent - Class in com.vaadin.collaborationengine
-
The event dispatched when a node joins or leaves the backend.
- MembershipEvent(MembershipEvent.MembershipEventType, UUID, CollaborationEngine) - Constructor for class com.vaadin.collaborationengine.MembershipEvent
-
Creates a new event.
- MembershipEvent.MembershipEventType - Enum Class in com.vaadin.collaborationengine
-
The type of the event.
- MembershipListener - Interface in com.vaadin.collaborationengine
-
A listener of
MembershipEvent. - MessageHandler - Interface in com.vaadin.collaborationengine
-
Functional interface that defines how to handle a message when it is added to a topic.
- MessageHandler.MessageContext - Interface in com.vaadin.collaborationengine
-
The context of the message.
- MessageManager - Class in com.vaadin.collaborationengine
-
Manager to handle messages sent to a topic.
- MessageManager(ConnectionContext, UserInfo, String, CollaborationEngine) - Constructor for class com.vaadin.collaborationengine.MessageManager
-
Deprecated, for removal: This API element is subject to removal in a future version.This constructor is not compatible with serialization
- MessageManager(ConnectionContext, UserInfo, String, CollaborationMessagePersister, CollaborationEngine) - Constructor for class com.vaadin.collaborationengine.MessageManager
-
Deprecated, for removal: This API element is subject to removal in a future version.This constructor is not compatible with serialization
- MessageManager(ConnectionContext, UserInfo, String, CollaborationMessagePersister, SerializableSupplier<CollaborationEngine>) - Constructor for class com.vaadin.collaborationengine.MessageManager
-
Creates a new persisting manager for the given connection context.
- MessageManager(ConnectionContext, UserInfo, String, SerializableSupplier<CollaborationEngine>) - Constructor for class com.vaadin.collaborationengine.MessageManager
-
Creates a new manager for the given connection context.
- MessageManager(Component, UserInfo, String) - Constructor for class com.vaadin.collaborationengine.MessageManager
-
Creates a new manager for the given component.
- MessageManager(Component, UserInfo, String, CollaborationMessagePersister) - Constructor for class com.vaadin.collaborationengine.MessageManager
-
Creates a new persisting manager for the given component.
- MOVE_AFTER - Enum constant in enum class com.vaadin.collaborationengine.ListOperation.OperationType
- MOVE_BEFORE - Enum constant in enum class com.vaadin.collaborationengine.ListOperation.OperationType
- moveAfter(ListKey, ListKey) - Method in interface com.vaadin.collaborationengine.CollaborationList
-
Moves the second given key just after the first given key location.
- moveAfter(ListKey, ListKey) - Static method in class com.vaadin.collaborationengine.ListOperation
-
Creates a list operation to move the given entry to just after the position specified by the given key.
- moveBefore(ListKey, ListKey) - Method in interface com.vaadin.collaborationengine.CollaborationList
-
Moves the second given key just before the first given key location.
- moveBefore(ListKey, ListKey) - Static method in class com.vaadin.collaborationengine.ListOperation
-
Creates a list operation to move the given entry to just before the position specified by the given key.
- moveBetween(ListKey, ListKey, ListKey) - Static method in class com.vaadin.collaborationengine.ListOperation
-
Creates a list operation to move the given entry between the positions specified by the given keys.
O
- of(UUID) - Static method in class com.vaadin.collaborationengine.ListKey
-
Creates the
ListKeyfor the providedkeyparameter. - onActivation() - Method in interface com.vaadin.collaborationengine.AbstractCollaborationManager.ActivationHandler
-
The method executed when the manager is activated.
- onActivation(CollaborationMessageSubmitter.ActivationContext) - Method in interface com.vaadin.collaborationengine.CollaborationMessageSubmitter
-
Handles the activation of the submitter, for example setting up an input component to append new messages using the
CollaborationMessageSubmitter.ActivationContext.appendMessage(String)method. - onConnectionFailed(TopicConnectionRegistration.ConnectionFailedAction) - Method in class com.vaadin.collaborationengine.AbstractCollaborationManager
-
Adds an action to be executed if the topic connection fails.
- onConnectionFailed(TopicConnectionRegistration.ConnectionFailedAction) - Method in class com.vaadin.collaborationengine.TopicConnectionRegistration
-
Adds an action to be executed if the topic connection fails.
- onConnectionFailed(TopicConnectionRegistration.ConnectionFailedEvent) - Method in interface com.vaadin.collaborationengine.TopicConnectionRegistration.ConnectionFailedAction
-
Handles a failed topic connection.
- onListChange(ListChangeEvent) - Method in interface com.vaadin.collaborationengine.ListSubscriber
-
Handles a list change event.
- onMapChange(MapChangeEvent) - Method in interface com.vaadin.collaborationengine.MapSubscriber
-
Handles a map change event.
- openEventLog(String) - Method in class com.vaadin.collaborationengine.Backend
-
Opens an event log with the given id.
- openEventLog(String) - Method in class com.vaadin.collaborationengine.LocalBackend
- openTopicConnection(ConnectionContext, SerializableFunction<TopicConnection, Registration>) - Method in class com.vaadin.collaborationengine.AbstractCollaborationManager
-
Opens a connection to the topic of this manager using the provided context and activation callback.
- openTopicConnection(ConnectionContext, String, UserInfo, SerializableFunction<TopicConnection, Registration>) - Method in class com.vaadin.collaborationengine.CollaborationEngine
-
Opens a connection to the collaboration topic with the provided id based on a generic context definition.
- openTopicConnection(Component, String, UserInfo, SerializableFunction<TopicConnection, Registration>) - Method in class com.vaadin.collaborationengine.CollaborationEngine
-
Opens a connection to the collaboration topic with the provided id based on a component instance.
P
- persistMessage(CollaborationMessagePersister.PersistRequest) - Method in interface com.vaadin.collaborationengine.CollaborationMessagePersister
-
Writes a
CollaborationMessageto the persistence backend. - PresenceHandler - Interface in com.vaadin.collaborationengine
-
Functional interface that defines how to handle user presence changes in a topic.
- PresenceHandler.PresenceContext - Interface in com.vaadin.collaborationengine
-
The context of the user presence.
- PresenceManager - Class in com.vaadin.collaborationengine
-
Manager to handle user presence in topics.
- PresenceManager(ConnectionContext, UserInfo, String, CollaborationEngine) - Constructor for class com.vaadin.collaborationengine.PresenceManager
-
Deprecated, for removal: This API element is subject to removal in a future version.This constructor is not compatible with serialization
- PresenceManager(ConnectionContext, UserInfo, String, SerializableSupplier<CollaborationEngine>) - Constructor for class com.vaadin.collaborationengine.PresenceManager
-
Creates a new manager for the provided connection context.
- PresenceManager(Component, UserInfo, String) - Constructor for class com.vaadin.collaborationengine.PresenceManager
-
Creates a new manager for the provided component.
- PropertyChangeHandler - Interface in com.vaadin.collaborationengine
-
Functional interface that defines how to handle value changes for properties in a topic.
- PropertyChangeHandler.PropertyChangeEvent - Interface in com.vaadin.collaborationengine
-
The property change event.
- put(String, Object) - Method in interface com.vaadin.collaborationengine.CollaborationMap
-
Associates the given value with the given key.
- put(String, Object, EntryScope) - Method in interface com.vaadin.collaborationengine.CollaborationMap
-
Associates the given value with the given key and scope.
R
- readBean(BEAN) - Method in class com.vaadin.collaborationengine.CollaborationBinder
-
Deprecated.This operation is not supported by the collaboration binder. You can instead provide the bean for populating the fields using
CollaborationBinder.setTopic(java.lang.String, com.vaadin.flow.function.SerializableSupplier<BEAN>)to avoid overriding currently edited values. If you explicitly want to reset the field values for every user currently editing the fields, you can useCollaborationBinder.reset(BEAN). - remove() - Method in class com.vaadin.collaborationengine.TopicConnectionRegistration
-
Closes the topic connection.
- remove(ListKey) - Method in interface com.vaadin.collaborationengine.CollaborationList
-
Removes the value for the item identified by the given key.
- remove(String) - Method in interface com.vaadin.collaborationengine.CollaborationMap
-
Removes the value with the given key.
- remove(String, Object) - Method in interface com.vaadin.collaborationengine.CollaborationMap
-
Removes the value with the given key only if and only if the current value is as expected.
- removeBindingInternal(Binder.Binding<BEAN, ?>) - Method in class com.vaadin.collaborationengine.CollaborationBinder
- removeComponent(Component) - Method in class com.vaadin.collaborationengine.ComponentConnectionContext
-
Stops tracking a component for this context.
- removeEditor(TopicConnection, String, UserInfo) - Static method in class com.vaadin.collaborationengine.CollaborationBinderUtil
-
Signals that the user is not editing the field that is bound to the property.
- removeThemeVariants(AvatarGroupVariant...) - Method in class com.vaadin.collaborationengine.CollaborationAvatarGroup
-
Removes theme variants from the avatar group component.
- replace(String, Object, Object) - Method in interface com.vaadin.collaborationengine.CollaborationMap
-
Atomically replaces the value for a key if and only if the current value is as expected.
- replaceSnapshot(String, UUID, UUID, String) - Method in class com.vaadin.collaborationengine.Backend
-
Submits a snapshot payload of data identified by the given name.
- replaceSnapshot(String, UUID, UUID, String) - Method in class com.vaadin.collaborationengine.LocalBackend
- requestAccess(ConnectionContext, UserInfo, Consumer<AccessResponse>) - Method in class com.vaadin.collaborationengine.CollaborationEngine
-
Deprecated, for removal: This API element is subject to removal in a future version.this method is deprecated and now the callback always receives a response that resolves to
true - requestAccess(UserInfo, Consumer<AccessResponse>) - Method in class com.vaadin.collaborationengine.CollaborationEngine
-
Deprecated, for removal: This API element is subject to removal in a future version.this method is deprecated and now the callback always receives a response that resolves to
true - reset(BEAN) - Method in class com.vaadin.collaborationengine.CollaborationBinder
-
Resets collaborative fields with values from the bound properties of the given bean.
S
- SerializableExecutor - Interface in com.vaadin.collaborationengine
- serviceInit(ServiceInitEvent) - Method in class com.vaadin.collaborationengine.CollaborationEngineServiceInitListener
- set(ListKey, Object) - Method in interface com.vaadin.collaborationengine.CollaborationList
-
Sets a new value for the item identified by the given key.
- set(ListKey, Object) - Static method in class com.vaadin.collaborationengine.ListOperation
-
Creates a list operation to set the given value at the position specified by the given key.
- SET - Enum constant in enum class com.vaadin.collaborationengine.ListOperation.OperationType
- setAbbreviation(String) - Method in class com.vaadin.collaborationengine.SystemUserInfo
- setAbbreviation(String) - Method in class com.vaadin.collaborationengine.UserInfo
-
Sets the user's abbreviation.
- setActivationHandler(AbstractCollaborationManager.ActivationHandler) - Method in class com.vaadin.collaborationengine.AbstractCollaborationManager
-
Sets a handler that will be executed when the manager is activated, i.e.
- setAnnounceMessages(boolean) - Method in class com.vaadin.collaborationengine.CollaborationMessageList
-
Wrapper method for
MessageList.setAnnounceMessages(boolean). - setAutomaticallyActivatePush(boolean) - Method in class com.vaadin.collaborationengine.CollaborationEngineConfiguration
-
Sets whether server push should be automatically activated if needed.
- setBackend(Backend) - Method in class com.vaadin.collaborationengine.CollaborationEngineConfiguration
-
Sets the backend implementation to use.
- setBeaconPath(String) - Method in class com.vaadin.collaborationengine.CollaborationEngineConfiguration
-
Sets the path that is used for the beacon handler.
- setBean(BEAN) - Method in class com.vaadin.collaborationengine.CollaborationBinder
-
Deprecated.This operation is not supported by the collaboration binder. You can instead provide the bean for populating the fields using
CollaborationBinder.setTopic(java.lang.String, com.vaadin.flow.function.SerializableSupplier<BEAN>), and write the values back to the bean usingBinder.writeBean(BEAN). - setCollaborationEngine(CollaborationEngine) - Method in class com.vaadin.collaborationengine.Backend
-
Sets the
CollaborationEngineinstance for this backend. - setColorIndex(int) - Method in class com.vaadin.collaborationengine.SystemUserInfo
- setColorIndex(int) - Method in class com.vaadin.collaborationengine.UserInfo
-
Sets the user's color index.
- setDataDir(String) - Method in class com.vaadin.collaborationengine.CollaborationEngineConfiguration
-
Deprecated, for removal: This API element is subject to removal in a future version.the data-directory is not used since 6.3
- setExecutorService(ExecutorService) - Method in class com.vaadin.collaborationengine.CollaborationEngineConfiguration
-
Sets the
ExecutorServicewhich will be used to dispatch actions asynchronously. - setExpirationTimeout(Duration) - Method in class com.vaadin.collaborationengine.CollaborationBinder
-
Sets the expiration timeout of this binder.
- setExpirationTimeout(Duration) - Method in interface com.vaadin.collaborationengine.CollaborationList
-
Sets the expiration timeout of this list.
- setExpirationTimeout(Duration) - Method in interface com.vaadin.collaborationengine.CollaborationMap
-
Sets the expiration timeout of this map.
- setExpirationTimeout(Duration) - Method in class com.vaadin.collaborationengine.FormManager
-
Sets the expiration timeout of the field property data.
- setExpirationTimeout(Duration) - Method in interface com.vaadin.collaborationengine.HasExpirationTimeout
-
Sets the expiration timeout of the data held by the implementing object.
- setFieldValue(TopicConnection, String, Object) - Static method in class com.vaadin.collaborationengine.CollaborationBinderUtil
-
Sets the property value in the collaboration binders connected to the same topic, updating the fields which are bound to that property for all connected clients.
- setHighlightHandler(HighlightHandler) - Method in class com.vaadin.collaborationengine.FormManager
-
Sets a handler which will be invoked when a highlight is set.
- setI18n(AvatarGroup.AvatarGroupI18n) - Method in class com.vaadin.collaborationengine.CollaborationAvatarGroup
-
Sets the internationalization properties for this component.
- setI18n(MessageInputI18n) - Method in class com.vaadin.collaborationengine.CollaborationMessageInput
-
Sets the internationalization properties for this component.
- setImage(String) - Method in class com.vaadin.collaborationengine.SystemUserInfo
- setImage(String) - Method in class com.vaadin.collaborationengine.UserInfo
-
Sets the url of the user's image.
- setImageHandler(CollaborationAvatarGroup.ImageHandler) - Method in class com.vaadin.collaborationengine.CollaborationAvatarGroup
-
Sets an image handler callback for dynamically loading avatar images for a given user.
- setImageHandler(CollaborationAvatarGroup.ImageHandler) - Method in class com.vaadin.collaborationengine.CollaborationMessageList
-
Sets an image handler callback for dynamically loading avatar images for a given user.
- setImageProvider(CollaborationAvatarGroup.ImageProvider) - Method in class com.vaadin.collaborationengine.CollaborationAvatarGroup
-
Deprecated, for removal: This API element is subject to removal in a future version.
- setImageProvider(CollaborationAvatarGroup.ImageProvider) - Method in class com.vaadin.collaborationengine.CollaborationMessageList
-
Deprecated, for removal: This API element is subject to removal in a future version.
- setLicenseEvent(String, String, LocalDate) - Method in interface com.vaadin.collaborationengine.LicenseStorage
-
Deprecated.Sets the date of the latest occurrence of the specified license event.
- setLicenseStorage(LicenseStorage) - Method in class com.vaadin.collaborationengine.CollaborationEngineConfiguration
-
Deprecated, for removal: This API element is subject to removal in a future version.license storage is not needed since 6.3
- setMarkdown(boolean) - Method in class com.vaadin.collaborationengine.CollaborationMessageList
-
Wrapper method for
MessageList.setMarkdown(boolean). - setMaxItemsVisible(Integer) - Method in class com.vaadin.collaborationengine.CollaborationAvatarGroup
-
Sets the the maximum number of avatars to display.
- setMessageConfigurator(CollaborationMessageList.MessageConfigurator) - Method in class com.vaadin.collaborationengine.CollaborationMessageList
-
Sets a configurator callback for the messages.
- setMessageHandler(MessageHandler) - Method in class com.vaadin.collaborationengine.MessageManager
-
Sets a handler which will be invoked for all messages already in the topic and when a new message is submitted.
- setName(String) - Method in class com.vaadin.collaborationengine.SystemUserInfo
- setName(String) - Method in class com.vaadin.collaborationengine.UserInfo
-
Sets the user's name.
- setOwnAvatarVisible(boolean) - Method in class com.vaadin.collaborationengine.CollaborationAvatarGroup
-
Sets whether to display user's own avatar in the avatar group or not.
- setPresenceHandler(PresenceHandler) - Method in class com.vaadin.collaborationengine.PresenceManager
-
Sets a handler which will be invoked when a user becomes present.
- setPropertyChangeHandler(PropertyChangeHandler) - Method in class com.vaadin.collaborationengine.FormManager
-
Sets a handler which will be invoked when a property changes value.
- setSerializer(Class<T>, SerializableFunction<T, String>, SerializableFunction<String, T>) - Method in class com.vaadin.collaborationengine.CollaborationBinder
-
Sets a custom serializer and deserializer to use for a specific value type.
- setSubmitter(CollaborationMessageSubmitter) - Method in class com.vaadin.collaborationengine.CollaborationMessageList
-
Sets a submitter to handle the append of messages to the list.
- setText(String) - Method in class com.vaadin.collaborationengine.CollaborationMessage
-
Sets the message content.
- setTime(Instant) - Method in class com.vaadin.collaborationengine.CollaborationMessage
-
Sets the message timestamp.
- setTooltipText(String) - Method in class com.vaadin.collaborationengine.CollaborationMessageInput
-
Sets a tooltip text for the component.
- setTopic(String) - Method in class com.vaadin.collaborationengine.CollaborationAvatarGroup
-
Sets the topic to use with this component.
- setTopic(String) - Method in class com.vaadin.collaborationengine.CollaborationMessageList
-
Sets the topic to use with this component.
- setTopic(String, SerializableSupplier<BEAN>) - Method in class com.vaadin.collaborationengine.CollaborationBinder
-
Sets the topic to use with this binder and initializes the topic contents if not already set.
- setUser(UserInfo) - Method in class com.vaadin.collaborationengine.CollaborationMessage
-
Sets the message author user-info.
- setValue(String, Object) - Method in class com.vaadin.collaborationengine.FormManager
-
Sets the value for the provided property name.
- Snapshot(UUID, String) - Constructor for class com.vaadin.collaborationengine.Backend.Snapshot
- submit(CollaborationMessage) - Method in class com.vaadin.collaborationengine.MessageManager
-
Submits a message to the topic.
- submit(String) - Method in class com.vaadin.collaborationengine.MessageManager
-
Submits a message to the topic as the current local user.
- submitEvent(UUID, String) - Method in interface com.vaadin.collaborationengine.Backend.EventLog
-
Submits an event through the backend to all subscribers.
- subscribe(ListSubscriber) - Method in interface com.vaadin.collaborationengine.CollaborationList
-
Subscribes to changes to this list.
- subscribe(MapSubscriber) - Method in interface com.vaadin.collaborationengine.CollaborationMap
-
Subscribes to changes to this map.
- subscribe(UUID, BiConsumer<UUID, String>) - Method in interface com.vaadin.collaborationengine.Backend.EventLog
-
Adds a subscriber to receive all past and future events for this event log.
- SystemConnectionContext - Class in com.vaadin.collaborationengine
-
A connection context that is always active.
- SystemConnectionContext(CollaborationEngine) - Constructor for class com.vaadin.collaborationengine.SystemConnectionContext
-
Deprecated, for removal: This API element is subject to removal in a future version.This constructor is not compatible with serialization
- SystemConnectionContext(SerializableSupplier<CollaborationEngine>) - Constructor for class com.vaadin.collaborationengine.SystemConnectionContext
-
Creates a new system connection context instance for the given Collaboration Engine instance.
- SystemUserInfo - Class in com.vaadin.collaborationengine
-
A
UserInfofor non-interaction thread.
T
- TOPIC - Enum constant in enum class com.vaadin.collaborationengine.EntryScope
-
This is the default scope and entries with this scope will be removed only if explicitly requested.
- TopicConnection - Class in com.vaadin.collaborationengine
-
API for sending and subscribing to updates between clients collaborating on the same collaboration topic.
- TopicConnectionRegistration - Class in com.vaadin.collaborationengine
-
A registration for configuring or removing a topic connection that is opened with Collaboration Engine.
- TopicConnectionRegistration.ConnectionFailedAction - Interface in com.vaadin.collaborationengine
-
An action for handling a failed topic connection.
- TopicConnectionRegistration.ConnectionFailedEvent - Class in com.vaadin.collaborationengine
-
An event that is fired when the topic connection fails.
- truncate(UUID) - Method in interface com.vaadin.collaborationengine.Backend.EventLog
-
Removes all events in the log before the given id.
U
- UserInfo - Class in com.vaadin.collaborationengine
-
User information of a collaborating user, used with various features of the collaboration engine.
- UserInfo(String) - Constructor for class com.vaadin.collaborationengine.UserInfo
-
Creates a new user info object from the given user id.
- UserInfo(String, String) - Constructor for class com.vaadin.collaborationengine.UserInfo
-
Creates a new user info object from the given user id and name.
- UserInfo(String, String, String) - Constructor for class com.vaadin.collaborationengine.UserInfo
-
Creates a new user info object from the given user id, name and image URL.
V
- valueOf(String) - Static method in enum class com.vaadin.collaborationengine.EntryScope
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.vaadin.collaborationengine.LicenseEvent.LicenseEventType
-
Deprecated.Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.vaadin.collaborationengine.ListOperation.OperationType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.vaadin.collaborationengine.MembershipEvent.MembershipEventType
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class com.vaadin.collaborationengine.EntryScope
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.vaadin.collaborationengine.LicenseEvent.LicenseEventType
-
Deprecated.Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.vaadin.collaborationengine.ListOperation.OperationType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.vaadin.collaborationengine.MembershipEvent.MembershipEventType
-
Returns an array containing the constants of this enum class, in the order they are declared.
W
- withConverter(Converter<TARGET, NEWTARGET>, boolean) - Method in class com.vaadin.collaborationengine.CollaborationBinder.CollaborationBindingBuilderImpl
- withNullRepresentation(TARGET) - Method in class com.vaadin.collaborationengine.CollaborationBinder.CollaborationBindingBuilderImpl
- withScope(EntryScope) - Method in class com.vaadin.collaborationengine.ListOperation
-
Sets the scope of the item affected by this operation.
All Classes and Interfaces|All Packages|Serialized Form