Component (React4j core binding)

java.lang.Object
- react4j.Component

public abstract class Component
extends java.lang.Object

The base java class that mirrors the react component.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface Component.SetStateCallback
Callback function for updating state.

Nested Classes
Modifier and Type	Class and Description
`static interface`	`Component.SetStateCallback` Callback function for updating state.

Constructor Summary

Constructors
Constructor and Description

Component()

Constructors
Constructor and Description
`Component()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`componentDidCatch(elemental2.core.JsError error, ReactErrorInfo info)` The componentDidCatch() method works like a JavaScript catch {} block, but for components.
`protected void`	`componentDidMount()` This method is invoked after a component is attached to the DOM.
`protected void`	`componentDidUpdate(jsinterop.base.JsPropertyMap<java.lang.Object> prevProps, jsinterop.base.JsPropertyMap<java.lang.Object> prevState)` This method is invoked immediately after updating occurs.
`protected void`	`componentWillUnmount()` This method is invoked immediately before a component is unmounted and destroyed.
`protected java.lang.String`	`getKey()` Return the key associated with the component if any.
`protected void`	`performComponentDidCatch(elemental2.core.JsError error, ReactErrorInfo info)` Wrapper method that delegates to the `componentDidCatch(JsError, ReactErrorInfo)` method.
`protected void`	`performComponentDidMount()` Wrapper method that delegates to the `componentDidMount()` method.
`protected void`	`performComponentDidUpdate(jsinterop.base.JsPropertyMap<java.lang.Object> prevProps, jsinterop.base.JsPropertyMap<java.lang.Object> prevState)` Wrapper method that delegates to the `componentDidUpdate(JsPropertyMap, JsPropertyMap)` method.
`protected void`	`performComponentWillUnmount()` Wrapper method that delegates to the `componentWillUnmount()` method.
`protected void`	`performPostConstruct()` Wrapper method that delegates to the `postConstruct()` method.
`protected ReactNode`	`performRender()` Wrapper method that delegates to the `render()` method.
`protected boolean`	`performShouldComponentUpdate(jsinterop.base.JsPropertyMap<java.lang.Object> nextProps, jsinterop.base.JsPropertyMap<java.lang.Object> nextState)` Wrapper method that delegates to the `shouldComponentUpdate(JsPropertyMap, JsPropertyMap)` method.
`protected void`	`postConstruct()` This method is invoked after the component is constructed and bound to a native react 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(boolean force)` Schedule this component for re-rendering.
`protected void`	`scheduleStateUpdate(Component.SetStateCallback callback)` Schedule a shallow merge of supplied state into current state.
`protected void`	`scheduleStateUpdate(Component.SetStateCallback callback, Procedure onStateUpdateComplete)` Schedule a shallow merge of supplied state into current state.
`protected void`	`scheduleStateUpdate(jsinterop.base.JsPropertyMap<java.lang.Object> state)` Schedule a shallow merge of supplied state into current state.
`protected void`	`scheduleStateUpdate(jsinterop.base.JsPropertyMap<java.lang.Object> state, Procedure onStateUpdateComplete)` Schedule a shallow merge of supplied state into current state.
`protected void`	`setInitialState(jsinterop.base.JsPropertyMap<java.lang.Object> state)` Set the initial state of the component.
`protected boolean`	`shouldComponentUpdate(jsinterop.base.JsPropertyMap<java.lang.Object> nextProps, jsinterop.base.JsPropertyMap<java.lang.Object> nextState)` Use this method to let React know if a component's output is not affected by the current change in state or props.
`protected jsinterop.base.JsPropertyMap<java.lang.Object>`	`state()` Return the component state from 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
  - setInitialState
```
protected final void setInitialState(@Nonnull
                                     jsinterop.base.JsPropertyMap<java.lang.Object> state)
```
    Set the initial state of the component. This should only be invoked when the component is initializing. Calling this at any other time is an error.
    
    Parameters:
    
    state - the state.
  - state
```
protected final jsinterop.base.JsPropertyMap<java.lang.Object> state()
```
    Return the component state from the native component. This may be null if initial state was never set.
    
    Returns:
    
    the component state.
  - 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.
  - getKey
```
@Nullable
protected final java.lang.String getKey()
```
    Return the key associated with the component if any. The key is used by the react reconcilliation process as a means to identify components so that they can be moved rather than recreated or reconfigured. Typically, it should not be used by the component itself except for generating keys of sub-components. This value may not be specified in which case null will be returned.
    
    Returns:
    
    the key if specified.
  - scheduleStateUpdate
