Package react4j.annotations

Annotation Interface View

@Documented @Target(TYPE) @StingProvider("[FlatEnclosingName]React4j_[SimpleName]Factory") public @interface View
Annotation used to identify a React4j view.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static enum 
    View.Type
    Enum indicating type of view.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    boolean
    exportBuilder
    Return true if the generated builder API should be public.
    String
    name
    Return the name of the view.
    View.Type
    type
    Enum indicating the capabilities of the view.

  • Element Details

    • name

      @Nonnull String name
      Return the name of the view. The value defaults to the simple name of the class. If the value is specified, the value must conform to the requirements of a java identifier. It should also be unique across the suite of views used within an application but this is not strictly required as the name is only used for development purposes. (i.e. This is the name that is used within the React DevTools).
      Returns:
      the name of the view.
      Default:
      "<default>"

    • exportBuilder

      boolean exportBuilder
      Return true if the generated builder API should be public. When false, the generated builder API is package access and intended for local use. When true, the generated builder API is public and can be used from other packages while the annotated view type itself remains package access.
      Returns:
      true if the generated builder API should be public.
      Default:
      false

    • type

      @Nonnull View.Type type
      Enum indicating the capabilities of the view. See the View.Type enum for further details.
      Returns:
      an enum indicating the capabilities of the view.
      See Also:
      Default:
      STATEFUL