Package de.xima.fc.plugin.form

Interface IFormRenderPluginCallback

public interface IFormRenderPluginCallback

Callback that allows the form render process to be customized. Consists of a set of callbacks that are invoked at certain stages of the form render lifecycle. More callback methods may be added later as required.

Can be used, for example, to modify rendered form elements, such as in combination with a IPluginFormElementPropertiesExtension in order to render custom properties added to built-in elements.

Since:

8.1.0

Author:

XIMA MEDIA GmbH

Method Summary

Modifier and Type	Method	Description
default IPluginFormRenderCallbackOnAfterRenderFormRetVal	onAfterRenderForm(IPluginFormRenderCallbackOnAfterRenderFormParams params)	Invoked at the end, after a form was rendered.
default IPluginFormRenderCallbackOnAfterRenderItemRetVal	onAfterRenderItem(IPluginFormRenderCallbackOnAfterRenderItemParams params)	Invoked once for each item, after an item was rendered by the item renderer.
default IPluginFormRenderCallbackOnBeforeRenderFormRetVal	onBeforeRenderForm(IPluginFormRenderCallbackOnBeforeRenderFormParams params)	Invoked at the beginning, before a form is about to be rendered.
default IPluginFormRenderCallbackOnBeforeRenderItemRetVal	onBeforeRenderItem(IPluginFormRenderCallbackOnBeforeRenderItemParams params)	Invoked once for each item, before an item is about to be rendered by the item renderer.

Method Detail

onAfterRenderForm

default IPluginFormRenderCallbackOnAfterRenderFormRetVal onAfterRenderForm(IPluginFormRenderCallbackOnAfterRenderFormParams params)

Invoked at the end, after a form was rendered.

Parameters:

params - Parameters for the callback.

Returns:

Return value of the callback. May be null.

Throws:

RuntimeException - Any exceptions are caught, logged, and ignored otherwise.

onAfterRenderItem

default IPluginFormRenderCallbackOnAfterRenderItemRetVal onAfterRenderItem(IPluginFormRenderCallbackOnAfterRenderItemParams params)

Invoked once for each item, after an item was rendered by the item renderer.

Parameters:

params - Parameters for the callback.

Returns:

Return value of the callback. May be null.

Throws:

RuntimeException - Any exceptions are caught, logged, and ignored otherwise.

onBeforeRenderForm

default IPluginFormRenderCallbackOnBeforeRenderFormRetVal onBeforeRenderForm(IPluginFormRenderCallbackOnBeforeRenderFormParams params)

Invoked at the beginning, before a form is about to be rendered.

Parameters:

params - Parameters for the callback.

Returns:

Return value of the callback. May be null.

Throws:

RuntimeException - Any exceptions are caught, logged, and ignored otherwise.

onBeforeRenderItem

default IPluginFormRenderCallbackOnBeforeRenderItemRetVal onBeforeRenderItem(IPluginFormRenderCallbackOnBeforeRenderItemParams params)

Invoked once for each item, before an item is about to be rendered by the item renderer.

Parameters:

params - Parameters for the callback.

Returns:

Return value of the callback. May be null.

Throws:

RuntimeException - Any exceptions are caught, logged, and ignored otherwise.