Called immediately before mounting occurs, and before Component#render.
Avoid introducing any side-effects or subscriptions in this method.
This method will not stop working in React 17.
Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked.
Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes.
Calling Component#setState generally does not trigger this method.
This method will not stop working in React 17.
Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked.
Called immediately before rendering when new props or state is received. Not called for the initial render.
Note: You cannot call Component#setState here.
This method will not stop working in React 17.
Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked.
Gathers all event parameter values from the state and converts them into a serialisable format in which they can be submitted to the server.
The event params in a serialisable form
Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.
Invoked after the component is first mounted. Creates a key handler which
listens for either ESC or Enter and either closes the modal or launches
the event and then closes the modal correspondingly. Moreover, if there is
a valid table ref, it focuses the input to the first input element of the
underlying table.
Called immediately after updating occurs. Not called for the initial render.
The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.
Called immediately before mounting occurs, and before Component#render.
Avoid introducing any side-effects or subscriptions in this method.
Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked.
Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes.
Calling Component#setState generally does not trigger this method.
Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked.
Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as
cancelled network requests, or cleaning up any DOM elements created in componentDidMount.
Called immediately before rendering when new props or state is received. Not called for the initial render.
Note: You cannot call Component#setState here.
Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked.
Takes a list of event parameters and converts them in such a way that they
can be stored in the state variable. Replaces undefined and null with
the appropriate default value for the parameter type if available.
A list of parameters to convert
Returns the label to be put on the submit button of the modal. The label
depends on the triggerMode, flags in the event itself or possibly the
verb field of the event if it is set.
The label for the submit button
Runs before React applies the result of render to the document, and
returns an object to be given to componentDidUpdate. Useful for saving
things such as scroll position before render causes changes to it.
Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running.
Checks all required param values and makes sure that the user has set a value. Returns true if all required fields were set.
Whether all required fields are set
Callback invoked in response to the user clicking the submit button. Based
on the given triggerMode, a different URL is composed which is then used
to trigger the event with the given params. Invokes the onTriggered
callback with either the argument success or error after the request
has completed.
Renders the component
Takes the parameters contained in state and renders them as a table for
the user to interact with. If the event does not contain any parameters
no table is rendered and the method returns undefined.
The parameters as a table or undefined if there are no parameters
Called to determine whether the change in props and state should trigger a re-render.
Component always returns true.
PureComponent implements a shallow comparison on props and state and returns true if any
props or states have changed.
If false is returned, Component#render, componentWillUpdate
and componentDidUpdate will not be called.
Callback which is invoked when the user interacts with one of the input fields in the table of event parameters. Updates the state with the changed value.
The index of the parameter in the list of event parameters
The original change event that was triggered
Generated using TypeDoc
Renders a
divwhich is intended to be displayed as a modal dialogue displaying the parameters of an event as a table. The user can then adjust the parameters and finally launch the event. Moreover, the component makes sure that all parameters which have therequiredflag set actually have a value before enabling the submit button. The component also installkeyuplisteners which allow for launching the event or cancelling the dialogue using the keyboard.Event for which the params should be rendered
Document ID of the current session
Trigger mode that the application is currently set to
Callback invoked when the user clicks the button to trigger the event