API: element → YAHOO.util.Element class

class YAHOO.util.Element

Element provides an wrapper object to simplify adding event listeners, using dom methods, and managing attributes.

Uses…

YAHOO.util.AttributeProvider

Known subclasses

Constructor

Constructor Parameters Returns

Constructor	Parameters	Returns
`YAHOO.util.Element( el, map )`	Parameters: `el <HTMLElement \| String>` The html element that represents the Element. `map <Object>` A key-value map of initial config names and values


                      YAHOO.util.Element(
                      el, map
                      )

Parameters:

el <HTMLElement | String> The html element that represents the Element.
map <Object> A key-value map of initial config names and values

Properties

Properties	Type	Description
`DOM_EVENTS`	`Object`	↑ Dom events supported by the Element instance.

Properties inherited from YAHOO.util.AttributeProvider

Properties	Notes
`_configs`	↑

Properties inherited from YAHOO.util.EventProvider

Properties	Notes
`__yui_events`	↑
`__yui_subscribers`	↑

Methods

Methods	Returns	Description
`_setHTMLAttrConfig( element, key, map )`	`void` private	↑ Sets the value of the property and fires beforeChange and change events. Parameters: `element <YAHOO.util.Element>` The Element instance to register the config to. `key <String>` The name of the config to register `map <Object>` A key-value map of the config's params
`addClass( className )`	`void`	↑ Wrapper for Dom method. Parameters: `className <String>` The className to add
`addListener( type, fn, obj, scope )`	`void`	↑ Adds a listener for the given event. These may be DOM or customEvent listeners. Any event that is fired via fireEvent can be listened for. All handlers receive an event object. Parameters: `type <String>` The name of the event to listen for `fn <Function>` The handler to call when the event fires `obj <Any>` A variable to pass to the handler `scope <Object>` The object to use for the scope of the handler
`appendChild( child )`	`HTMLElement`	↑ Wrapper for HTMLElement method. Parameters: `child <YAHOO.util.Element \|\| HTMLElement>` The element to append. Returns: `<HTMLElement>` The appended DOM element.
`appendTo( parentNode, before )`	`HTMLElement`	↑ Appends the HTMLElement into either the supplied parentNode. Parameters: `parentNode <HTMLElement \| Element>` The node to append to `before <HTMLElement \| Element>` An optional node to insert before Returns: `<HTMLElement>` The appended DOM element.
`delegate( type, fn, filter, obj, scope )`	`boolean`	↑ Appends a delegated event listener. Delegated event listeners receive two arguments by default: the DOM event and the element specified by the filtering function or CSS selector. (Note: Using the delegate method requires the element-delegate module. Using CSS selectors as the filtering criteria for delegated event listeners requires inclusion of the Selector Utility.) Parameters: `type <String>` The name of the event to listen for `fn <Function>` The handler to call when the event fires `filter <Function\|string>` Function or CSS selector used to determine for what element(s) the event listener should be called. When a function is specified, the function should return an HTML element. Using a CSS Selector requires the inclusion of the CSS Selector Utility. `obj <Any>` A variable to pass to the handler `scope <Object>` The object to use for the scope of the handler Returns: `<boolean>` Returns true if the delegated event listener was added successfully
`fireQueue( )`	`void`	↑ Apply any queued set calls.
`getElementsByClassName( className, tag )`	`Array`	↑ Wrapper for Dom method. Parameters: `className <String>` The className to collect `tag <String>` (optional) The tag to use in conjunction with class name Returns: `<Array>` Array of HTMLElements
`getElementsByTagName( tag )`	`HTMLCollection`	↑ Wrapper for HTMLElement method. Parameters: `tag <String>` The tagName to collect Returns: `<HTMLCollection>` A collection of DOM elements.
`getStyle( property )`	`String`	↑ Wrapper for Dom method. Parameters: `property <String>` The style property to retrieve Returns: `<String>` The current value of the property
`hasChildNodes( )`	`Boolean`	↑ Wrapper for HTMLElement method. Returns: `<Boolean>` Whether or not the element has childNodes
`hasClass( className )`	`Boolean`	↑ Wrapper for Dom method. Parameters: `className <String>` The className to add Returns: `<Boolean>` Whether or not the element has the class name
`initAttributes( map )`	`void`	↑ Registers Element specific attributes. Parameters: `map <Object>` A key-value map of initial attribute configs
`insertBefore( element, before )`	`HTMLElement`	↑ Wrapper for HTMLElement method. Parameters: `element <HTMLElement>` The HTMLElement to insert `before <HTMLElement>` The HTMLElement to insert the element before. Returns: `<HTMLElement>` The inserted DOM element.
`on( type, fn, obj, scope )`	`void`	↑ Alias for addListener Parameters: `type <String>` The name of the event to listen for `fn <Function>` The function call when the event fires `obj <Any>` A variable to pass to the handler `scope <Object>` The object to use for the scope of the handler
`removeChild( child )`	`HTMLElement`	↑ Wrapper for HTMLElement method. Parameters: `child <HTMLElement>` The HTMLElement to remove Returns: `<HTMLElement>` The removed DOM element.
`removeClass( className )`	`void`	↑ Wrapper for Dom method. Parameters: `className <String>` The className to remove
`removeDelegate( type, fn )`	`boolean`	↑ Remove a delegated event listener Parameters: `type <String>` The name of the event to listen for `fn <Function>` The function call when the event fires Returns: `<boolean>` Returns true if the unbind was successful, false otherwise.
`removeListener( type, fn )`	`void`	↑ Remove an event listener Parameters: `type <String>` The name of the event to listen for `fn <Function>` The function call when the event fires
`replaceChild( newNode, oldNode )`	`HTMLElement`	↑ Wrapper for HTMLElement method. Parameters: `newNode <HTMLElement>` The HTMLElement to insert `oldNode <HTMLElement>` The HTMLElement to replace Returns: `<HTMLElement>` The replaced DOM element.
`replaceClass( oldClassName, newClassName )`	`void`	↑ Wrapper for Dom method. Parameters: `oldClassName <String>` The className to replace `newClassName <String>` The className to add
`setStyle( property, value )`	`void`	↑ Wrapper for Dom method. Parameters: `property <String>` The style property to set `value <String>` The value to apply to the style property
`subscribe( type, fn, obj, scope )`	`void`	↑ Alias for addListener Parameters: `type <String>` The name of the event to listen for `fn <Function>` The function call when the event fires `obj <Any>` A variable to pass to the handler `scope <Object>` The object to use for the scope of the handler

