Module org.praxislive.code
Package org.praxislive.code.userapi

Annotation Interface Ref.Publish

Enclosing class:
Ref<T>
@Retention(RUNTIME) @Target(FIELD) public static @interface Ref.Publish
Annotation to be used on a Ref field on a container, to allow Ref fields of direct child components to subscribe and bind to the values of the published Ref. A name can be set to differentiate between Refs of the same type. If a name is not given, a value representing the type is used.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String
    name
    Name to publish the Ref under.

  • Element Details

    • name

      String name
      Name to publish the Ref under. An empty or blank name means the Ref will be published under a name generated from its type. The default value is an empty String.
      Returns:
      name to publish under
      Default:
      ""