Class Alfresco.component.ManagePermissions

Manage Permissions component.

Constructor Summary
Constructor Attributes	Constructor Name and Description
	Alfresco.component.ManagePermissions(htmlId) Permissions constructor.

Field Summary
Field Attributes	Field Name and Description
	deferredReady Deferred ready object. Handles deferring component main functions until all async events have been received.
	inheritanceWarning One-time display when switching off inheritance for the first time
	nodeData Initial node metadata as returned from Repository
	permissions Object literal containing current client-state of permissions
	settableRoles Data structure for populating the Roles dropdowns
	settableRolesMenuData Array of roles suitable for building a YUI menu
	showingAuthorityFinder Visibility state of Authority Finder

Fields borrowed from class Alfresco.component.Base:: modules, options, services, widgets

Method Summary
Method Attributes	Method Name and Description
	fnRenderCellActions() Returns actions custom datacell formatter
	fnRenderCellAuthorityIcon() Returns authority icon custom datacell formatter
	fnRenderCellRole() Returns role custom datacell formatter
	fnRenderCellRoleText(elCell, oRecord, oColumn, oData) Returns custom datacell formatter that adds i18n support for role names.
	fnRenderCellText() Returns text custom datacell formatter
	generateData(p_permissions) Data provider function, called from DataSource widgets in response to sendRequest()
	onActionDelete(oRecord) Delete permission
	onAddUserGroupButton(e, args) Event handler for the Add User/Group button.
	onAuthorityFinderLoaded(response) Called when the authority finder template has been loaded.
	onAuthoritySelected(e, args) Authority selected event handler. This event is fired from Authority picker.
	onCancelButton(type, args) Called when user clicks on the cancel button.
	onDeferredReady() Event handler called when both the "nodeDetailsAvailable" and "onPermissionsLoaded" events have been received
	onEventHighlightRow() Custom event handler to highlight row.
	onEventUnhighlightRow() Custom event handler to unhighlight row.
	onInheritedButton(e, p_obj) Toggle inherited permissions flag
	onNodeDetailsAvailable(layer, args) Event handler called when the "nodeDetailsAvailable" event is received
	onPermissionsLoaded(response) Success handler called when the AJAX call to the doclist permissions web script returns successfully
	onReady() 111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111q111111211222222222222221qqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqq````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````
	onRoleChanged(p_oMenuItem, p_index) Role drop-down changed event handler
	onSaveButton(type, args) Called when user clicks on the save button.
	render() Prompt the DataTable widget to re-render

Methods borrowed from class Alfresco.component.Base:: attachLinkClickListeners, bind, createYUIButtons, destroy, fire, invokeAction, msg, onComponentLoaded, onComponentsLoaded, onReadyWrapper, refresh, setMessages, setOptions

Constructor Detail

Alfresco.component.ManagePermissions(htmlId)

Permissions constructor.

Parameters:
{String} htmlId: The HTML id of the parent element

Returns:: {Alfresco.component.ManagePermissions} The new Permissions instance

Field Detail

{object} deferredReady

Deferred ready object. Handles deferring component main functions until all async events have been received.

{boolean} inheritanceWarning

One-time display when switching off inheritance for the first time

{object} nodeData

Initial node metadata as returned from Repository

{object} permissions

Object literal containing current client-state of permissions

{object} settableRoles

Data structure for populating the Roles dropdowns

{object} settableRolesMenuData

Array of roles suitable for building a YUI menu

{boolean} showingAuthorityFinder

Visibility state of Authority Finder

Method Detail

fnRenderCellActions()

Returns actions custom datacell formatter

fnRenderCellAuthorityIcon()

Returns authority icon custom datacell formatter

fnRenderCellRole()

Returns role custom datacell formatter

fnRenderCellRoleText(elCell, oRecord, oColumn, oData)

Returns custom datacell formatter that adds i18n support for role names.

Parameters:
elCell
oRecord
oColumn
oData

fnRenderCellText()

Returns text custom datacell formatter

{Array} generateData(p_permissions)

Data provider function, called from DataSource widgets in response to sendRequest()

Parameters:
{Array} p_permissions: Array of permissions to build dataset for

Returns:: {Array} Data array

onActionDelete(oRecord)

Delete permission

Parameters:
{object} oRecord: Object literal representing permission being actioned

onAddUserGroupButton(e, args)

Event handler for the Add User/Group button.

Parameters:
{object} e: DomEvent
{array} args: Event parameters (depends on event type)

onAuthorityFinderLoaded(response)

Called when the authority finder template has been loaded.
Creates a dialog and inserts the authority finder for choosing groups and users to add.

Parameters:
response: The server response

onAuthoritySelected(e, args)

Authority selected event handler. This event is fired from Authority picker.

Parameters:
e: DomEvent
args: Event parameters (depends on event type)

onCancelButton(type, args)

Called when user clicks on the cancel button.

Parameters:
type
args

onDeferredReady()

Event handler called when both the "nodeDetailsAvailable" and "onPermissionsLoaded" events have been received

onEventHighlightRow()

Custom event handler to highlight row.

Parameters:
oArgs.event: {HTMLEvent} Event object.
oArgs.target: {HTMLElement} Target element.

onEventUnhighlightRow()

Custom event handler to unhighlight row.

Parameters:
oArgs.event: {HTMLEvent} Event object.
oArgs.target: {HTMLElement} Target element.

onInheritedButton(e, p_obj)

Toggle inherited permissions flag

Parameters:
{object} e: DomEvent
{object} p_obj: Object passed back from addListener method

onNodeDetailsAvailable(layer, args)

Event handler called when the "nodeDetailsAvailable" event is received

Parameters:
layer
args

onPermissionsLoaded(response)

Success handler called when the AJAX call to the doclist permissions web script returns successfully

Parameters:
{object} response: Ajax response details

onReady()

111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111q111111211222222222222221qqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqq````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````````
Fired by YUI when parent element is available for scripting.
Component initialisation, including instantiation of YUI widgets and event listener binding.

onRoleChanged(p_oMenuItem, p_index)

Role drop-down changed event handler

Parameters:
{object} p_oMenuItem: Selected menu item
p_index

onSaveButton(type, args)

Called when user clicks on the save button.

Parameters:
type
args

render()

Prompt the DataTable widget to re-render

Classes

Class Alfresco.component.ManagePermissions