Properties

Methods

Events

Class CQ.shared.Util

Package:	CQ.shared
Class:	Util
Extends:	Object
Clientlib:	cq.shared

Deprecated:

A helper class providing a set of general utilities.

This class is a singleton and cannot be created directly.

Public Properties

Property		Defined By
	getTopWindow : Object <static> Returns the top most accessible window. Added in CQ 5.5.	Util
	patchText : Object <static> Replaces occurrences of {n} in the specified text with the texts from the snippets. Example 1 (single ... <static> Replaces occurrences of `{n}` in the specified text with the texts from the snippets. Example 1 (single snippet): `var text = CQ.shared.Util.patchText("{0} has signed in.", "Jack");` Result 1: `Jack has signed in.` Example 2 (multiple snippets): `var text = "{0} {1} has signed in from {2}."; text = CQ.shared.Util.patchText(text, ["Jack", "McFarland", "10.0.0.99"]);` Result 2: `Jack McFarland has signed in from 10.0.0.99.`	Util
	setIFrameMode : Object Allows to define if Granite.Util is running in an iFrame and parent window is in another domain (and optionally defin... Allows to define if Granite.Util is running in an iFrame and parent window is in another domain (and optionally define what would be the top window in that case. This is necessary to use getTopWindow in a iFrame on WebKit based browsers because getTopWindow iterates on parent windows to find the top one which triggers a security exception if one parent window is in a different domain. Exception cannot be caught but is not breaking the JS execution.	Util

Public Methods

Method		Defined By
	ellipsis( `String value`, `Number length`, `Boolean word` ) : String Truncates a string and add an ellipsis ('...') to the end if it exceeds the specified length Truncates a string and add an ellipsis ('...') to the end if it exceeds the specified length Parameters: `value` : String The string to truncate `length` : Number The maximum length to allow before truncating `word` : Boolean True to try to find a common work break Returns: `String` The converted text	Util
	eval( `Object response` ) : Object Deprecated: Use CQ.shared.HTTP.eval instead <static> Evaluates and returns the response text of the specified response object. <static> Evaluates and returns the response text of the specified response object. Parameters: `response` : Object The response object Returns: `Object` The evaluated object	Util
	htmlDecode( `String value` ) : String Converts certain characters (&, <, >, and ") from their HTML character equivalents. Converts certain characters (&, <, >, and ") from their HTML character equivalents. Parameters: `value` : String The string to decode Returns: `String` The decoded text	Util
	htmlEncode( `String value` ) : String Converts certain characters (&, <, >, and ") to their HTML character equivalents for literal display in web pages. Converts certain characters (&, <, >, and ") to their HTML character equivalents for literal display in web pages. Parameters: `value` : String The string to encode Returns: `String` The encoded text	Util
	load( `String url`, [`String preventHistory`] ) : void <static> Loads the specified URL in the current window. <static> Loads the specified URL in the current window. Parameters: `url` : String The URL `preventHistory` : String (optional) Prevent history Returns: `void`	Util
	open( `String url`, [`Window win`], [`String name`], [`String options`] ) : Object <static> Opens a new window with the specified URL. If no window is specified, the current window will be used. <static> Opens a new window with the specified URL. If no window is specified, the current window will be used. Parameters: `url` : String The URL `win` : Window (optional) The window to reload `name` : String (optional) New window name `options` : String (optional) New window options Returns: `Object` New window	Util
	reload( [`Window win`], [`String url`], [`String preventHistory`] ) : void <static> Reloads the window or replaces its location with the specified URL. If no window is specified, the cur... <static> Reloads the window or replaces its location with the specified URL. If no window is specified, the current window will be used. Parameters: `win` : Window (optional) The window to reload `url` : String (optional) The URL `preventHistory` : String (optional) Prevent history Returns: `void`	Util

Public Events

This class has no public events.