JavaScriptFileHandler

Purpose

Introduces additional JavaScript files.

Note: This interface is only for compatibility with older product versions (FR below 10.0). It only takes effect for report previews (cpt/frm templates, excluding mobile and H5 preview) and has no effect in the Decision Platform. Do not use it in new plugins.

Interface Definition

Main Interface

package com.fr.stable.fun;

public interface JavaScriptFileHandler extends WebFileHandler {

    String XML_TAG = "JavaScriptFileHandler";

    int CURRENT_LEVEL = 1;
}

Related Interface

WebFileHandler (parent interface):

package com.fr.stable.fun;

import com.fr.stable.fun.mark.Mutable;

public interface WebFileHandler extends Mutable {

    String ENCODE_SEPARATOR = "?encode=";

    /**
     * Returns the relative paths of the files needed on the web side
     *
     * @return Collection of file paths
     */
    String[] pathsForFiles();

    String encode();
}

• pathsForFiles(): Returns the relative path of the JS file inside the plugin JAR, e.g. com/demo/js/main.js
• encode(): Has a default implementation; returns the resource encoding method, default value is UTF-8

Registration

In version 10.0, all three registration methods below only take effect for report previews. Files registered under core are loaded earlier, followed by form, then report.

<extra-core>
    <JavaScriptFileHandler class="com.fr.plugin.xxx.youclassname"/>
</extra-core>

<extra-form>
    <JavaScriptFileHandler class="com.fr.plugin.xxx.youclassname"/>
</extra-form>

<extra-report>
    <JavaScriptFileHandler class="com.fr.plugin.xxx.youclassname"/>
</extra-report>

Supported Versions

How It Works

Registration: When the product's server/report/decision-report modules (ServerModule, EngineModule, FormModule) start (module.start()), they read and categorize the JS resources declared in plugins.

Effect: When com.fr.web.ResourceHelper#initDefaultJs and forceInitJSCache run, they read the JS file content pointed to by the plugin interface and inject it into the main JS for report previews (unlike web component interfaces, which load JS as separate independent files).

Example

• Demo: demo-java-script-file-handler
• Related interface: CssFileHandler (comparison of three common plugin interfaces for injecting JS and CSS)

Open-Source Examples

Disclaimer: All open-source examples in the documentation are developed and contributed by community developers, for reference and learning purposes only. Neither the developers nor FineReport are obligated to provide instruction or support for any results from these examples. Commercial use is prohibited; any consequences of commercial use are solely the responsibility of the user.

• open-JSD-8035
• open-JSD-8210