react4j

Class Component

java.lang.Object

react4j.Component

public abstract class Component
extends java.lang.Object

The base java class that mirrors the react component.

Constructor Summary

Constructors

Constructor and Description
Component()

Method Summary

Modifier and Type	Method and Description
protected void	bindComponent(NativeComponent nativeComponent) Bind the native react component to this component.
protected abstract int	getComponentId() Return the unique identifier of component according to Arez.
protected abstract java.lang.String	getComponentName() Return the name of the component according to Arez.
protected void	populateDebugData(jsinterop.base.JsPropertyMap<java.lang.Object> data) Populate the state parameter with any data that is useful when debugging the component.
protected jsinterop.base.JsPropertyMap<java.lang.Object>	props() Return the component props from the native component.
protected abstract ReactNode	render() Render the component.
protected void	scheduleRender() Schedule this component for re-rendering skipping the shouldComponentUpdate() lifecycle method.
protected void	scheduleRender(boolean force) Schedule this component for re-rendering.
protected void	storeDebugDataAsState() Store debug data on the state object of the native component.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Component

public Component()

Method Detail

bindComponent

protected final void bindComponent(@Nonnull
                                   NativeComponent nativeComponent)

Bind the native react component to this component. This should not be called by user code and is instead invoked by the generated component class.

Parameters:

nativeComponent - the native react component.

props

protected final jsinterop.base.JsPropertyMap<java.lang.Object> props()

Return the component props from the native component. This may be null if no props were supplied.

Returns:

the component state.

scheduleRender

protected final void scheduleRender()

Schedule this component for re-rendering skipping the shouldComponentUpdate() lifecycle method. This is equivalent to calling scheduleRender(boolean) passing a true value.

See Also:

scheduleRender(boolean)

scheduleRender

protected final void scheduleRender(boolean force)

Schedule this component for re-rendering. The component re-renders when props change but calling this method is another way to schedule the component to be re-rendered. When this method is called the shouldComponentUpdate() lifecycle method will be skipped if the force parameter is true as calling this method is equivalent to calling forceUpdate() on the native react component. See the React Component documentation for more details.

Parameters:

force - if true then the component will skip the shouldComponentUpdate() lifecycle method.

render

@Nullable
protected abstract ReactNode render()

Render the component. See the React Component documentation for more details.

Returns:

the result of rendering.

storeDebugDataAsState

@OmitSymbol(unless="react4j.store_debug_data_as_state")
protected final void storeDebugDataAsState()

Store debug data on the state object of the native component. This is only done if React.shouldStoreDebugDataAsState() returns true and is primarily done to make it easy to debug the component from within React DevTools.

getComponentId

@ComponentIdRef
protected abstract int getComponentId()

Return the unique identifier of component according to Arez.

Returns:

the unique identifier of component according to Arez.

getComponentName

@ComponentNameRef
protected abstract java.lang.String getComponentName()

Return the name of the component according to Arez.

Returns:

the name of the component according to Arez.

populateDebugData

@OmitSymbol(unless="react4j.store_debug_data_as_state")
protected void populateDebugData(@Nonnull
                                                                                         jsinterop.base.JsPropertyMap<java.lang.Object> data)

Populate the state parameter with any data that is useful when debugging the component.

Parameters:

data - the property map to populate with debug data.