Package de.xima.fc.e2e.containerplugin.plugin

Class IntegrationTestJavaScriptPlugin

java.lang.Object

de.xima.fc.e2e.containerplugin.plugin.IntegrationTestJavaScriptPlugin

All Implemented Interfaces:

INameProviding, ITransferable, INamedUiElement, IPluginFormResources, IFCPlugin, IFCRemoteSyncPlugin, Serializable

public class IntegrationTestJavaScriptPlugin
extends Object
implements IPluginFormResources

Injects some JavaScript code into all forms with helper functions for testing, such as e.g. reading and asserting the values of select elements.

Author:

XIMA MEDIA GmbH

See Also:

Serialized Form

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

Constructor Summary

Constructors

Constructor	Description
IntegrationTestJavaScriptPlugin()

Method Summary

Modifier and Type	Method	Description
IPluginFormResourceDescriptor	findResourceByFileName(String fileName)	Finds the resource with the given file name among the resources that this plugin provides.
Iterable<? extends IPluginFormResourceDescriptor>	findResources(IPluginFormResourcesFindParams params)	Gets all resources that this plugin wishes to include.
String	getName()	Getter for the name of this plugin.
void	initialize(IPluginInitializeData initializeData)	Callback method that is invoked when this plugin is initialized.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

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

Methods inherited from interface de.xima.fc.plugin.interfaces.form.IPluginFormResources

getResources

Constructor Detail

IntegrationTestJavaScriptPlugin

public IntegrationTestJavaScriptPlugin()

Method Detail

findResourceByFileName

public IPluginFormResourceDescriptor findResourceByFileName(String fileName)

Description copied from interface: IPluginFormResources

Finds the resource with the given file name among the resources that this plugin provides. This method is given one of the file names of the resource descriptors as returned by findResources(). This method should return the resource with the given file name, or null if this plugin does not provide a resource with the given file name.

This method must be able to locate all resources returned by findResources method via their file name. In addition, it may also be able to locate additional files that are not returned by that method. This is helpful, for example, when you wish to provide e.g. a CSS file that references another file (such as an image, a font, or another CSS file).

Specified by:

findResourceByFileName in interface IPluginFormResources

Parameters:

fileName - The file name of the resource to find.

Returns:

The resource with the given file name, or null if not found.

findResources

public Iterable<? extends IPluginFormResourceDescriptor> findResources(IPluginFormResourcesFindParams params)

Description copied from interface: IPluginFormResources

Gets all resources that this plugin wishes to include. All resources returned by this method are included automatically, depending on descriptor.isIncludeInForm() and descriptor.isIncludeInTemplate(). The method findResourceByFileName must be able to locate all resources returned by this method via their file name. In addition, it may also be able to locate additional files that are not returned by this method. This is helpful, for example, when you wish to provide e.g. a CSS file that references another file (such as an image, a font, or another CSS file).

This method is given a set of parameters, the resources should depend only on these parameters, as the resources may get cached.

This method should never return null. The default implementation returns null for backward compatibility: getResources() will be called if this method returns null.

Specified by:

findResources in interface IPluginFormResources

Parameters:

params - Parameters for obtaining the resources.

Returns:

All resources that this plugin wishes to provide.

getName

public String getName()

Description copied from interface: IFCPlugin

Getter for the name of this plugin. This is a technical name that should not appear on the user interface. Implement IFCPlugin.getDisplayName(Locale) for the name that should be shown to the user.

Specified by:

getName in interface IFCPlugin

Specified by:

getName in interface INameProviding

Returns:

String The name of this plugin.

initialize

public void initialize(IPluginInitializeData initializeData)
                throws FCPluginException

Description copied from interface: IFCPlugin

Callback method that is invoked when this plugin is initialized.

Specified by:

initialize in interface IFCPlugin

Parameters:

initializeData - IPluginInitializeData

Throws:

FCPluginException - May be thrown when an error occurred during the initialization process. When an error is thrown, this plugin will be deactivated and not put into service.