```
protected final void scheduleStateUpdate(@Nonnull
                                         jsinterop.base.JsPropertyMap<java.lang.Object> state)
```
    Schedule a shallow merge of supplied state into current state. This will trigger an update cycle and is the primary method you use to trigger UI updates from event handlers and server request callbacks.
    
    Parameters:
    
    state - the object literal representing state.
  - scheduleStateUpdate
```
protected final void scheduleStateUpdate(@Nonnull
                                         jsinterop.base.JsPropertyMap<java.lang.Object> state,
                                         @Nullable
                                         Procedure onStateUpdateComplete)
```
    Schedule a shallow merge of supplied state into current state. This will trigger an update cycle and is the primary method you use to trigger UI updates from event handlers and server request callbacks.
    
    Parameters:
    
    state - the object literal representing state.
    
    onStateUpdateComplete - a callback that will be invoked after state has been updated.
  - scheduleStateUpdate
```
protected final void scheduleStateUpdate(@Nonnull
                                         Component.SetStateCallback callback)
```
    Schedule a shallow merge of supplied state into current state. This will trigger an update cycle and is the primary method you use to trigger UI updates from event handlers and server request callbacks.
    
    Parameters:
    
    callback - the callback that will be invoked to update state.
  - scheduleStateUpdate
```
protected void scheduleStateUpdate(@Nonnull
                                   Component.SetStateCallback callback,
                                   @Nullable
                                   Procedure onStateUpdateComplete)
```
    Schedule a shallow merge of supplied state into current state. This will trigger an update cycle and is the primary method you use to trigger UI updates from event handlers and server request callbacks.
    
    Parameters:
    
    callback - the callback that will be invoked to update state.
    
    onStateUpdateComplete - a callback that will be invoked after state has been updated.
  - scheduleRender
```
protected final void scheduleRender(boolean force)
```
    Schedule this component for re-rendering. The component re-renders when state or props change but calling this method is another way to schedule the component to be re-rendered.
    If the force parameter is true then the shouldComponentUpdate(JsPropertyMap, JsPropertyMap) will be skipped and it is equivalent to calling forceUpdate() on the native react component. See the React Component documentation for more details.
    
    If the force parameter is true then the shouldComponentUpdate(JsPropertyMap, JsPropertyMap) will be invoked. This is equivalent to calling setState({}) on the native react component.
    
    Parameters:
    
    force - true to skip shouldComponentUpdate during re-render, false otherwise.
  - render
```
@Nullable
protected abstract ReactNode render()
```
    Render the component. See the React Component documentation for more details.
    
    Returns:
    
    the result of rendering.
  - performRender
```
@Nullable
protected ReactNode performRender()
```
    Wrapper method that delegates to the render() method. This method exists to give middleware a mechanism to hook into component lifecycle step.
    
    Returns:
    
    the result of rendering.
  - performPostConstruct
```
protected void performPostConstruct()
```
    Wrapper method that delegates to the postConstruct() method. This method exists to give middleware a mechanism to hook into component lifecycle step.
  - postConstruct
```
protected void postConstruct()
```
    This method is invoked after the component is constructed and bound to a native react component. This is a good place to perform initialization. It is called before render(), therefore setting state in this method will not trigger a re-rendering. This replaces the componentWillMount lifecycle method from react as well as the code that appears in constructors in native React ES6 components.
  - componentDidMount
```
protected void componentDidMount()
```
    This method is invoked after a component is attached to the DOM. Initialization that requires DOM nodes should go here. Setting state in this method will trigger a re-rendering. See the React Component documentation for more details.
  - performComponentDidMount
```
protected void performComponentDidMount()
```
    Wrapper method that delegates to the componentDidMount() method. This method exists to give middleware a mechanism to hook into component lifecycle step.
  - componentDidUpdate
```
protected void componentDidUpdate(@Nullable
                                  jsinterop.base.JsPropertyMap<java.lang.Object> prevProps,
                                  @Nullable
                                  jsinterop.base.JsPropertyMap<java.lang.Object> prevState)
```
    This method is invoked immediately after updating occurs. If you need to interact with the DOM after the component has been updated. See the React Component documentation for more details.
    
    Parameters:
    
    prevProps - the props before the component was updated.
    
    prevState - the state before the component was updated.
  - performComponentDidUpdate
