- Known Subclasses:
-
YAHOO.widget.SimpleEditor
YAHOO.widget.ColorPicker
YAHOO.widget.ToolbarButton
YAHOO.widget.ButtonGroup
YAHOO.widget.Button
YAHOO.widget.Tab
YAHOO.widget.TabView
Element provides an wrapper object to simplify adding
event listeners, using dom methods, and managing attributes.
Constructor
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
Dom events supported by the Element instance.
Methods
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
void
addClass
(
className
)
Wrapper for Dom method.
- Parameters:
-
className <String>
The className to add
- Returns:
void
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
void
appendChild
(
child
)
Wrapper for HTMLElement method.
- Parameters:
-
child <YAHOO.util.Element || HTMLElement>
The element to append.
- Returns:
void
void
appendTo
(
parentNode
,
before
)
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
void
fireQueue
(
)
Apply any queued set calls.
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
void
getElementsByTagName
(
tag
)
Wrapper for HTMLElement method.
- Parameters:
-
tag <String>
The tagName to collect
- Returns:
void
String
getStyle
(
property
)
Wrapper for Dom method.
- Parameters:
-
property <String>
The style property to retrieve
- Returns:
String
- The current value of the property
Boolean
hasChildNodes
(
)
Wrapper for HTMLElement method.
- Returns:
Boolean
- Whether or not the element has childNodes
Boolean
hasClass
(
className
)
Wrapper for Dom method.
- Parameters:
-
className <String>
The className to add
- Returns:
Boolean
- Whether or not the element has the class name
void
initAttributes
(
map
)
Registers Element specific attributes.
- Parameters:
-
map <Object>
A key-value map of initial attribute configs
- Returns:
void
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
void
on
(
type
,
fn
,
obj
,
scope
)
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
void
removeChild
(
child
)
Wrapper for HTMLElement method.
- Parameters:
-
child <HTMLElement>
The HTMLElement to remove
- Returns:
void
void
removeClass
(
className
)
Wrapper for Dom method.
- Parameters:
-
className <String>
The className to remove
- Returns:
void
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
void
replaceChild
(
newNode
,
oldNode
)
Wrapper for HTMLElement method.
- Parameters:
-
newNode <HTMLElement>
The HTMLElement to insert
-
oldNode <HTMLElement>
The HTMLElement to replace
- Returns:
void
void
replaceClass
(
oldClassName
,
newClassName
)
Wrapper for Dom method.
- Parameters:
-
oldClassName <String>
The className to replace
-
newClassName <String>
The className to add
- Returns:
void
void
setStyle
(
property
,
value
)
Wrapper for Dom method.
- Parameters:
-
property <String>
The style property to set
-
value <String>
The value to apply to the style property
- Returns:
void
void
subscribe
(
type
,
fn
,
obj
,
scope
)
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
configureAttribute, fireBeforeChangeEvent, fireChangeEvent, get, getAttributeConfig, getAttributeKeys, refresh, register, resetAttributeConfig, resetValue, set, setAttributeConfig, setAttributes
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
(
)
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
The HTMLElement the Element instance refers to.