Class ecm.widget.admin.CustomSettings

General purpose widget for defining one or more custom settings.
Defined in: <ecm\widget\admin\CustomSettings.js>.

Constructor Summary

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

Method Summary

Method Attributes	Method Name and Description
	clearCustomSettings()
	getCustomSettingsJSON() By default returns a JSON Array in the format: [{"name":"name1","value":"value1"},{"name":"name2","value":"value2"},.
	getData(data, item) This method is called when the edit dialog for this list is about to be opened.
	layout()
	onMarkDirty()
	postCreate()
	resize()
	saveData(item, saveData) This method is called when data is being saved from the dialog, back into the grid.
	setCustomSettingsJSON(settingsJSON) Accepts JSON Array in the format: [{"name":"name1","value":"value1"},{"name":"name2","value":"value2"},.
	startup()

Constructor Detail

ecm.widget.admin.CustomSettings()

Method Detail

clearCustomSettings()

getCustomSettingsJSON()

By default returns a JSON Array in the format: [{"name":"name1","value":"value1"},{"name":"name2","value":"value2"},...] Optionally returns a JSON Object in the format: {"name1":"value1", "name2:value2",...} When setCustomSettingsJSON is called initially with a JSON Object, either empty or not.

getData(data, item)

This method is called when the edit dialog for this list is about to be opened. Copy any custom properties from the stored item to the data object, to be edited in the dialog. The data object will already contain the name and value properties from the item.

Parameters:
data
item

Since:: 2.0.3.8

layout()

onMarkDirty()

postCreate()

resize()

saveData(item, saveData)

This method is called when data is being saved from the dialog, back into the grid. Copy any custom properties from the saved data, to be saved in the item. The item passed in will already have id, name and value populated. The saveData object will contain all of the additional data saved from the dialog.

Parameters:
item
saveData

Since:: 2.0.3.8

setCustomSettingsJSON(settingsJSON)

Accepts JSON Array in the format: [{"name":"name1","value":"value1"},{"name":"name2","value":"value2"},...] Or accepts JSON object in the format: {"name1":"value1", "name2:value2",...} An empty array or object can be set to initialize the mode for return JSON from getCustomSettingsJSON

Parameters:
settingsJSON

Classes