Package de.xima.fc.plugin.interfaces.template

Interface IPluginHtmlTemplateRenderCallback

  • All Superinterfaces:
    IFCPlugin, INamedUiElement, INameProviding, ITransferable, Serializable
    public interface IPluginHtmlTemplateRenderCallback
extends IFCPlugin
    Plugins that allows the HTML template render process to be customized. Consists of a set of callbacks that are invoked at certain stages of the template render lifecycle. More callback methods may be added later as required.

    Can be used, for example, to append dynamic script data to templates. For static script and stylesheet resources, use IPluginFormResources with includeInTemplate, so resources can be linked and cached properly.

    Since:
    8.3.7
    Author:
    XIMA MEDIA GmbH

    • Method Detail

      • createCallbacks

        Iterable<? extends IHtmlTemplateRenderPluginCallback> createCallbacks()
        Gets a list of callbacks to invoke when an HTML template is rendered.

        This method is invoked once each time a template is rendered. If you need to share any state between several callback methods, you can create a new callback instance each time. Implementations must not be thread-safe,they are used only on a single thread during a single form render operation. (But if you reuse the same instance, you must ensure thread safety.)

        Returns:
        A list of callbacks to invoke when an HTML template is rendered.
        Throws:
        RuntimeException - Any exceptions are caught, logged, and ignored otherwise.