Class CQ.wcm.Page

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

A helper class providing information about a CQ page as well as methods to manipulate it. Use CQ.WCM.getPage to retrieve an instance of this class for the current page.

This class is a singleton and cannot be created directly.

Public Properties

Property		Defined By
	Page.STATUS_PATH : String <static> The path to the service rendering page info.	Page
	Page.STATUS_SELECTOR : String Deprecated: <static> The name of the status selector.	Page

Public Methods

Method		Defined By
	canUnlock() : Boolean Returns true if the current user has permission to unlock the page. Returns true if the current user has permission to unlock the page. Parameters: None. Returns: `Boolean` True if page can be unlocked	Page
	getLockOwner() : String Returns the ID of the user that has locked the page. Returns the ID of the user that has locked the page. Parameters: None. Returns: `String` The lock owner	Page
	hasPermission() : Boolean Returns true if the user has the specified permission on the path. Returns true if the user has the specified permission on the path. Parameters: None. Returns: `Boolean` True if user has permission	Page
	isDesignable() : Boolean Returns true if the page has a design and the user has permission to edit the design. Returns true if the page has a design and the user has permission to edit the design. Parameters: None. Returns: `Boolean` True if page is designable	Page
	isInBlueprint() : Boolean Returns true if the page is part of a Blueprint. Returns true if the page is part of a Blueprint. Parameters: None. Returns: `Boolean` True if page is in Blueprint	Page
	isLiveCopy() : Boolean Returns true if the page is a Live Copy. Returns true if the page is a Live Copy. Parameters: None. Returns: `Boolean` True if page is Live Copy	Page
	isLiveCopySource() : Boolean Returns true if the page is the source of a Live Copy. Returns true if the page is the source of a Live Copy. Parameters: None. Returns: `Boolean` True if page is Live Copy source	Page
	isLocked() : Boolean Returns true if the page is currently locked by another user. Returns true if the page is currently locked by another user. Parameters: None. Returns: `Boolean` True if page is locked	Page
	isReadOnly() : Boolean Returns true if the user has no update permission on the page. Returns true if the user has no update permission on the page. Parameters: None. Returns: `Boolean` True if page is read-only.	Page
	lock( [`Function callback`], [`Object scope`] ) : void Locks the page. Locks the page. Parameters: `callback` : Function (Optional) The function to call when the request is completed. The callback is passed the following arguments: `options` : Object The parameters to the request call. `success` : Boolean True if the request succeeded. `response` : XMLHttpRequest The XMLHttpRequest object containing the response data. See http://www.w3.org/TR/XMLHttpRequest/ for details about accessing elements of the response. `scope` : Object (Optional) The scope to call the callback function in. Returns: `void`	Page
	unlock( [`Function callback`], [`Object scope`] ) : void Unlocks the page. Unlocks the page. Parameters: `callback` : Function (Optional) The function to call when the request is completed. The callback is passed the following arguments: `options` : Object The parameters to the request call. `success` : Boolean True if the request succeeded. `response` : XMLHttpRequest The XMLHttpRequest object containing the response data. See http://www.w3.org/TR/XMLHttpRequest/ for details about accessing elements of the response. `scope` : Object (Optional) The scope to call the callback function in. Returns: `void`	Page

Public Events

This class has no public events.