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 |
---|---|
Field Summary
Field Attributes | Field Name and Description |
---|---|
A string value of the properties pane class to be created.
|
Method Summary
Method Attributes | Method Name and Description |
---|---|
Modifies the displayed properties after calls into the ecm.widget.CommonPropertiesPane
renderProperties method exit. |
|
beforeRenderAttributes(attributeDefinitions, item, reason, isReadOnly)
Modifies the parameters passed into the ecm.widget.CommonPropertiesPane
renderProperties
method when it is called, before it is entered. |
|
Clears the current property table rendering.
|
|
createRendering(parentFolder)
Renders the add content item properties pane.
|
|
destroy()
|
|
Cleanup the properties pane.
|
|
Retrieves the child component values.
|
|
Retrieves the Id of the selected content class.
|
|
Retrieves the name of the first displayed property that contains text values.
|
|
Retrieves the new folder name.
|
|
Retrieves the new item name.
|
|
Returns the parent folder when this properties pane is used to add a new item.
|
|
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.
|
|
Retrieves the name of the document title property based on the repository type and selected class.
|
|
onChange()
This event method is called when a displayed property value is changed.
|
|
This event method is called when properties rendering completes.
|
|
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.
|
|
This event is fired when a save operation can be retried.
|
|
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.
|
|
This method assigns the file name of the selected content file as the document title value, if the document
title is currently empty.
|
|
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.
|
|
Displays the
folder name is not uniqueerror 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.
|
|
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.
|
Field Detail
commonPropertiesPaneClass
A string value of the properties pane class to be created.
- Since:
- 2.0.3
Method Detail
afterRenderAttributes()
Modifies the displayed properties after calls into the ecm.widget.CommonPropertiesPane
renderProperties
method exit.
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.
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.
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.
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
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.
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
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 uniqueerror 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, otherwisefalse
.
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, otherwisefalse
.
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. Iftrue
, 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. Iftrue
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.