Properties

Methods

Events

Config Options

Direct Link

Element
  Layer

Class CQ.Ext.Layer

Package:	CQ.Ext
Class:	Layer
Extends:	CQ.Ext.Element
Clientlib:	cq.widgets

An extended CQ.Ext.Element object that supports a shadow and shim, constrain to viewport and automatic maintaining of shadow/shim positions.

Config Options

Config Options		Defined By
	cls : String CSS class to add to the element	Layer
	constrain : Boolean False to disable constrain to viewport (defaults to true)	Layer
	dh : Object DomHelper object config to create element with (defaults to {tag: 'div', cls: 'x-layer'}).	Layer
	shadow : String/Boolean True to automatically create an CQ.Ext.Shadow, or a string indicating the shadow's display CQ.Ext.Shadow.mode. False ... True to automatically create an CQ.Ext.Shadow, or a string indicating the shadow's display CQ.Ext.Shadow.mode. False to disable the shadow. (defaults to false)	Layer
	shadowOffset : Number Number of pixels to offset the shadow (defaults to 4)	Layer
	shim : Boolean False to disable the iframe shim in browsers which need one (defaults to true)	Layer
	useDisplay : Boolean Defaults to use css offsets to hide the Layer. Specify true to use css style 'display:none;' to hide the Layer. Defaults to use css offsets to hide the Layer. Specify `true` to use css style `'display:none;'` to hide the Layer.	Layer
	zindex : Number Starting z-index (defaults to 11000)	Layer

Public Properties

This class has no public properties.

Public Methods