```
protected void performComponentDidUpdate(@Nullable
                                         jsinterop.base.JsPropertyMap<java.lang.Object> prevProps,
                                         @Nullable
                                         jsinterop.base.JsPropertyMap<java.lang.Object> prevState)
```
    Wrapper method that delegates to the componentDidUpdate(JsPropertyMap, JsPropertyMap) method. This method exists to give middleware a mechanism to hook into component lifecycle step.
    
    Parameters:
    
    prevProps - the props before the component was updated.
    
    prevState - the state before the component was updated.
  - componentWillUnmount
```
protected void componentWillUnmount()
```
    This method is invoked immediately before a component is unmounted and destroyed. Perform any necessary cleanup in this method, such as invalidating timers, canceling network requests, or cleaning up any DOM elements that were created in componentDidMount() See the React Component documentation for more details.
  - performComponentWillUnmount
```
protected void performComponentWillUnmount()
```
    Wrapper method that delegates to the componentWillUnmount() method. This method exists to give middleware a mechanism to hook into component lifecycle step.
  - componentDidCatch
```
protected void componentDidCatch(@Nonnull
                                 elemental2.core.JsError error,
                                 @Nonnull
                                 ReactErrorInfo info)
```
    The componentDidCatch() method works like a JavaScript catch {} block, but for components. Only class components can be error boundaries. In practice, most of the time you’ll want to declare an error boundary component once and use it throughout your application.
    Note that error boundaries only catch errors in the components below them in the tree. An error boundary can’t catch an error within itself. If an error boundary fails trying to render the error message, the error will propagate to the closest error boundary above it. This, too, is similar to how catch {} block works in JavaScript.
    
    Parameters:
    
    error - the error that has been thrown.
    
    info - information about component stack during thrown error.
  - performComponentDidCatch
```
protected void performComponentDidCatch(@Nonnull
                                        elemental2.core.JsError error,
                                        @Nonnull
                                        ReactErrorInfo info)
```
    Wrapper method that delegates to the componentDidCatch(JsError, ReactErrorInfo) method. This method exists to give middleware a mechanism to hook into component lifecycle step.
    
    Parameters:
    
    error - the error that has been thrown.
    
    info - information about component stack during thrown error.
  - shouldComponentUpdate
```
protected boolean shouldComponentUpdate(@Nullable
                                        jsinterop.base.JsPropertyMap<java.lang.Object> nextProps,
                                        @Nullable
                                        jsinterop.base.JsPropertyMap<java.lang.Object> nextState)
```
    Use this method to let React know if a component's output is not affected by the current change in state or props. The default behavior is to re-render on every state change, and in the vast majority of cases you should rely on the default behavior. See the React Component documentation for more details.
    This method is invoked before rendering when new props or state are being received. This method is not called for the initial render or when scheduleRender(boolean)} is called with the force parameter set to true.
    
    Returning false does not prevent child components from re-rendering when their state changes.
    
    If this method returns false, then render(), and componentDidUpdate(JsPropertyMap, JsPropertyMap) will not be invoked. In the future React may treat this method as a hint rather than a strict directive, and returning false may still result in a re-rendering of the component.
    
    Parameters:
    
    nextProps - the new properties of the component.
    
    nextState - the new state of the component.
    
    Returns:
    
    true if the component should be updated.
  - performShouldComponentUpdate
```
protected boolean performShouldComponentUpdate(@Nullable
                                               jsinterop.base.JsPropertyMap<java.lang.Object> nextProps,
                                               @Nullable
                                               jsinterop.base.JsPropertyMap<java.lang.Object> nextState)
```
    Wrapper method that delegates to the shouldComponentUpdate(JsPropertyMap, JsPropertyMap) method. This method exists to give middleware a mechanism to hook into component lifecycle step.
    
    Parameters:
    
    nextProps - the new properties of the component.
    
    nextState - the new state of the component.
    
    Returns:
    
    true if the component should be updated.

Class Component

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Component

Method Detail

setInitialState

state

props

getKey

scheduleStateUpdate

scheduleStateUpdate

scheduleStateUpdate

scheduleStateUpdate

scheduleRender

render

performRender

performPostConstruct

postConstruct

componentDidMount

performComponentDidMount

componentDidUpdate

performComponentDidUpdate

componentWillUnmount

performComponentWillUnmount

componentDidCatch

performComponentDidCatch

shouldComponentUpdate

performShouldComponentUpdate