API: tabview YAHOO.util.Element (YUI Library)

Class YAHOO.util.Element - uses YAHOO.util.AttributeProvider

Element provides an interface to an HTMLElement's attributes and common methods. Other commonly used attributes are added as well.

Constructor

YAHOO.util.Element

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

Properties

DOM_EVENTS `- Object`

Dom events supported by the Element instance.

Methods

_registerHTMLAttr


                                         private 
                                        
                                        
                                        void
                                            _registerHTMLAttr
                                           (
                                                
                                                        
                                                         element
                                                    
                                                
                                                        , 
                                                         key
                                                    
                                                
                                                        , 
                                                         map
                                                    
                                                
                                            )

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

Returns: void

addClass

Wrapper for Dom method.

Parameters:: className <String> The className to add

Returns: void

addListener


                                        
                                        
                                        
                                        void
                                            addListener
                                           (
                                                
                                                        
                                                         type
                                                    
                                                
                                                        , 
                                                         fn
                                                    
                                                
                                                        , 
                                                         obj
                                                    
                                                
                                                        , 
                                                         scope
                                                    
                                                
                                            )

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

Returns: void

appendChild


                                        
                                        
                                        
                                        void
                                            appendChild
                                           (
                                                
                                                        
                                                         deep
                                                    
                                                
                                            )

Wrapper for HTMLElement method.

Parameters:: deep <Boolean> Whether or not to do a deep clone

Returns: void

appendTo

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: void

fireQueue

Apply any queued set calls.

Returns: void

getElementsByClassName


                                        
                                        
                                        
                                        Array
                                            getElementsByClassName
                                           (
                                                
                                                        
                                                         className
                                                    
                                                
                                                        , 
                                                         tag
                                                    
                                                
                                            )

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


                                        
                                        
                                        
                                        void
                                            getElementsByTagName
                                           (
                                                
                                                        
                                                         tag
                                                    
                                                
                                            )

Wrapper for HTMLElement method.

Parameters:: tag <String> The tagName to collect

Returns: void

getStyle

Wrapper for Dom method.

Parameters:: property <String> The style property to retrieve

Returns: String: The current value of the property

hasChildNodes


                                        
                                        
                                        
                                        Boolean
                                            hasChildNodes
                                           (
                                            )

Wrapper for HTMLElement method.

Returns: Boolean: Whether or not the element has childNodes

hasClass

Wrapper for Dom method.

Parameters:: className <String> The className to add

Returns: Boolean: Whether or not the element has the class name

initAttributes


                                        
                                        
                                        
                                        void
                                            initAttributes
                                           (
                                                
                                                        
                                                         map
                                                    
                                                
                                            )

Registers Element specific attributes.

Parameters:: map <Object> A key-value map of initial attribute configs

Returns: void

insertBefore


                                        
                                        
                                        
                                        void
                                            insertBefore
                                           (
                                                
                                                        
                                                         element
                                                    
                                                
                                                        , 
                                                         before
                                                    
                                                
                                            )

Wrapper for HTMLElement method.

Parameters:: element <HTMLElement> The HTMLElement to insert; before <HTMLElement> The HTMLElement to insert the element before.

Returns: void

on

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

Returns: void

removeChild


                                        
                                        
                                        
                                        void
                                            removeChild
                                           (
                                                
                                                        
                                                         child
                                                    
                                                
                                            )

Wrapper for HTMLElement method.

Parameters:: child <HTMLElement> The HTMLElement to remove

Returns: void

removeClass


                                        
                                        
                                        
                                        void
                                            removeClass
                                           (
                                                
                                                        
                                                         className
                                                    
                                                
                                            )

Wrapper for Dom method.

Parameters:: className <String> The className to remove

Returns: void

removeListener


                                        
                                        
                                        
                                        void
                                            removeListener
                                           (
                                                
                                                        
                                                         type
                                                    
                                                
                                                        , 
                                                         fn
                                                    
                                                
                                            )

Remove an event listener

Parameters:: type <String> The name of the event to listen for; fn <Function> The function call when the event fires

Returns: void

replaceChild


                                        
                                        
                                        
                                        void
                                            replaceChild
                                           (
                                                
                                                        
                                                         newNode
                                                    
                                                
                                                        , 
                                                         oldNode
                                                    
                                                
                                            )

Wrapper for HTMLElement method.

Parameters:: newNode <HTMLElement> The HTMLElement to insert; oldNode <HTMLElement> The HTMLElement to replace

Returns: void

replaceClass


                                        
                                        
                                        
                                        void
                                            replaceClass
                                           (
                                                
                                                        
                                                         oldClassName
                                                    
                                                
                                                        , 
                                                         newClassName
                                                    
                                                
                                            )

Wrapper for Dom method.

Parameters:: oldClassName <String> The className to replace; newClassName <String> The className to add

Returns: void

setStyle

Wrapper for Dom method.

Parameters:: property <String> The style property to set; value <String> The value to apply to the style property

Returns: void

Events

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);

contentReady


                                        
                                        
                                        
                                            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);

Configuration Attributes

element `- HTMLElement`

The HTMLElement the Element instance refers to.

Yahoo! UI Library

tabview

Class YAHOO.util.Element - uses YAHOO.util.AttributeProvider

DOM_EVENTS - Object

Properties inherited from YAHOO.util.AttributeProvider:

Properties inherited from YAHOO.util.EventProvider:

Methods inherited from YAHOO.util.AttributeProvider:

Methods inherited from YAHOO.util.EventProvider:

element - HTMLElement

Modules

Classes

Files

Properties

Methods

Events

Configuration Attributes

foot

had

please

coat

held

rest

go

laugh

verb

went

street

condition

broke

describe

piece

plant

brown

instant

front

port

wave

teeth

start

basic

shoe

copy

town

pick

cold

blow

bat

corner

level

similar

equate

young

continue

degree

way

cell

same

match

five

children

ask

study

pretty

above

spoke

problem

girl

century

dress

lead

subtract

nothing

my

surprise

inch

team

go

out

run

spread

DOM_EVENTS `- Object`

element `- HTMLElement`