Annotation Type BindParameter


  • @Target(FIELD)
    @Retention(RUNTIME)
    @UseWith(MIXIN)
    public @interface BindParameter
    Designates a field in a mixin which is bound to the parameter of the containing component corresponding to the value of the annotation. If no value is specified, the bound parameter name is assumed to match the field name of the mixin. For example, a mixin intended to work with form fields would define a field named "value", marked by this annotation. The user-variable bound to the component's value parameter would ultimately be bound in a chain: user-variable <=> mixin.value <=> component.value. Changes to any one value in the chain will be propagated accordingly.
    Since:
    5.2.0
    See Also:
    BindParameterWorker
    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element Description
      java.lang.String name  
      java.lang.String[] value  
    • Element Detail

      • name

        java.lang.String name
        Returns:
        the name of the mixin bound-parameter, exactly as for the Parameter annotation.
        Default:
        ""
      • value

        java.lang.String[] value
        Returns:
        the name(s) of the parent parameter to bind. Defaults to the name of the mixin field. If more than one name is specified, the first name matching a declared parameter of the core component will be used.
        Default:
        {""}