Package de.xima.fc.plugin.interfaces.form

Interface IPluginFormPropertiesExtension

All Superinterfaces:

IFCPlugin, INamedUiElement, INameProviding, ITransferable, Serializable

public interface IPluginFormPropertiesExtension
extends IFCPlugin

A plugin that lets you add additional properties to forms, which can be configured in the form designer via the forms tab in the properties panel on the right-hand side.

This plugin takes care of the server side. You should also create a IPluginFormDesignerResource to include a JavaScript resource in the form designer which adds the property editors for the new custom properties. Use e.g. the functions registerCustomFormProperty and registerCustomFormCategory provided by the client-side JavaScript API (NPM module @de-xima/fc-form-designer).

See also IPluginFormRenderCallback, which lets you adjust how a form is rendered. You can use that plugin, for example, to add additional data attributes based on the custom properties.

To access form properties that were configured in the designer on the server, use FormVersion.getFormProperties(), IXForm.getFormProperties(), as well as IXFormRenderConfig.getXFormProperties() (and also see IXFormRenderConfig.getXFormPropertyI18n(String)

Since:

8.2.0

Author:

XIMA MEDIA GmbH

Field Summary

Fields inherited from interface de.xima.fc.plugin.interfaces.IFCPlugin

CONFIG_FILENAME

Fields inherited from interface de.xima.fc.interfaces.INamedUiElement

ATTR_DISPLAY_NAME

Fields inherited from interface de.xima.fc.entities.interfaces.INameProviding

ATTR_NAME, COL_NAME

Method Summary

Modifier and Type	Method	Description
IPluginFormPropertiesExtensionRetVal	extendFormProperties(IPluginFormPropertiesExtensionParams params)	Extends form properties, by creating additional properties for the form.

Methods inherited from interface de.xima.fc.plugin.interfaces.IFCPlugin

getDescription, getDescription, getDisplayName, getName, initialize, initPlugin, install, shutdown, shutdown, uninstall, validateConfigurationData

Method Detail

extendFormProperties

IPluginFormPropertiesExtensionRetVal extendFormProperties(IPluginFormPropertiesExtensionParams params)

Extends form properties, by creating additional properties for the form.

Note: Caching the properties returned by this method is not required. Just make sure this method is pure and only depends on the given parameters.

Parameters:

params - Parameters with the locale.

Returns:

Result of the extension with additional properties to add to forms.