Methods inherited from YAHOO.util.AttributeProvider

Methods	Notes
`configureAttribute`	↑ deprecated
`fireBeforeChangeEvent`	↑
`fireChangeEvent`	↑
`get`	↑
`getAttributeConfig`	↑
`getAttributeKeys`	↑
`refresh`	↑
`register`	↑ deprecated
`resetAttributeConfig`	↑
`resetValue`	↑
`set`	↑
`setAttributeConfig`	↑
`setAttributes`	↑

Methods inherited from YAHOO.util.EventProvider

Methods	Notes
`createEvent`	↑
`fireEvent`	↑
`hasEvent`	↑
`subscribe`	↑
`unsubscribe`	↑
`unsubscribeAll`	↑

Events

Events	Description
`appendTo( )`	↑ Fires after the Element is appended to another Element. See: Element.addListener Event fields: `<String> type` appendTo `<HTMLElement/Element> target` the HTMLElement/Element being appended to Usage: `var handler = function(e) {var target = e.target}; myTabs.addListener('appendTo', handler);`
`available( )`	↑ Fires when the Element's HTMLElement can be retrieved by Id. See: Element.addListener Event fields: `<String> type` available `<HTMLElement> target` the HTMLElement bound to this Element instance Usage: `var handler = function(e) {var target = e.target}; myTabs.addListener('available', handler);`
`beforeAppendTo( )`	↑ Fires before the Element is appended to another Element. See: Element.addListener Event fields: `<String> type` beforeAppendTo `<HTMLElement/Element> target` the HTMLElement/Element being appended to Usage: `var handler = function(e) {var target = e.target}; myTabs.addListener('beforeAppendTo', handler);`
`beforeElementChange( event )`	↑ Fires before the value for the configuration attribute 'element' changes. Return false to cancel the attribute change. Parameters: `event <{oldValue: any, newValue: any}>` An object containing the previous attribute value and the new value.
`contentReady( )`	↑ Fires when the Element's HTMLElement subtree is rendered. See: Element.addListener Event fields: `<String> type` contentReady `<HTMLElement> target` the HTMLElement bound to this Element instance Usage: `var handler = function(e) {var target = e.target}; myTabs.addListener('contentReady', handler);`
`elementChange( event )`	↑ Fires when the value for the configuration attribute 'element' changes. Parameters: `event <{oldValue: any, newValue: any}>` An object containing the previous attribute value and the new value.

Configuration Attributes

Attributes	Type	Description
`element`	`HTMLElement`	↑ The HTMLElement the Element instance refers to.