Class ecm.widget.SecurityPane

Extends dijit._Widget.
Provides a widget that contains a list of users and groups that have access to an item. The users and groups are displayed based on their current permission settings.
Defined in: <ecm\widget\SecurityPane.js>.

Constructor Summary

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

Field Summary

Field Attributes	Field Name and Description
	enableDocumentPermissionPropagationOptions Indicates if the security pane should allow users to propagate document permissions from folder level.
	enableFolderPropagationOptions Indicates if the security pane will show permission propagation abilities for folders.
	enableShowPermissionTypeIcons Indicates if the security pane should show icons for the various permission types: Inherited, One Level and All Levels.
	fitToParent Indicates if the security pane should be resized to fit within its parent container.
	showCreatorOwnerAccount Indicates if the security support adding the #CREATOR-OWNER account for P8.

Method Summary

Method Attributes	Method Name and Description
	destroy() Cleans up the widget.
	getPermissions() Returns the current permission array.
	onChange() An event that gets trigger when a permission item has been modified, added, or removed from the permission array.
	postCreate()
	renderPermissions(permissions, parentPermissions, securityPolicy, isDocument, isReadonly, applySecurityPolicy, useReleasedTemplate) Displays the permissions of the current selected item.
	reset() Resets the security pane to its default values.
	resize() Resizes the widget
	setItem(item) Sets the item.
	setMarkingValues(values) Sets the item marking values if markings are current assigned to the selected item.
	setRepository(repository) Sets the repository of the selected item.
	updateParentPermissions(permissions) Updates the item parent permissions and re-render the item permissions with the new updated parent permissions.

Constructor Detail

ecm.widget.SecurityPane()

Field Detail

enableDocumentPermissionPropagationOptions

Indicates if the security pane should allow users to propagate document permissions from folder level. (p8 repository types only)

Since:: 2.0.2

enableFolderPropagationOptions

Indicates if the security pane will show permission propagation abilities for folders. If this option is enabled, the dialog will an additional dropdown to propagate folder permissions when adding a new user or group. The security pane will also allow users to propagate to One Level and All Levels when modifying an existing permissions. (p8 repository types only). If this is enabled, enableShowPermissionTypeIcons will automatically be enabled.

Since:: 2.0.2

enableShowPermissionTypeIcons

Indicates if the security pane should show icons for the various permission types: Inherited, One Level and All Levels. The dialog will also show tabs for One Level and All Levels when modifying the existing permissions. (P8 repository types only)

Since:: 2.0.2

fitToParent

Indicates if the security pane should be resized to fit within its parent container.

showCreatorOwnerAccount

Indicates if the security support adding the #CREATOR-OWNER account for P8. The default is false.

Since:: 2.0.3.1

Method Detail

destroy()

Cleans up the widget.

getPermissions()

Returns the current permission array.

Returns:: Returns an array of ecm.model.Permission

onChange()

An event that gets trigger when a permission item has been modified, added, or removed from the permission array.

postCreate()

renderPermissions(permissions, parentPermissions, securityPolicy, isDocument, isReadonly, applySecurityPolicy, useReleasedTemplate)

Displays the permissions of the current selected item.

Parameters:
permissions: An array of ecm.model.Permission. The array contains the current permissions of the selected item.
parentPermissions: An array of ecm.model.Permission. The array contains the current permissions from the parent folder.
securityPolicy: A ecm.model.SecurityPolicy object that is the current security policy assigned to the item.
isDocument: A boolean value indicating document permissions.
isReadonly: A boolean value indicating if the permissions are shown as read only.
applySecurityPolicy: A boolean value indicating if the security policy permissions should be included in the item permissions.
useReleasedTemplate: A boolean value indicating if we are using the security policy Released Template permissions.

reset()

Resets the security pane to its default values.

resize()

Resizes the widget

setItem(item)

Sets the item.

Parameters:
item: Instance of ecm.model.ContentItem

setMarkingValues(values)

Sets the item marking values if markings are current assigned to the selected item.

Parameters:
values: An array of marking values.

setRepository(repository)

Sets the repository of the selected item.

Parameters:
repository: Instance of ecm.model.Repository

updateParentPermissions(permissions)

Updates the item parent permissions and re-render the item permissions with the new updated parent permissions. The parent permissions could have changed on add document when selecting a different folder.

Parameters:
permissions: An array of ecm.model.Permission. The array contains the current permissions from the parent folder.