Properties

Methods

Events

Class CQ.wcm.ComponentList

Package:	CQ.wcm
Class:	ComponentList
Extends:	Object
Clientlib:	cq.widgets

The component list holds the list of allowed components for a page and is also used by the container widgets to get their respective components.

Public Properties

Property		Defined By
	ComponentList.MAX_GROUPS : Number <static> The allowed maximum of groups. Exceeding it introduces the virtual group "Other" which contains the co... <static> The allowed maximum of groups. Exceeding it introduces the virtual group "Other" which contains the consolidated list of components from the smallest groups. Defaults to 4 (not including the "Other" group).	ComponentList
	ComponentList.MIN_COMPS : Number <static> The required minimum of components in a group to prevent consolidation in case MAX_GROUPS is exceeded.... <static> The required minimum of components in a group to prevent consolidation in case MAX_GROUPS is exceeded. Groups with fewer components will be consolidated into the "Other" group. Defaults to 3.	ComponentList
	allComponents : Object all components (from page info)	ComponentList
	allowedByCell : Object map of allowed components per cell. (key: cellSearchPath, value: Set of resource types)	ComponentList
	allowedComponents : Object all allowed components. Set of resource types.	ComponentList
	allowedString : String internal string to detect changes in the component list	ComponentList
	path : String Page path	ComponentList

Public Methods

Method		Defined By
	ComponentList( `String path`, `Object components` ) Parameters: `path` : String page path `components` : Object all component descriptors from page info (defaults to MAX_GROUPS). Returns:	ComponentList
	getAllComponents() : Object Returns all available components Returns all available components Parameters: None. Returns: `Object` object of component descriptors	ComponentList
	getAllowedComponents( `CQ.wcm.Cell cell` ) : Object Returns all allowed components. If cell is null, all allowed components are returned. Returns all allowed components. If cell is null, all allowed components are returned. Parameters: `cell` : CQ.wcm.Cell the cell or null Returns: `Object` object of component descriptors	ComponentList
	getComponent( `String resourceType` ) : Object Returns the component descriptor for the given resource type Returns the component descriptor for the given resource type Parameters: `resourceType` : String the resource type Returns: `Object` a component descriptor	ComponentList
	isAllowed( `String resourceType`, `CQ.wcm.Cell cell` ) : Boolean Checks if the component specified by the given resource type is allowed for the given cell. if no cell is specified, ... Checks if the component specified by the given resource type is allowed for the given cell. if no cell is specified, all allowed components are checked. Parameters: `resourceType` : String resource type `cell` : CQ.wcm.Cell optional cell Returns: `Boolean` true if allowed.	ComponentList
	update( `CQ.wcm.Cell cell`, `Array allowed` ) : void update the list for the given cell update the list for the given cell Parameters: `cell` : CQ.wcm.Cell the cell `allowed` : Array array of component resource types or groups. Returns: `void`	ComponentList

Public Events

Event		Defined By
	updatecomponents : ( `CQ.wcm.ComponentList cl` ) Fires after the list of components was updated. Fires after the list of components was updated. Listeners will be called with the following arguments: `cl` : CQ.wcm.ComponentList this component list	ComponentList