Class ecm.widget.AddContentItemPropertiesPane

Extends dijit._Widget.
Provides the edit properties pane that is used in the ecm.widget.dialog.AddContentItemDialog and ecm.widget.dialog.CheckInDialog widgets. This pane is used to select the content class and enter property values.
Defined in: <ecm\widget\AddContentItemPropertiesPane.js>.

Constructor Summary

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

Field Summary

Field Attributes	Field Name and Description
	commonPropertiesPaneClass A string value of the properties pane class to be created.
	showBulkAddOptions Indicates whether to give users the option to apply different property values for each document when adding multiple files.

Method Summary

Method Attributes	Method Name and Description
	afterRenderAttributes() Modifies the displayed properties after calls into the ecm.widget.CommonPropertiesPane `renderProperties` method exit.
	applySourceItem(sourceItem)
	beforeRenderAttributes(attributeDefinitions, item, reason, isReadOnly) Modifies the parameters passed into the ecm.widget.CommonPropertiesPane `renderProperties` method when it is called, before it is entered.
	clearRendering() Clears the current property table rendering.
	createRendering(parentFolder) Renders the add content item properties pane.
	destroy()
	doCleanup() Cleanup the properties pane.
	getBulkAddPropertiesArray() For the bulk-add documents process, returns the array that keep track of the properties for the adding documents.
	getChildComponentValues() Retrieves the child component values.
	getDocumentType() Retrieves the Id of the selected content class.
	getFirstTextPropertyName() Retrieves the name of the first displayed property that contains text values.
	getFolderName() Retrieves the new folder name.
	getItemName() Retrieves the new item name.
	getParentFolder() Returns the parent folder when this properties pane is used to add a new item.
	getPropertiesJSON() This method is used to obtain appropriate object structure for JSON serializing on add and checkin requests.
	getPropertyValue(property) Retrieves the value for a property from the properties pane.
	getTemplateMetadataValues() Retrieves the template meatadata values.
	getTitlePropertyName() Retrieves the name of the document title property based on the repository type and selected class.
	hasProperty(property) Peforms a case insensitive checks to see if an attribute exist in the attribute definition.
	isApplySamePropsToAllDocs() For the bulk-add documents process, return true if the current selection is to apply the same properties to all documents.
	isProcessingDocumentAddStarted() For the bulk-add documents process, return true if the user is partially processing the documents.
	onChange() This event method is called when a displayed property value is changed.
	onCompleteRendering() This event method is called when properties rendering completes.
	onMarkingPropertyChange() This event method is called when a displayed marking property value is changed.
	onParentFolderChanged(parentFolder) This event is triggered when the parent folder for a new item is changed.
	onRenderAttributes()
	onRetrySave() This event is fired when a save operation can be retried.
	postCreate()
	resizeCommonProperties() Resizes the common properties pane.
	setAddContentItemDialog(addContentItemDialog) Stores a reference to the parent dialog widget and connects events.
	setContentClass(contentClass) Assigns a new content class and clears any error message from the previously selected class.
	setDefaultDocumentTitle() This method assigns the file name of the selected content file as the document title value, if the document title is currently empty.
	setExcludedItems(excludedItems) Allows a list of classes to be filtered out of the class selector.
	setFieldError(fieldName, errorMessage, errorValue) Sets an error on the display field for a property.
	setFieldFocus(fieldName) Sets the input focus to the specified property field.
	setFolderUniqueNameEror(msg) Displays the folder name is not unique error when that teamspace validation check fails.
	setParentFolder(parentFolder) Sets the parent folder when this properties pane is used to add a new item.
	setPropertyValue(property, value) Sets the value for a properties pane property.
	setSourceItem(sourceItem)
	setTemplateMetadataFieldError(templateId, fieldName, errorMessage) Assigns an error to the given template metadata field.
	setTemplateMetadataFieldFocus(templateId, fieldName) Places the focus on the given template metadata field.
	showContentContentClasses() For IBM Content Manager repositories, modifies the list of class choices based on whether or not a content file is saved.
	useFileNameForMultiAdd(repository) Tests if the file name should be used as the title when adding multiple documents.
	validate(onEditStatus, onSaveStatus, focus) Tests if the content class is selected and all displayed properties have valid values.

