Class CQ_Analytics.ClientContextUI

Package:	CQ_Analytics
Class:	ClientContextUI
Extends:	Object
Clientlib:	personalization.clientcontext

Public Properties

Property		Defined By
	ClientContextUI.ACTIONS_CONTAINER_ID : Object <static> UI default actions container id	ClientContextUI
	ClientContextUI.ACTIONS_ID : Object <static> UI default actions header id	ClientContextUI
	ClientContextUI.BOX_CLASS : Object <static> UI default class	ClientContextUI
	ClientContextUI.BOX_ID : Object <static> UI default box id	ClientContextUI
	ClientContextUI.CONTAINER_ID : Object <static> UI default container id	ClientContextUI
	ClientContextUI.CONTENT_ID : Object <static> UI default Client Context content id	ClientContextUI
	SHOW_BOX_COOKIE : String <static> Name of the cookie that stores if CC should be displayed or not on page load	ClientContextUI

Public Methods

Method		Defined By
	ClientContextUI.create( String ccPath, String pagePath ) : void <static> Creates and inits the Client Context UI. <static> Creates and inits the Client Context UI. Parameters: ccPath : String Path to the Client Context pagePath : String Path the the current page Returns: void	ClientContextUI
	getBoxId() : String Returns the box id. Returns the box id. Parameters: None. Returns: String The id of the box	ClientContextUI
	hide() : void Hides the UI. Fires "beforehide" and "hide" events. Hides the UI. Fires "beforehide" and "hide" events. Parameters: None. Returns: void	ClientContextUI
	init( String url, String containerId, String boxId, String contentPlaceholderId, Boolean editMode ) : void Inits the UI. Inits the UI. Parameters: url : String URL to the Client Context containerId : String Id of the container div boxId : String Id of the UI box contentPlaceholderId : String Id of the placeholder for the CC content editMode : Boolean True if edit mode, false otherwise Returns: void	ClientContextUI
	isAvailable() : Boolean Returns if UI is available: true if some content is load into the UI box. Returns if UI is available: true if some content is load into the UI box. Parameters: None. Returns: Boolean True if available, false otherwise	ClientContextUI
	load( Boolean force ) : void Loads the Client Context content. If already loaded, will not be loaded again until force is set to true. Fires "befo... Loads the Client Context content. If already loaded, will not be loaded again until force is set to true. Fires "beforeload" and "load" events. Parameters: force : Boolean True to force the loading Returns: void	ClientContextUI
	onLoad( Function callback, Object scope ) : void Helper method to register an on load event. Checks if the Client Context has already been loaded. Helper method to register an on load event. Checks if the Client Context has already been loaded. Parameters: callback : Function Function to execute on load scope : Object Execution scope Returns: void	ClientContextUI
	render() : void Renders the UI. Fires "beforerender" and "render" events. Renders the UI. Fires "beforerender" and "render" events. Parameters: None. Returns: void	ClientContextUI
	show() : void Shows the UI. Loads the Client Context and renders the UI if not already done. Fires "beforeshow" and "show" events. Shows the UI. Loads the Client Context and renders the UI if not already done. Fires "beforeshow" and "show" events. Parameters: None. Returns: void	ClientContextUI
	toggle() : void Toggles the UI. Toggles the UI. Parameters: None. Returns: void	ClientContextUI

Public Events