Package com.vaadin.flow.component

Annotation Interface Synchronize

@Documented @Retention(RUNTIME) @Target(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
    Description
    String[]
    value
    The DOM event(s) to use for synchronization.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    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 Details

    • value

      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

      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

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

      When multiple update mode settings are defined for the same property, the most permissive mode is used. This means that there might be unexpected updates for a disabled component if multiple parties independently configure different aspects for the same component. This is based on the assumption that if a property is explicitly safe to update for disabled components in one context, then the nature of that property is probably such that it's also safe to update in other contexts.

      Returns:
      the property update mode for disabled element
      Default:
      ONLY_WHEN_ENABLED