react4j.annotations

Annotation Type EventHandler

@Documented
 @Target(value=METHOD)
public @interface EventHandler

Annotation used to specify a callback for a react event handler. This is used to generate a helper method in factory class that wraps the call back and gives it a user friendly name for debugging. This will be optimized away when ReactConfig.enableComponentNames() returns false.

Using this annotation and the corresponding helper method is entirely optional but does provide some value when building components that you want to easily interact with from the React DevTools.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
java.lang.String	name Return the name of the callback.
java.lang.Class	value The type of the callback.

Element Detail

name

@Nonnull
public abstract java.lang.String name

Return the name of the callback. The value defaults to the name of the method. The value must conform to the requirements of a java identifier. It should also be unique across the component 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 event handler.

Default:

"<default>"

value

public abstract java.lang.Class value

The type of the callback. The type should be an interface and the interface should be annotated with JsFunction to ensure that the method can be given a useful debug name.

Returns:

the type of the callback.

Default:

react4j.annotations.EventHandler.Procedure.class