Class ecm.widget.LayoutPropertiesPane
Extends
dijit._Widget, ecm.widget._PropertiesPaneMixin.
Provides a widget that is used to display custom property layout views. This widget can be used in dialog
boxes for adding documents, creating folders, and editing properties.
Defined in: <ecm\widget\LayoutPropertiesPane.js>.
Constructor Summary
Constructor Attributes | Constructor Name and Description |
---|---|
Field Summary
Field Attributes | Field Name and Description |
---|---|
Flag for indicating whether object value properties are supported (passed through to the layout editor).
|
|
A string value of the control registry class to be created.
|
|
A string value of the model integration class to be created.
|
Method Summary
Method Attributes | Method Name and Description |
---|---|
Set the error state on the layout viewer widget.
|
|
Clears the current property rendering.
|
|
createIntegrationObject(entryTemplate)
Creates the layout editors Integration object and merges the applications model integration object used at
design time when constructing the entry template.
|
|
createRegistryObject(entryTemplate)
Creates the layout editors Registry object and merges the applications registry information.
|
|
destroy()
|
|
getPropertiesJSON(includeReadonly, includeHidden, excludeEmptyValues)
Retrieves the property values JSON string.
|
|
getPropertyValue(fieldName)
Retrieves the value for the property field identified by
fieldName . |
|
isFieldDisplayed(fieldName)
Returns whether the field widget for the property named
fieldName is displayed (not hidden). |
|
onAttributesRendering(attributeDefinitions)
This event method is called before the attributes are rendered.
|
|
onChange()
This event method is called after a change in the property pane.
|
|
This event method is called after a properties rendering has been cleared.
|
|
This event method is called after the properties have been rendered.
|
|
onPropertyChanged(evt)
This event method is called after a property value is changed.
|
|
renderAttributes(attributeDefinitions, item, reason, isReadOnly, params)
Renders the attributes.
|
|
resize(changeSize)
|
|
setFieldError(fieldName, errorMessage, errorValue)
Assigns an error to a property field.
|
|
setFieldFocus(fieldName)
Places focus in the property field identified by
fieldName , if found. |
|
setPropertyPropertyValue(fieldName, propertyName, value)
Sets the value for a property field's property identified by
fieldName and
propertyName . |
|
setPropertyValue(fieldName, value)
Sets the value for the property field identified by
fieldName . |
|
validateAll(onEditStatus, onSaveStatus, focus)
Checks if the property fields contain valid values.
|
Field Detail
allowObjectProperties
Flag for indicating whether object value properties are supported (passed through to the layout editor).
controlRegistryClass
A string value of the control registry class to be created.
modelIntegrationClass
A string value of the model integration class to be created.
Method Detail
adjustDirtyState()
Set the error state on the layout viewer widget.
clearRendering()
Clears the current property rendering.
{@link pvr.controller.integration.Integration} createIntegrationObject(entryTemplate)
Creates the layout editors Integration object and merges the applications model integration object used at
design time when constructing the entry template.
- Parameters:
- entryTemplate
- ecm.model.EntryTemplate object
- Returns:
- {@link pvr.controller.integration.Integration}
{@link pvr.widget.registry.Registry} createRegistryObject(entryTemplate)
Creates the layout editors Registry object and merges the applications registry information.
- Parameters:
- entryTemplate
- ecm.model.EntryTemplate object
- Returns:
- {@link pvr.widget.registry.Registry}
destroy()
getPropertiesJSON(includeReadonly, includeHidden, excludeEmptyValues)
Retrieves the property values JSON string. See ecm.widget.PropertyEditors
getPropertiesJSON
for more details.
- Parameters:
- includeReadonly
- A boolean value. If
true
, values for read only properties are included. Otherwise read only property values are excluded from the JSON. - includeHidden
- A boolean value. if
true
, values for hidden properties are included. The parameterexcludeEmptyValues
also applies to hidden properties. - excludeEmptyValues
- A boolean value. If
true
, properties with empty values are excluded.
- Returns:
- The JSON string for the current state of the properties.
getPropertyValue(fieldName)
Retrieves the value for the property field identified by
fieldName
.
- Parameters:
- fieldName
- The property Id string.
- Returns:
- The value for the property field.
isFieldDisplayed(fieldName)
Returns whether the field widget for the property named
fieldName
is displayed (not hidden).
- Parameters:
- fieldName
- The string Id of the property.
- Returns:
- True if the field is displayed in the property table.
onAttributesRendering(attributeDefinitions)
This event method is called before the attributes are rendered.
- Parameters:
- attributeDefinitions
onChange()
This event method is called after a change in the property pane.
onClearedRendering()
This event method is called after a properties rendering has been cleared.
onCompleteRendering()
This event method is called after the properties have been rendered.
onPropertyChanged(evt)
This event method is called after a property value is changed. Records that a field was changed and calls the
properties pane
onChange
event method.
- Parameters:
- evt
- An event object.
postCreate()
renderAttributes(attributeDefinitions, item, reason, isReadOnly, params)
Renders the attributes.
- Parameters:
- attributeDefinitions
- An array of ecm.model.AttributeDefinition objects. Provides the definitions for the
attributes in the
item
parameter. - item
- A ecm.model.ContentItem object.
- reason
- The reason for displaying properties. Pass
"create"
when creating a new content item,"checkin"
when checking in a content item,"editProperties"
when editing the properties of a content item, or"multiEditProperties"
when editing the properties of multiple content items. - isReadOnly
- Pass
true
if the entire item is read only. - params
- A object containing additional parameters. (@since 2.0.3)
resize(changeSize)
- Parameters:
- changeSize
setFieldError(fieldName, errorMessage, errorValue)
Assigns an error to a property field.
- Parameters:
- fieldName
- A property Id string.
- errorMessage
- The error message string.
- errorValue
- The invalid value.
setFieldFocus(fieldName)
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:
- fieldName
- The property Id string.
setPropertyPropertyValue(fieldName, propertyName, value)
Sets the value for a property field's property identified by
fieldName
and
propertyName
.
- Parameters:
- fieldName
- The property Id string.
- propertyName
- The property's property name string.
- value
- The new value for the property field.
- Since:
- 2.0.3.6
setPropertyValue(fieldName, value)
Sets the value for the property field identified by
fieldName
.
- Parameters:
- fieldName
- The property Id string.
- value
- The new value for the property field.
validateAll(onEditStatus, onSaveStatus, focus)
Checks if the property fields contain valid values.
- Parameters:
- onEditStatus
- A boolean value. If
true
, item properties are being modified. Only required property fields and property fields that have been modified are checked. - onSaveStatus
- 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. - focus
- Since:
- 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:
- Returns
null
if all checked property fields contain valid values. Otherwise, returns a string indicating that the properties are in an "Error" state.