Package com.vaadin.collaborationengine

Class CollaborationBinder<BEAN>

java.lang.Object
com.vaadin.flow.data.binder.Binder<BEAN>
com.vaadin.collaborationengine.CollaborationBinder<BEAN>
Type Parameters:
BEAN - the bean type
All Implemented Interfaces:
HasExpirationTimeout, Serializable
public class CollaborationBinder<BEAN> extends Binder<BEAN> implements HasExpirationTimeout
Extension of Binder for creating collaborative forms with CollaborationEngine. In addition to Binder's data binding mechanism, CollaborationBinder synchronizes the field values between clients which are connected to the same topic via TopicConnection.
Since:
1.0
Author:
Vaadin Ltd
See Also:

  • Constructor Details

    • CollaborationBinder

      public CollaborationBinder(Class<BEAN> beanType, UserInfo localUser)
      Creates a new collaboration binder. It uses reflection based on the provided bean type to resolve bean properties.

      The provided user information is used in the field editing indicators. The name of the user will be displayed to other users when editing a field, and the user's color index will be used to set the field's highlight color.

      Parameters:
      beanType - the bean type to use, not null
      localUser - the information of the local user, not null
      Since:
      1.0

  • Method Details

    • configureBinding

      protected Binder.BindingBuilder<BEAN,?> configureBinding(Binder.BindingBuilder<BEAN,?> baseBinding, PropertyDefinition<BEAN,?> definition)
      Description copied from class: Binder
      Configures the binding with the property definition definition before it's being bound.
      Overrides:
      configureBinding in class Binder<BEAN>
      Parameters:
      baseBinding - a binding to configure
      definition - a property definition information
      Returns:
      the new configured binding

    • removeBindingInternal

      protected void removeBindingInternal(Binder.Binding<BEAN,?> binding)
      Description copied from class: Binder
      Removes (internally) the Binding from the bound properties map (if present) and from the list of Bindings. Note that this DOES NOT remove the ValueChangeListener that the Binding might have registered with any HasValues or decouple the Binder from within the Binding. To do that, use Binder.Binding.unbind() This method should just be used for internal cleanup.
      Overrides:
      removeBindingInternal in class Binder<BEAN>
      Parameters:
      binding - The Binding to remove from the binding map

    • doCreateBinding

      protected <FIELDVALUE, TARGET> Binder.BindingBuilder<BEAN,TARGET> doCreateBinding(HasValue<?,FIELDVALUE> field, Converter<FIELDVALUE,TARGET> converter, BindingValidationStatusHandler handler)
      Overrides:
      doCreateBinding in class Binder<BEAN>

    • bind

      public <FIELDVALUE> Binder.Binding<BEAN,FIELDVALUE> bind(HasValue<?,FIELDVALUE> field, String propertyName)
      Binds the given field to the property with the given name, as described in Binder.bind(HasValue, String).

      In addition, synchronizes the values with other collaboration binder instances which are connected to the same topic.

      Overrides:
      bind in class Binder<BEAN>
      Type Parameters:
      FIELDVALUE - the value type of the field to bind
      Parameters:
      field - the field to bind, not null
      propertyName - the name of the property to bind, not null
      Returns:
      the newly created binding
      Throws:
      IllegalArgumentException - if the property name is invalid
      IllegalArgumentException - if the property has no accessible getter
      See Also:

    • bindInstanceFields

      public void bindInstanceFields(Object objectWithMemberFields)
      Binds the member fields found in the given object, as described in Binder.bindInstanceFields(Object).

      In addition, synchronizes the values with other collaboration binder instances which are connected to the same topic.

      Overrides:
      bindInstanceFields in class Binder<BEAN>
      Parameters:
      objectWithMemberFields - the object that contains (Java) member fields to bind
      Throws:
      IllegalStateException - if there are incompatible HasValue<T> and property types
      See Also:

    • setBean

      @Deprecated(forRemoval=false) public void setBean(BEAN bean)
      Deprecated.
      This operation is not supported by the collaboration binder. You can instead provide the bean for populating the fields using setTopic(java.lang.String, com.vaadin.flow.function.SerializableSupplier<BEAN>), and write the values back to the bean using Binder.writeBean(BEAN).
      Description copied from class: Binder
      Binds the given bean to all the fields added to this Binder. A null value removes a currently bound bean.

      When a bean is bound, the field values are updated by invoking their corresponding getter functions. Any changes to field values are reflected back to their corresponding property values of the bean as long as the bean is bound.

      Note: Any change made in one of the bound fields runs validation for only the changed Binder.Binding, and additionally any bean level validation for this binder (bean level validators are added using Binder.withValidator(Validator). As a result, the bean set via this method is not guaranteed to always be in a valid state. This means also that possible StatusChangeListener and BinderValidationStatusHandler are called indicating a successful validation, even though some bindings can be in a state that would not pass validation. If bean validity is required at all times, Binder.readBean(Object) and Binder.writeBean(Object) should be used instead.

      After updating each field, the value is read back from the field and the bean's property value is updated if it has been changed from the original value by the field or a converter.

      Overrides:
      setBean in class Binder<BEAN>
      Parameters:
      bean - the bean to edit, or null to remove a currently bound bean and clear bound fields
      See Also:

    • getBean

      @Deprecated(forRemoval=false) public BEAN getBean()
      Deprecated.
      This operation, along with setBean(Object), is not supported by the collaboration binder. Instead of setBean(Object), you can provide the bean for populating the fields using setTopic(java.lang.String, com.vaadin.flow.function.SerializableSupplier<BEAN>), and write the values back to the bean using Binder.writeBean(BEAN).
      Description copied from class: Binder
      Returns the bean that has been bound with Binder.bind(com.vaadin.flow.component.HasValue<?, FIELDVALUE>, com.vaadin.flow.function.ValueProvider<BEAN, FIELDVALUE>, com.vaadin.flow.data.binder.Setter<BEAN, FIELDVALUE>), or null if a bean is not currently bound.
      Overrides:
      getBean in class Binder<BEAN>
      Returns:
      the currently bound bean if any

    • readBean

      @Deprecated(forRemoval=false) public void readBean(BEAN bean)
      Deprecated.
      This operation is not supported by the collaboration binder. You can instead provide the bean for populating the fields using 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 use reset(BEAN).
      Description copied from class: Binder
      Reads the bound property values from the given bean or record to the corresponding fields.

      The bean or record is not otherwise associated with this binder; in particular its property values are not bound to the field value changes. To achieve that, use Binder.setBean(Object).

      Overrides:
      readBean in class Binder<BEAN>
      Parameters:
      bean - the bean or record whose property values to read or null to clear bound fields
      See Also:

    • reset

      public void reset(BEAN bean)
      Resets collaborative fields with values from the bound properties of the given bean. The values will be propagated to all collaborating users.
      Parameters:
      bean - the bean whose property values to read or null to clear bound fields
      Since:
      1.0

    • setTopic

      public void setTopic(String topicId, SerializableSupplier<BEAN> initialBeanSupplier)
      Sets the topic to use with this binder and initializes the topic contents if not already set. Setting a topic removes the connection to the previous topic (if any) and resets all bindings based on values in the new topic. The bean supplier is used to provide initial values for bindings in case the topic doesn't yet contain any values.
      Parameters:
      topicId - the topic id to use, or null to not use any topic
      initialBeanSupplier - a supplier that is invoked to get a bean from which to read initial values. Only invoked if there are no property values in the topic, or if the topic id is null.
      Since:
      1.0

    • forField

      public <FIELDVALUE> Binder.BindingBuilder<BEAN,FIELDVALUE> forField(HasValue<?,FIELDVALUE> field)
      Creates a new binding for the given field. The returned builder may be further configured before invoking Binder.BindingBuilder.bind(ValueProvider, Setter) which completes the binding. Until Binding.bind is called, the binding has no effect.

      Note: Not all HasValue implementations support passing null as the value. For these the Binder will automatically change null to a null representation provided by HasValue.getEmptyValue(). This conversion is one-way only, if you want to have a two-way mapping back to null, use Binder.BindingBuilder.withNullRepresentation(Object).

      The field value will be sent over the network to synchronize the value with other users also editing the same field. The value type to use for deserializing the value is automatically determined based on the bean property type. The type must be defined separately using another overload of this method in case a converter is used or if the property type is parameterized.

      Overrides:
      forField in class Binder<BEAN>
      Type Parameters:
      FIELDVALUE - the value type of the field
      Parameters:
      field - the field to be bound, not null
      Returns:
      the new binding
      See Also:

    • forField

      public <FIELDVALUE> Binder.BindingBuilder<BEAN,FIELDVALUE> forField(HasValue<?,FIELDVALUE> field, Class<FIELDVALUE> fieldType)
      Creates a new binding for the given field and type. The returned builder may be further configured before invoking Binder.BindingBuilder.bind(String) which completes the binding. Until Binding.bind is called, the binding has no effect.

      The field value will be sent over the network to synchronize the value with other users also editing the same field. This method allows explicitly defining the type to use. This is necessary when a converter is used since it's then not possible to derive the type from the bean property.

      Type Parameters:
      FIELDVALUE - the value type of the field
      Parameters:
      field - the field to be bound, not null
      fieldType - the type of the field value, not null
      Returns:
      the new binding builder
      See Also:

    • forField

      public <FIELDVALUE extends Collection<ELEMENT>, ELEMENT> Binder.BindingBuilder<BEAN,FIELDVALUE> forField(HasValue<?,FIELDVALUE> field, Class<? super FIELDVALUE> collectionType, Class<ELEMENT> elementType)
      Creates a new binding for the given (multi select) field whose value type is a collection. The returned builder may be further configured before invoking Binder.BindingBuilder.bind(String) which completes the binding. Until Binding.bind is called, the binding has no effect.

      The field value will be sent over the network to synchronize the value with other users also editing the same field. This method allows explicitly defining the collection type and element type to use.

      Type Parameters:
      FIELDVALUE - the base type of the collection, e.g. Set for CheckboxGroup<String>
      ELEMENT - the type of the elements in the collection, e.g. String for CheckboxGroup<String>
      Parameters:
      field - the field to be bound, not null
      collectionType - the base type of the collection, e.g. Set.class for CheckboxGroup<String>, not null
      elementType - the type of the elements in the collection, e.g. String.class for CheckboxGroup<String>, not null
      Returns:
      the new binding builder
      See Also:

    • forMemberField

      public <FIELDVALUE> Binder.BindingBuilder<BEAN,FIELDVALUE> forMemberField(HasValue<?,FIELDVALUE> field)
      Creates a new binding for the given field. The returned builder may be further configured before invoking Binder.bindInstanceFields(Object). Unlike with the Binder.forField(HasValue) method, no explicit call to Binder.BindingBuilder.bind(String) is needed to complete this binding in the case that the name of the field matches a field name found in the bean.

      The field value will be sent over the network to synchronize the value with other users also editing the same field. The value type to use for deserializing the value is automatically determined based on the bean property type. The type must be defined separately using another overload of this method in case a converter is used or if the property type is parameterized.

      Overrides:
      forMemberField in class Binder<BEAN>
      Type Parameters:
      FIELDVALUE - the value type of the field
      Parameters:
      field - the field to be bound, not null
      Returns:
      the new binding builder
      See Also:

    • forMemberField

      public <FIELDVALUE> Binder.BindingBuilder<BEAN,FIELDVALUE> forMemberField(HasValue<?,FIELDVALUE> field, Class<FIELDVALUE> fieldType)
      Creates a new binding for the given field and type. The returned builder may be further configured before invoking bindInstanceFields(Object). Unlike with the forField(HasValue) method, no explicit call to Binder.BindingBuilder.bind(String) is needed to complete this binding in the case that the name of the field matches a field name found in the bean.

      The field value will be sent over the network to synchronize the value with other users also editing the same field. This method allows explicitly defining the type to use. This is necessary when a converter is used since it's then not possible to derive the type from the bean property.

      Type Parameters:
      FIELDVALUE - the value type of the field
      Parameters:
      field - the field to be bound, not null
      fieldType -
      Returns:
      the new binding builder
      Since:
      1.0
      See Also:

    • forMemberField

      public <FIELDVALUE extends Collection<ELEMENT>, ELEMENT> Binder.BindingBuilder<BEAN,FIELDVALUE> forMemberField(HasValue<?,FIELDVALUE> field, Class<? super FIELDVALUE> collectionType, Class<ELEMENT> elementType)
      Creates a new binding for the given (multi select) field whose value type is a collection. The returned builder may be further configured before invoking bindInstanceFields(Object). Unlike with the forField(HasValue) method, no explicit call to Binder.BindingBuilder.bind(String) is needed to complete this binding in the case that the name of the field matches a field name found in the bean.

      The field value will be sent over the network to synchronize the value with other users also editing the same field. This method allows explicitly defining the collection type and element type to use.

      Type Parameters:
      FIELDVALUE - the base type of the collection, e.g. Set for CheckboxGroup<String>
      ELEMENT - the type of the elements in the collection, e.g. String for CheckboxGroup<String>
      Parameters:
      field - the field to be bound, not null
      collectionType - the base type of the collection, e.g. Set.class for CheckboxGroup<String>, not null
      elementType - the type of the elements in the collection, e.g. String.class for CheckboxGroup<String>, not null
      Returns:
      the new binding builder
      Since:
      1.0
      See Also:

    • setSerializer

      public <T> void setSerializer(Class<T> type, SerializableFunction<T,String> serializer, SerializableFunction<String,T> deserializer)
      Sets a custom serializer and deserializer to use for a specific value type. The serializer and deserializer will be used for all field bindings that implicitly or explicitly use that type either as the field type or as the collection element type in case of multi select fields. It is not allowed to reconfigure the serializer and deserializer for a previously configued type nor for any of the basic types that are supported without custom logic.

      Field values will be sent over the network to synchronize the value with other users also editing the same field. This method allows defining callbacks to convert between the field value and the value that is sent over the network. This is necessary when using complex objects that are not suitable to be sent as-is over the network.

      Type Parameters:
      T - the type handled by the serializer
      Parameters:
      type - the type for which to set a serializer and deserializer, not null
      serializer - a callback that receives a non-empty field value and returns the value to send over the network (not null). The callback cannot be null.
      deserializer - a callback that receives a value produced by the serializer callback (not null) and returns the field value to use. The callback cannot be null.
      Since:
      1.0

    • getExpirationTimeout

      public Optional<Duration> getExpirationTimeout()
      Gets the optional expiration timeout of this binder. An empty Optional is returned if no timeout is set, which means the binder is not cleared when there are no connected users to the related topic (this is the default).
      Specified by:
      getExpirationTimeout in interface HasExpirationTimeout
      Returns:
      the expiration timeout
      Since:
      3.1

    • setExpirationTimeout

      public void setExpirationTimeout(Duration expirationTimeout)
      Sets the expiration timeout of this binder. If set, this binder data is cleared when expirationTimeout has passed after the last connection to the related topic is closed. If set to null, the timeout is cancelled.
      Specified by:
      setExpirationTimeout in interface HasExpirationTimeout
      Parameters:
      expirationTimeout - the expiration timeout
      Since:
      3.1