Constructor Detail

ecm.widget.AddContentItemPropertiesPane()

Field Detail

commonPropertiesPaneClass

A string value of the properties pane class to be created.

Since:: 2.0.3

showBulkAddOptions

Indicates whether to give users the option to apply different property values for each document when adding multiple files.

Since:: 3.0.9

Method Detail

afterRenderAttributes()

Modifies the displayed properties after calls into the ecm.widget.CommonPropertiesPane renderProperties method exit.

applySourceItem(sourceItem)

Parameters:
sourceItem

beforeRenderAttributes(attributeDefinitions, item, reason, isReadOnly)

Modifies the parameters passed into the ecm.widget.CommonPropertiesPane renderProperties method when it is called, before it is entered.

Parameters:
attributeDefinitions
item
reason
isReadOnly

clearRendering()

Clears the current property table rendering.

createRendering(parentFolder)

Renders the add content item properties pane.

Parameters:
parentFolder

destroy()

doCleanup()

Cleanup the properties pane.

getBulkAddPropertiesArray()

For the bulk-add documents process, returns the array that keep track of the properties for the adding documents.

Since:: 3.0.9

Returns:: bulkAddPropertiesArray Returns the array that contains properties for each document in the bulk-add documents process. If this array has not been set, null is returned.

getChildComponentValues()

Retrieves the child component values.

Returns:: An array of child component values objects. See the ecm.widget.ChildComponentPropertiesPane getValues method.

getDocumentType()

Retrieves the Id of the selected content class.

Returns:: The selected content class Id string.

getFirstTextPropertyName()

Retrieves the name of the first displayed property that contains text values.

Returns:: The string name (Id, not display name) of the property.

getFolderName()

Retrieves the new folder name.

Deprecated:: Deprecated as of 2.0.3. Replaced by getItemName().

Returns:: The name of the new folder.

getItemName()

Retrieves the new item name.

Since:: 2.0.3

Returns:: The name of the new item.

getParentFolder()

Returns the parent folder when this properties pane is used to add a new item.

Since:: 2.0.3.6

Returns:: parentFolder Returns the parent folder ecm.model.ContentItem object for the new item. The parent folder is set by the container of this properties pane. If no parent folder has been set null is returned.

getPropertiesJSON()

This method is used to obtain appropriate object structure for JSON serializing on add and checkin requests. It should only be used in this way, and no other use of the object structure from this method should be performed as this structure could change.

getPropertyValue(property)

Retrieves the value for a property from the properties pane. Values for hidden properties are retrieved from the attribute definition.

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

Returns:: The property value.

getTemplateMetadataValues()

Retrieves the template meatadata values.

Since:: 3.0

Returns:: An array of child template metadata objects. See the ecm.widget.TemplateMetadataPane getValues method.

getTitlePropertyName()

Retrieves the name of the document title property based on the repository type and selected class.

Returns:: The string name (Id, not display name) of the document title property.

hasProperty(property)

Peforms a case insensitive checks to see if an attribute exist in the attribute definition.

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

Since:: 3.0.1

Returns:: the attribute definition if found.

isApplySamePropsToAllDocs()

For the bulk-add documents process, return true if the current selection is to apply the same properties to all documents. False otherwise.

Since:: 3.0.9

Returns:: true if if the current selection is to apply the same properties to all documents. False otherwise.

isProcessingDocumentAddStarted()

For the bulk-add documents process, return true if the user is partially processing the documents. False otherwise.

Since:: 3.0.9

Returns:: true if the user is partially processing the documents. False otherwise.

onChange()

This event method is called when a displayed property value is changed.

onCompleteRendering()

This event method is called when properties rendering completes.

