Interface IPluginFormTheme

All Superinterfaces:
IFCPlugin, INamedUiElement, INameProviding, ITransferable, Serializable
public interface IPluginFormTheme extends IFCPlugin
A plugin that lets you provide additional IFormTheme. Each form can have a different theme, users can select the desired theme in the form designer. A form theme controls the layout and design of a form. Usually, a form theme adds additional CSS files, but may also add JavaScript files that are needed for styling. In addition, form themes may also provide other resources such as images or fonts that can be used by CSS (and JavaScript) files.
Since:
8.3.0
Author:
XIMA MEDIA GmbH

  • Method Details

    • findFormThemes

      IPluginFormThemeRetVal findFormThemes(IPluginFormThemeParams params)
      Locates all available form themes for the given parameters that the plugin wishes to provide.

      Note: No caching is applied to this method. If the plugin considers it wise to cache the result, it must do so itself.

      See also de.xima.fc.logic.form_theme.StaticFormTheme for an implementation of IFormTheme that is useful when all available files are known at compile time (as opposed to generated statically at runtime).

      Parameters:
      params - Parameters upon which the available form themes may depend.
      Returns:
      A list of form themes that are available to the given client.
      Throws:
      RuntimeException - Implementations should never throw an exception. If they do, this is treated as if no themes had been returned.