Class ecm.widget.admin.PluginConfigurationPane

Provides a base class that can be extended to create a configuration interface for a plug-in.
Defined in: <ecm\widget\admin\PluginConfigurationPane.js>.

Constructor Summary

Constructor Attributes	Constructor Name and Description
	ecm.widget.admin.PluginConfigurationPane()

Field Summary

Field Attributes	Field Name and Description
	configurationString Parameter to save the custom configuration.

Method Summary

Method Attributes	Method Name and Description
	load(onComplete) Called by administration to load the configuration settings into the interface.
	onSaveNeeded(saveNeeded) An event to indicate when the settings displayed in the configuration pane have changed such that they need to be saved.
	save(onComplete) Called by administration to save the configuration settings displayed by this interface.
	validate() Called by administration to validate the current values in the plug-in configuration interface.

Constructor Detail

ecm.widget.admin.PluginConfigurationPane()

Field Detail

configurationString

Parameter to save the custom configuration.

Method Detail

load(onComplete)

Called by administration to load the configuration settings into the interface. Plug-in writers should override this method to load the settings for the plug-in's configuration into the configuration interface. This might also be called by administration to reset the settings displayed in the configuration interface.

Parameters:
onComplete: A function to be invoked when the load completes.

onSaveNeeded(saveNeeded)

An event to indicate when the settings displayed in the configuration pane have changed such that they need to be saved. This event is listened to by the administration to determine when to enable the save button.

Parameters:
saveNeeded: A boolean, true if save is needed, and false if not.

save(onComplete)

Called by administration to save the configuration settings displayed by this interface. Plug-in writers should override this method to save the settings for the plug-in's configuration interface into the configuration database.

Parameters:
onComplete: A function to be invoked when the load completes.

validate()

Called by administration to validate the current values in the plug-in configuration interface. Plug-in writers should override this method, returning false if any values are not valid, and also focus on the field and indicate the invalid field.