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

Interface IPluginFormResource

All Superinterfaces:

IFCPlugin, INamedUiElement, INameProviding, ITransferable, Serializable

public interface IPluginFormResource
extends IFCPlugin

Interface for plugins to integrate form resources like CSS or JavaScript

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
default byte[]	getResourceData()	Deprecated. Use / implement getResourceData(IPluginFormResourceGetDataParams).
default byte[]	getResourceData(IPluginFormResourceGetDataParams params)
String	getResourceName()
default EFormResourceType	getResourceType()
default EFormResourceType	getRespourceType()	Deprecated. Use getResourceType().
default EPluginFormResourceType	getType()	Deprecated. Implement getRespourceType() instead

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

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

Method Details

getType

@Deprecated
default EPluginFormResourceType getType()

Deprecated.

Implement getRespourceType() instead

Returns:

The EFormResourceType, i.e. whether the resource is a JavaScript or CSS file.

getResourceType

default EFormResourceType getResourceType()

Returns:

The EFormResourceType, i.e. whether the resource is a JavaScript or CSS file.

getRespourceType

@Deprecated
default EFormResourceType getRespourceType()

Deprecated.

Use getResourceType().

Returns:

The EFormResourceType, i.e. whether the resource is a JavaScript or CSS file.

getResourceName

String getResourceName()

Returns:

The name of the form resource, with the correct file extension that corresponds to getRespourceType().

getResourceData

@Deprecated
default byte[] getResourceData()

Deprecated.

Use / implement getResourceData(IPluginFormResourceGetDataParams).

Returns:

The binary data of the form resource.

getResourceData

default byte[] getResourceData(IPluginFormResourceGetDataParams params)

Parameters:

params - Parameters that can be used by this method, such as whether the form is rendered inline.

Returns:

The binary data of the form resource.