com.vaadin.flow.component.

Annotation Type Synchronize


  • @Documented
 @Retention(value=RUNTIME)
 @Target(value=METHOD)
public @interface Synchronize

    Annotates getters for which properties should be synchronized to the server.

    By default deduces the name of the property from the name of the getter unless it has been specified using property().

    Since:

    1.0

    Author:

    Vaadin Ltd

    • Required Element Summary

      Required Elements
      Modifier and Type Required Element and Description
      String[] value

      The DOM event(s) to use for synchronization.

    • Optional Element Summary

      Optional Elements
      Modifier and Type Optional Element and Description
      DisabledUpdateMode allowUpdates

      Controls updates for the property from the client side to the server side when the element is disabled.
      String property

      The name of the property to synchronize.

    • Element Detail

      • value

        public abstract String[] value

        The DOM event(s) to use for synchronization. Those events need to be fired by the root element of the webcomponent (or bubbled to the root element). Events from inner elements of the webcomponent that are not bubbled to the outside are not intercepted by the server.

        Returns:

        the name of the DOM event(s) to use for synchronization

      • property

        public abstract String property

        The name of the property to synchronize. By default deduced from the name of the getter.

        Returns:

        the name of the property to synchronize

        Default:

        ""

      • allowUpdates

        public abstract DisabledUpdateMode allowUpdates

        Controls updates for the property from the client side to the server side when the element is disabled.

        Returns:

        the property update mode for disabled element

        Default:

        com.vaadin.flow.dom.DisabledUpdateMode.ONLY_WHEN_ENABLED