onMarkingPropertyChange()

This event method is called when a displayed marking property value is changed. (FileNet P8 only)

onParentFolderChanged(parentFolder)

This event is triggered when the parent folder for a new item is changed.

Parameters:
parentFolder: The parent folder ecm.model.ContentItem object for the new item. When provided, the parent folder Id will be included in calls to EDS.

Since:: 2.0.3.6

onRenderAttributes()

onRetrySave()

This event is fired when a save operation can be retried. See ecm.widget.CommonPropertiesPane onRetrySave.

postCreate()

resizeCommonProperties()

Resizes the common properties pane.

setAddContentItemDialog(addContentItemDialog)

Stores a reference to the parent dialog widget and connects events.

Parameters:
addContentItemDialog: The parent dialog widget. A ecm.widget.dialog.AddContentItemDialog or ecm.widget.dialog.CheckInDialog.

setContentClass(contentClass)

Assigns a new content class and clears any error message from the previously selected class.

Parameters:
contentClass

setDefaultDocumentTitle()

This method assigns the file name of the selected content file as the document title value, if the document title is currently empty. (The file name is not assigned to the document title if the repository type is CM and the repository docNamePropSetWithFileName is false.) When multiple documents are added, the file name is assigned at a different point in the add processing.

This is called after properties are rendered in the common properties pane, and before property values are retrieved from the property pane.

Since:: 2.0.2

setExcludedItems(excludedItems)

Allows a list of classes to be filtered out of the class selector. The specified classes will not be shown in the class selector.

Parameters:
excludedItems: An array of class ids to be excluded.

setFieldError(fieldName, errorMessage, errorValue)

Sets an error on the display field for a property. For example, an error that is returned by the server because the new property value is invalid.

Parameters:
fieldName: The string name (Id, not display name) of the property.
errorMessage: The error message string.
errorValue: The new property value that failed.

setFieldFocus(fieldName)

Sets the input focus to the specified property field.

Parameters:
fieldName: The string name (Id, not display name) of the field property.

setFolderUniqueNameEror(msg)

Displays the folder name is not unique error when that teamspace validation check fails.

Parameters:
msg: The error message string to display.

setParentFolder(parentFolder)

Sets the parent folder when this properties pane is used to add a new item.

Parameters:
parentFolder: The parent folder ecm.model.ContentItem object for the new item. When provided, the parent folder Id will be included in calls to EDS.

Since:: 2.0.3.6

{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.

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

setSourceItem(sourceItem)

Parameters:
sourceItem

setTemplateMetadataFieldError(templateId, fieldName, errorMessage)

Assigns an error to the given template metadata field.

Parameters:
templateId: The ID of the template metadata
fieldName: The ID of the field
errorMessage: The error message

Since:: 3.0

setTemplateMetadataFieldFocus(templateId, fieldName)

Places the focus on the given template metadata field.

Parameters:
templateId: The ID of the template metadata
fieldName: The ID of the field

Since:: 3.0

showContentContentClasses()

For IBM Content Manager repositories, modifies the list of class choices based on whether or not a content file is saved.

{Boolean} useFileNameForMultiAdd(repository)

Tests if the file name should be used as the title when adding multiple documents.

Parameters:
repository: A ecm.model.Repository object.

Returns:: {Boolean} A value of true if the file name should be used as the title for each document, otherwise false.

validate(onEditStatus, onSaveStatus, focus)

Tests if the content class is selected and all displayed properties have valid values.

Parameters:
onEditStatus
onSaveStatus
focus

Since:: 2.0.3 A boolean value. If true, item properties are being modified. Only required property fields and property fields that have been modified are checked., 2.0.3 A boolean value. If true, changes are being saved. The first property field widget from the list of property fields with invalid values is returned., 2.0.3.8 A boolean value. If true and there is a field with an invalid value, focus is automatically set to the invalid field.

Returns:: The field object for the invalid value. The value null is returned if all fields are valid.