Class ecm.widget.ItemPropertiesDisplayPane
Extends
dijit._Widget.
Provides a widget that displays a read-only view of the properties for an item.
Defined in: <ecm\widget\ItemPropertiesDisplayPane.js>.
Constructor Summary
Constructor Attributes | Constructor Name and Description |
---|---|
Field Summary
Field Attributes | Field Name and Description |
---|---|
Boolean indicating if the edit function is enabled.
|
|
A string value of the CommonPropertiesPane class to be created.
|
|
Boolean indicating if the system properties should be rendered.
|
|
Boolean indicating if the preview should be shown.
|
|
Boolean indicating if the system properties should be shown.
|
Method Summary
Method Attributes | Method Name and Description |
---|---|
addCustomTitlePane(titlePane, propertyPairs)
Adds a new set of properties to the display.
|
|
addPropertiesToTitlePane(titlePane, pairs)
Adds and creates all the properties for the title pane.
|
|
destroy()
Destroys the widget.
|
|
displayNoItemSelected(type)
Displays a text that no items are selected and disables all the title panes.
|
|
getItem()
Returns the item.
|
|
getItemAttributeValue(attributeDefinition)
Returns the formatted value for the input attribute definition.
|
|
Returns boolean to determine if preview pane should be displayed.
|
|
getSystemProperties(attributeDefinitions)
Builds the list of system properties to pass to _createLabelValue to build the system properties grid.
|
|
Returns the array of title panes created.
|
|
isItemPropertyShown(attributeDefinition, item)
Determines whether to show a specific attribute definition for the item.
|
|
isItemReadOnly(item)
Determines whether the current item is read-only.
|
|
isMetadataReadOnly(item)
|
|
This event is fired when the rendering is complete.
|
|
resize(newSize, currentSize)
Resizes the pane.
|
|
setItem(item)
Sets the item for this pane.
|
|
setShowPreview(show)
Sets the show preview.
|
|
Updates the view with the item's data.
|
Field Detail
allowEdit
Boolean indicating if the edit function is enabled.
commonPropertiesPaneClass
A string value of the CommonPropertiesPane class to be created. This allows plugin writers to provide a
custom CommonPropertiesPane widget.
- Since:
- 2.0.2
renderSystemProps
Boolean indicating if the system properties should be rendered. Setting this to false will remove system
properties from the view.
showPreview
Boolean indicating if the preview should be shown.
showSystemProps
Boolean indicating if the system properties should be shown. Setting this to false will collapse the system
properties view, but will not remove them entirely from the view.
Method Detail
addCustomTitlePane(titlePane, propertyPairs)
Adds a new set of properties to the display.
- Parameters:
- titlePane
- propertyPairs
addPropertiesToTitlePane(titlePane, pairs)
Adds and creates all the properties for the title pane.
- Parameters:
- titlePane
- The title pane to add to.
- pairs
- A set of label and value pairs that will be added to the title pane.
- Since:
- 2.0.3
destroy()
Destroys the widget.
displayNoItemSelected(type)
Displays a text that no items are selected and disables all the title panes.
- Parameters:
- type
- String value to pass into
domConstruct.place
. For example,"first"
or"only"
.
getItem()
Returns the item.
- Returns:
- Instance of ecm.model.Item, ecm.model.Favorite, or ecm.model.Teamspace.
getItemAttributeValue(attributeDefinition)
Returns the formatted value for the input attribute definition.
- Parameters:
- attributeDefinition
- Instance of ecm.model.AttributeDefinition.
- Returns:
- The formatted value.
getShowPreview()
Returns boolean to determine if preview pane should be displayed.
- Returns:
- Boolean indicating if the preview should be shown.
getSystemProperties(attributeDefinitions)
Builds the list of system properties to pass to _createLabelValue to build the system properties grid.
- Parameters:
- attributeDefinitions
- The list of attributes for the current item
- Since:
- 3.0.5
- Returns:
- An array of system attributes to display. Each entry is an array containing the attribute label, value, and property id.
getTitlePanes()
Returns the array of title panes created.
- Returns:
- Array of idx.layout.TitlePane.
isItemPropertyShown(attributeDefinition, item)
Determines whether to show a specific attribute definition for the item.
- Parameters:
- attributeDefinition
- Instance of ecm.model.AttributeDefinition.
- item
- The item to be displayed
isItemReadOnly(item)
Determines whether the current item is read-only. The editing capabilities for this properties display pane
will be turned off if true is returned.
- Parameters:
- item
- The item to be displayed
- Since:
- 2.0.2
isMetadataReadOnly(item)
- Parameters:
- item
onCompleteRendering()
This event is fired when the rendering is complete.
postCreate()
resize(newSize, currentSize)
Resizes the pane.
- Parameters:
- newSize
- currentSize
setItem(item)
Sets the item for this pane.
- Parameters:
- item
- Instance of ecm.model.Item, ecm.model.Favorite, or ecm.model.Teamspace.
setShowPreview(show)
Sets the show preview.
- Parameters:
- show
- Boolean indicating if the preview should show.
updateView()
Updates the view with the item's data.