Package react4j.annotations

Annotation Interface ScheduleRender

@Documented @Target(METHOD) public @interface ScheduleRender
Identify a method that can be invoked to schedule the view for re-rendering. This annotation is rarely required as the underlying arez reactivity infrastructure should be used in preference to this method. The method primarily exists for backwards compatibility with earlier versions of the framework.

The method must also conform to the following constraints:

  • Must not be annotated with any other react4j annotation
  • Must be abstract
  • Must have 0 parameters
  • Must not return a value
  • Must not be static
  • Must not throw exceptions
  • Must be accessible from the same package as the class annotated by View
  • Should not be public as not expected to be invoked outside the view. A warning will be generated but can be suppressed by the SuppressWarnings or SuppressReact4jWarnings annotations with a key "React4j:PublicMethod". This warning is also suppressed by the annotation processor if it is implementing an interface method.
  • Should not be protected if enclosed in the class annotated with the View annotation as the method is not expected to be invoked outside the view. A warning will be generated but can be suppressed by the SuppressWarnings or SuppressReact4jWarnings annotations with a key "React4j:ProtectedMethod".

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    boolean
    skipShouldViewUpdate
    Determines whether the view will invoke the shouldComponentUpdate() before invoking the render method.

  • Element Details

    • skipShouldViewUpdate

      boolean skipShouldViewUpdate
      Determines whether the view will invoke the shouldComponentUpdate() before invoking the render method.
      Returns:
      true to skip "shouldViewUpdate" phase, false otherwise.
      Default:
      true