Method		Defined By
	Layer( `Object config`, [`String/HTMLElement existingEl`] ) Parameters: `config` : Object An object with config options. `existingEl` : String/HTMLElement (optional) Uses an existing DOM element. If the element is not found it creates it. Returns:	Layer
	child( `String selector`, [`Boolean returnDom`] ) : HTMLElement/CQ.Ext.Element Selects a single child at any depth below this element based on the passed CSS selector (the selector should not cont... Selects a single child at any depth below this element based on the passed CSS selector (the selector should not contain an id). Parameters: `selector` : String The CSS selector `returnDom` : Boolean (optional) True to return the DOM node instead of CQ.Ext.Element (defaults to false) Returns: `HTMLElement/CQ.Ext.Element` The child CQ.Ext.Element (or DOM node if returnDom = true)	Element
	down( `String selector`, [`Boolean returnDom`] ) : HTMLElement/CQ.Ext.Element Selects a single direct child based on the passed CSS selector (the selector should not contain an id). Selects a single direct child based on the passed CSS selector (the selector should not contain an id). Parameters: `selector` : String The CSS selector `returnDom` : Boolean (optional) True to return the DOM node instead of CQ.Ext.Element (defaults to false) Returns: `HTMLElement/CQ.Ext.Element` The child CQ.Ext.Element (or DOM node if returnDom = true)	Element
	findParent( `String selector`, [`Number/Mixed maxDepth`], [`Boolean returnEl`] ) : HTMLElement Looks at this node and then at parent nodes for a match of the passed simple selector (e.g. div.some-class or span:fi... Looks at this node and then at parent nodes for a match of the passed simple selector (e.g. div.some-class or span:first-child) Parameters: `selector` : String The simple selector to test `maxDepth` : Number/Mixed (optional) The max depth to search as a number or element (defaults to 50 \|\| document.body) `returnEl` : Boolean (optional) True to return a CQ.Ext.Element object instead of DOM node Returns: `HTMLElement` The matching DOM node (or null if no match was found)	Element
	findParentNode( `String selector`, [`Number/Mixed maxDepth`], [`Boolean returnEl`] ) : HTMLElement Looks at parent nodes for a match of the passed simple selector (e.g. div.some-class or span:first-child) Looks at parent nodes for a match of the passed simple selector (e.g. div.some-class or span:first-child) Parameters: `selector` : String The simple selector to test `maxDepth` : Number/Mixed (optional) The max depth to search as a number or element (defaults to 10 \|\| document.body) `returnEl` : Boolean (optional) True to return a CQ.Ext.Element object instead of DOM node Returns: `HTMLElement` The matching DOM node (or null if no match was found)	Element
	first( [`String selector`], [`Boolean returnDom`] ) : CQ.Ext.Element/HTMLElement Gets the first child, skipping text nodes Gets the first child, skipping text nodes Parameters: `selector` : String (optional) Find the next sibling that matches the passed simple selector `returnDom` : Boolean (optional) True to return a raw dom node instead of an CQ.Ext.Element Returns: `CQ.Ext.Element/HTMLElement` The first child or null	Element
	fly( `String/HTMLElement el`, [`String named`] ) : Element Gets the globally shared flyweight Element, with the passed node as the active element. Do not store a reference to t... Gets the globally shared flyweight Element, with the passed node as the active element. Do not store a reference to this element - the dom node can be overwritten by other code. Shorthand of CQ.Ext.Element.fly Use this to make one-time references to DOM elements which are not going to be accessed again either by application code, or by Ext's classes. If accessing an element which will be processed regularly, then CQ.Ext.get will be more appropriate to take advantage of the caching provided by the CQ.Ext.Element class. Parameters: `el` : String/HTMLElement The dom node or id `named` : String (optional) Allows for creation of named reusable flyweights to prevent conflicts (e.g. internally Ext uses "_global") Returns: `Element` The shared Element object (or null if no matching element was found)	Element
	getTextWidth( `String text`, [`Number min`], [`Number max`] ) : Number Returns the width in pixels of the passed text, or the width of the text in this Element. Returns the width in pixels of the passed text, or the width of the text in this Element. Parameters: `text` : String The text to measure. Defaults to the innerHTML of the element. `min` : Number (Optional) The minumum value to return. `max` : Number (Optional) The maximum value to return. Returns: `Number` The text width in pixels.	Element
	last( [`String selector`], [`Boolean returnDom`] ) : CQ.Ext.Element/HTMLElement Gets the last child, skipping text nodes Gets the last child, skipping text nodes Parameters: `selector` : String (optional) Find the previous sibling that matches the passed simple selector `returnDom` : Boolean (optional) True to return a raw dom node instead of an CQ.Ext.Element Returns: `CQ.Ext.Element/HTMLElement` The last child or null	Element
	next( [`String selector`], [`Boolean returnDom`] ) : CQ.Ext.Element/HTMLElement Gets the next sibling, skipping text nodes Gets the next sibling, skipping text nodes Parameters: `selector` : String (optional) Find the next sibling that matches the passed simple selector `returnDom` : Boolean (optional) True to return a raw dom node instead of an CQ.Ext.Element Returns: `CQ.Ext.Element/HTMLElement` The next sibling or null	Element
	on( `String eventName`, `Function fn`, [`Object scope`], [`Object options`] ) : void Appends an event handler (shorthand for addListener). Appends an event handler (shorthand for addListener). Parameters: `eventName` : String The name of event to handle. `fn` : Function The handler function the event invokes. `scope` : Object (optional) The scope (`this` reference) in which the handler function is executed. `options` : Object (optional) An object containing standard addListener options Returns: `void`	Element
	parent( [`String selector`], [`Boolean returnDom`] ) : CQ.Ext.Element/HTMLElement Gets the parent node for this element, optionally chaining up trying to match a selector Gets the parent node for this element, optionally chaining up trying to match a selector Parameters: `selector` : String (optional) Find a parent node that matches the passed simple selector `returnDom` : Boolean (optional) True to return a raw dom node instead of an CQ.Ext.Element Returns: `CQ.Ext.Element/HTMLElement` The parent node or null	Element
	prev( [`String selector`], [`Boolean returnDom`] ) : CQ.Ext.Element/HTMLElement Gets the previous sibling, skipping text nodes Gets the previous sibling, skipping text nodes Parameters: `selector` : String (optional) Find the previous sibling that matches the passed simple selector `returnDom` : Boolean (optional) True to return a raw dom node instead of an CQ.Ext.Element Returns: `CQ.Ext.Element/HTMLElement` The previous sibling or null	Element
	query( `String selector` ) : Array Selects child nodes based on the passed CSS selector (the selector should not contain an id). Selects child nodes based on the passed CSS selector (the selector should not contain an id). Parameters: `selector` : String The CSS selector Returns: `Array` An array of the matched nodes	Element
	select( `String/Array selector`, [`HTMLElement/String root`] ) : CompositeElementLite/CompositeElement Selects elements based on the passed CSS selector to enable Element methods to be applied to many related elements in... Selects elements based on the passed CSS selector to enable Element methods to be applied to many related elements in one statement through the returned CompositeElement or CompositeElementLite object. Parameters: `selector` : String/Array The CSS selector or an array of elements `root` : HTMLElement/String (optional) The root element of the query or id of the root Returns: `CompositeElementLite/CompositeElement`	Element
	setZIndex( `Number zindex` ) : this Sets the z-index of this layer and adjusts any shadow and shim z-indexes. The layer z-index is automatically incremen... Sets the z-index of this layer and adjusts any shadow and shim z-indexes. The layer z-index is automatically incremented by two more than the value passed in so that it always shows above any shadow or shim (the shadow element, if any, will be assigned z-index + 1, and the shim element, if any, will be assigned the unmodified z-index). Parameters: `zindex` : Number The new z-index to set Returns: `this` The Layer	Layer
	un( `String eventName`, `Function fn`, `Object scope` ) : CQ.Ext.Element Removes an event handler from this element (see removeListener for additional notes). Removes an event handler from this element (see removeListener for additional notes). Parameters: `eventName` : String The name of the event from which to remove the handler. `fn` : Function The handler function to remove. This must be a reference to the function passed into the addListener call. `scope` : Object If a scope (`this` reference) was specified when the listener was added, then this must refer to the same object. Returns: `CQ.Ext.Element` this	Element
	up( `String selector`, [`Number/Mixed maxDepth`] ) : CQ.Ext.Element Walks up the dom looking for a parent node that matches the passed simple selector (e.g. div.some-class or span:first... Walks up the dom looking for a parent node that matches the passed simple selector (e.g. div.some-class or span:first-child). This is a shortcut for findParentNode() that always returns an CQ.Ext.Element. Parameters: `selector` : String The simple selector to test `maxDepth` : Number/Mixed (optional) The max depth to search as a number or element (defaults to 10 \|\| document.body) Returns: `CQ.Ext.Element` The matching DOM node (or null if no match was found)	Element

Public Events

This class has no public events.