Properties

Methods

Events

Config Options

Direct Link

Action
  PrivilegedAction

Class CQ.PrivilegedAction

Package:	CQ
Class:	PrivilegedAction
Extends:	CQ.Ext.Action
Clientlib:	cq.widgets

The PrivilegedAction is an Action which is enabled or disabled based on the privileges granted to the current user. The action will remain disabled as long as there are non-granted privileges configured. If the configuration contains no privileges at all, the action will be active.

For convenience reasons, application privileges and repository privileges are treated equally and can be configured within the same array of privileges.

Config Options

Config Options		Defined By
	conditions : String/Array The additional condition(s) required to enable this action. A condition is a function that returns true if the condit... The additional condition(s) required to enable this action. A condition is a function that returns true if the condition check is successful. Conditions will be executed in the scope of the action. `var condition = function() { var info = CQ.HTTP.eval(this.path + ".json"); if ( info ) { var type = info["jcr:primaryType"]; if (type && ((type == "nt:folder") \|\| (type == "sling:Folder") \|\| (type == "nt:unstructured"))) { return true; } } return false;`	PrivilegedAction
	disabled : Boolean True to disable all components using this action, false to enable them (defaults to false).	Action
	handler : Function The function that will be invoked by each component tied to this action when the component's primary event is trigger... The function that will be invoked by each component tied to this action when the component's primary event is triggered (defaults to undefined).	Action
	hidden : Boolean True to hide all components using this action, false to show them (defaults to false).	Action
	iconCls : String The CSS class selector that specifies a background image to be used as the header icon for all components using this ... The CSS class selector that specifies a background image to be used as the header icon for all components using this action (defaults to ''). An example of specifying a custom icon class would be something like: `// specify the property in the config for the class: ... iconCls: 'do-something' // css class that specifies background image to be used as the icon image: .do-something { background-image: url(../images/my-icon.gif) 0 6px no-repeat !important; }`	Action
	itemId : String See CQ.Ext.Component.itemId. See CQ.Ext.Component.itemId.	Action
	path : String (optional) The path used to test privileges and conditions for this action (defaults to '/').	PrivilegedAction
	privileges : String/Array The privilege(s) required to be granted in order to execute this action.	PrivilegedAction
	text : String The text to set for all components using this action (defaults to '').	Action

Public Properties

This class has no public properties.

Public Methods

Method		Defined By
	PrivilegedAction( `Object config` ) Creates a new PrivilegedAction. Creates a new PrivilegedAction. Parameters: `config` : Object The config object Returns:	PrivilegedAction
	constructor() : void Parameters: None. Returns: `void`	Action
	disable() : void Disables all components using this action. Disables all components using this action. Parameters: None. Returns: `void`	Action
	each( `Function fn`, `Object scope` ) : void Executes the specified function once for each Component currently tied to this action. The function passed in should... Executes the specified function once for each Component currently tied to this action. The function passed in should accept a single argument that will be an object that supports the basic Action config/method interface. Parameters: `fn` : Function The function to execute for each component `scope` : Object The scope (`this` reference) in which the function is executed. Defaults to the Component. Returns: `void`	Action
	enable() : void Enables all components using this action. Enables all components using this action. Parameters: None. Returns: `void`	Action
	execute( [`Mixed arg1`], [`Mixed arg2`], [`Mixed etc...`] ) : void Executes this action manually using the handler function specified in the original config object or the handler funct... Executes this action manually using the handler function specified in the original config object or the handler function set with `setHandler`. Any arguments passed to this function will be passed on to the handler function. Parameters: `arg1` : Mixed (optional) Variable number of arguments passed to the handler function `arg2` : Mixed (optional) `etc...` : Mixed (optional) Returns: `void`	Action
	getIconClass() : void Gets the icon CSS class currently used by all components using this action. Gets the icon CSS class currently used by all components using this action. Parameters: None. Returns: `void`	Action
	getText() : void Gets the text currently displayed by all components using this action. Gets the text currently displayed by all components using this action. Parameters: None. Returns: `void`	Action
	hide() : void Hides all components using this action. Hides all components using this action. Parameters: None. Returns: `void`	Action
	isDisabled() : void Returns true if the components using this action are currently disabled, else returns false. Returns true if the components using this action are currently disabled, else returns false. Parameters: None. Returns: `void`	Action
	isHidden() : void Returns true if the components using this action are currently hidden, else returns false. Returns true if the components using this action are currently hidden, else returns false. Parameters: None. Returns: `void`	Action
	setDisabled( `Boolean disabled` ) : void Sets the disabled state of all components using this action. Shortcut method for enable and disable. Sets the disabled state of all components using this action. Shortcut method for enable and disable. Parameters: `disabled` : Boolean True to disable the component, false to enable it Returns: `void`	Action
	setHandler( `Function fn`, `Object scope` ) : void Sets the function that will be called by each Component using this action when its primary event is triggered. Sets the function that will be called by each Component using this action when its primary event is triggered. Parameters: `fn` : Function The function that will be invoked by the action's components. The function will be called with no arguments. `scope` : Object The scope (`this` reference) in which the function is executed. Defaults to the Component firing the event. Returns: `void`	Action
	setHidden( `Boolean hidden` ) : void Sets the hidden state of all components using this action. Shortcut method for `hide` and `show`. Sets the hidden state of all components using this action. Shortcut method for `hide` and `show`. Parameters: `hidden` : Boolean True to hide the component, false to show it Returns: `void`	Action
	setIconClass( `String cls` ) : void Sets the icon CSS class for all components using this action. The class should supply a background image that will b... Sets the icon CSS class for all components using this action. The class should supply a background image that will be used as the icon image. Parameters: `cls` : String The CSS class supplying the icon image Returns: `void`	Action
	setPath( `String path`, [`Boolean forceCheck`] ) : void Sets the path used to test privileges and conditions for this action. In case the path changed (or forceCheck is true... Sets the path used to test privileges and conditions for this action. In case the path changed (or forceCheck is true), the permissions will be reevaluated. Parameters: `path` : String The path `forceCheck` : Boolean (optional) True to force permission check (default is false) Returns: `void`	PrivilegedAction
	setText( `String text` ) : void Sets the text to be displayed by all components using this action. Sets the text to be displayed by all components using this action. Parameters: `text` : String The text to display Returns: `void`	Action
	show() : void Shows all components using this action. Shows all components using this action. Parameters: None. Returns: `void`	Action

Public Events

This class has no public events.