Class ecm.widget.TemplateMetadataPane

Extends dijit._Widget.
Provides a widget that is used to view metadata of a box item.
Defined in: <ecm\widget\TemplateMetadataPane.js>.

Constructor Summary

Constructor Attributes	Constructor Name and Description
	ecm.widget.TemplateMetadataPane()

Field Summary

Field Attributes	Field Name and Description
	reason The reason for displaying the template metadata.

Method Summary

Method Attributes	Method Name and Description
	deleteTemplate(evt)
	destroy() Destroys the widget.
	getFirstInvalidField() Returns the first invalid field.
	getValues() Returns an array containing objects with index and values.
	onChange() This event is fired when the field is changed.
	onDeleteTemplate(templateMetadata)
	postCreate()
	renderData() Renders the data.
	setFieldFocus(field) Places focus in the property field identified by `fieldName`, if found.
	setPropertyValue(property, value) Sets the value for a properties pane property.
	validate(onEditStatus, onSaveStatus) Validates the data.

Constructor Detail

ecm.widget.TemplateMetadataPane()

Field Detail

reason

The reason for displaying the template metadata. Possible values are:

"create" - when creating a new content item
"checkin" - when checking in a content item
"editProperties" - when editing the properties of a content item

Since:: 3.0

Method Detail

deleteTemplate(evt)

Parameters:
evt

destroy()

Destroys the widget.

Since:: 3.0

getFirstInvalidField()

Returns the first invalid field.

Returns:: The first field widget that contains an invalid value. If all values are valid, null is returned.

getValues()

Returns an array containing objects with index and values.

Returns:

An array of value objects with the following properties:

name - The property Id string.
value - The property value.
dataType - A ecm.model.AttributeDefinition dataType value.
label - The property display name.

onChange()

This event is fired when the field is changed.

Since:: 3.0

onDeleteTemplate(templateMetadata)

Parameters:
templateMetadata

postCreate()

renderData()

Renders the data.

setFieldFocus(field)

Places focus in the property field identified by fieldName, if found. This is typically used to set the focus on a field that has an invalid value.

Parameters:
field: The field

Since:: 3.0.1

{Boolean} setPropertyValue(property, value)

Sets the value for a properties pane property.

Parameters:
property: The string name (Id, not display name) of the property.
value: The value to assign to the property.

Since:: 3.0.1

Returns:: {Boolean} A value of true if the specified property is found, otherwise false.

validate(onEditStatus, onSaveStatus)

Validates the data.

Parameters:
onEditStatus
onSaveStatus

Returns:: A field widget that contains an invalid value. If all fields contain valid values, null is returned.