20f8df1291
data tables are going to need some work yet, but the other stuff seems to be working 100%
2498 lines
116 KiB
HTML
2498 lines
116 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
|
|
<html>
|
|
<head>
|
|
<title>API: container YAHOO.widget.Module (YUI Library)</title>
|
|
<link rel="stylesheet" type="text/css" href="assets/api.css">
|
|
<script type="text/javascript" src="assets/api-js"></script>
|
|
<script type="text/javascript" src="assets/ac-js"></script>
|
|
</head>
|
|
|
|
<body id="yahoo-com">
|
|
|
|
<div id="doc3" class="yui-t2">
|
|
|
|
<div id="hd">
|
|
<a href="http://developer.yahoo.com/yui/"><h1>Yahoo! UI Library</h1></a>
|
|
<h3>Container <span class="subtitle">2.6.0</span></h3>
|
|
<p>
|
|
<a href="./index.html">Yahoo! UI Library</a>
|
|
> <a href="./module_container.html">container</a>
|
|
> YAHOO.widget.Module
|
|
|
|
</p>
|
|
|
|
|
|
</div>
|
|
|
|
<div id="bd">
|
|
<div id="yui-main">
|
|
<div class="yui-b">
|
|
<form name="yui-classopts-form">
|
|
<span id="classopts"><input type="checkbox" name="showprivate" id="showprivate" /> <label for="showprivate">Show Private</label></span>
|
|
<span id="classopts"><input type="checkbox" name="showprotected" id="showprotected" /> <label for="showprotected">Show Protected</label></span>
|
|
<span id="classopts"><input type="checkbox" name="showdeprecated" id="showdeprecated" /> <label for="showdeprecated">Show Deprecated</label></span>
|
|
</form>
|
|
|
|
<h2>
|
|
|
|
|
|
|
|
|
|
Class <b>YAHOO.widget.Module</b>
|
|
<span class="extends">
|
|
</span>
|
|
|
|
<span class="extends">
|
|
</span>
|
|
|
|
</code>
|
|
</h2>
|
|
<!-- class tree goes here -->
|
|
|
|
<dl class="subclasses">
|
|
<dt>Known Subclasses:</dd>
|
|
<dd>
|
|
<a href="YAHOO.widget.Overlay.html">YAHOO.widget.Overlay</a>
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
<div class="summary description">
|
|
Module is a JavaScript representation of the Standard Module Format.
|
|
Standard Module Format is a simple standard for markup containers where
|
|
child nodes representing the header, body, and footer of the content are
|
|
denoted using the CSS classes "hd", "bd", and "ft" respectively.
|
|
Module is the base class for all other classes in the YUI
|
|
Container package.
|
|
</div>
|
|
|
|
<div class="section constructor details">
|
|
<h3 id="constructor">Constructor</h3>
|
|
<div class="content">
|
|
<div class="detail">
|
|
<strong>YAHOO.widget.Module</strong>
|
|
<code>
|
|
(
|
|
|
|
|
|
|
|
el
|
|
|
|
|
|
,
|
|
userConfig
|
|
)
|
|
</code>
|
|
<div class="description">
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>el
|
|
<String>
|
|
</code>
|
|
The element ID representing the Module <em>OR</em>
|
|
</dd>
|
|
<dd>
|
|
<code>el
|
|
<HTMLElement>
|
|
</code>
|
|
The element representing the Module
|
|
</dd>
|
|
<dd>
|
|
<code>userConfig
|
|
<Object>
|
|
</code>
|
|
The configuration Object literal containing
|
|
the configuration that should be set for this module. See configuration
|
|
documentation for more details.
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="section field details">
|
|
<h3 id="properties">Properties</h3>
|
|
<div class="content">
|
|
<div class="">
|
|
<h4><a name="property_body">body</a>
|
|
<code>- HTMLElement</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
The body element, denoted with CSS class "bd"
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
<div class=" deprecated">
|
|
<h4><a name="property_browser">browser</a>
|
|
<code>- String</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
String representing the user-agent of the browser
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
<div class="deprecated">
|
|
<strong>Deprecated:</strong> Use YAHOO.env.ua
|
|
</div>
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4><a name="property_cfg">cfg</a>
|
|
<code>- YAHOO.util.Config</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
The Module's Config object used for monitoring
|
|
configuration properties.
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4><a name="property_contructor">contructor</a>
|
|
<code>- Function</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
The class's constructor function
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="private">
|
|
<h4><a name="property_DEFAULT_CONFIG">DEFAULT_CONFIG</a>
|
|
<code>- private final Object</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
Constant representing the Module's configuration properties
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4><a name="property_element">element</a>
|
|
<code>- HTMLElement</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
The main module element that contains the header, body, and footer
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="private">
|
|
<h4><a name="property_EVENT_TYPES">EVENT_TYPES</a>
|
|
<code>- private final Object</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
Constant representing the name of the Module's events
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4><a name="property_footer">footer</a>
|
|
<code>- HTMLElement</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
The footer element, denoted with CSS class "ft"
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4><a name="property_header">header</a>
|
|
<code>- HTMLElement</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
The header element, denoted with CSS class "hd"
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4><a name="property_id">id</a>
|
|
<code>- String</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
The id of the element
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
<div class=" deprecated">
|
|
<h4><a name="property_imageRoot">imageRoot</a>
|
|
<code>- String</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
A string representing the root path for all images created by
|
|
a Module instance.
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
<div class="deprecated">
|
|
<strong>Deprecated:</strong> It is recommend that any images for a Module be applied
|
|
via CSS using the "background-image" property.
|
|
</div>
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4><a name="property_isSecure">isSecure</a>
|
|
<code>- Boolean</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
Boolean representing whether or not the current browsing context is
|
|
secure (https)
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4><a name="property_platform">platform</a>
|
|
<code>- String</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
String representing the current user-agent platform
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4><a name="property_YAHOO.widget.Module.CSS_BODY">YAHOO.widget.Module.CSS_BODY</a>
|
|
<code>- static final String</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
Constant representing the module body
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4><a name="property_YAHOO.widget.Module.CSS_FOOTER">YAHOO.widget.Module.CSS_FOOTER</a>
|
|
<code>- static final String</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
Constant representing the module footer
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4><a name="property_YAHOO.widget.Module.CSS_HEADER">YAHOO.widget.Module.CSS_HEADER</a>
|
|
<code>- static final String</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
Constant representing the module header
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4><a name="property_YAHOO.widget.Module.CSS_MODULE">YAHOO.widget.Module.CSS_MODULE</a>
|
|
<code>- static final String</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
Constant for the default CSS class name that represents a Module
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4><a name="property_YAHOO.widget.Module.IMG_ROOT">YAHOO.widget.Module.IMG_ROOT</a>
|
|
<code>- static final String</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
Constant representing the prefix path to use for non-secure images
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4><a name="property_YAHOO.widget.Module.IMG_ROOT_SSL">YAHOO.widget.Module.IMG_ROOT_SSL</a>
|
|
<code>- static final String</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
Constant representing the prefix path to use for securely served images
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4><a name="property_YAHOO.widget.Module.RESIZE_MONITOR_SECURE_URL">YAHOO.widget.Module.RESIZE_MONITOR_SECURE_URL</a>
|
|
<code>- static final String</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
Constant representing the url for the "src" attribute of the iframe
|
|
used to monitor changes to the browser's base font size
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<div class="section method details">
|
|
<h3 id="methods">Methods</h3>
|
|
<div class="content">
|
|
<div class="protected">
|
|
<h4>
|
|
<a name="method__addToParent">_addToParent</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
protected
|
|
|
|
|
|
void
|
|
<strong>_addToParent</strong>
|
|
(
|
|
|
|
|
|
The
|
|
|
|
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
This method is a protected helper, used when constructing the DOM structure for the module
|
|
to account for situations which may cause Operation Aborted errors in IE. It should not
|
|
be used for general DOM construction.
|
|
<p>
|
|
If the parentNode is not document.body, the element is appended as the last element.
|
|
</p>
|
|
<p>
|
|
If the parentNode is document.body the element is added as the first child to help
|
|
prevent Operation Aborted errors in IE.
|
|
</p>
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>The <parentNode></code>
|
|
HTML element to which the element will be added
|
|
</dd>
|
|
<dd>
|
|
<code>The <element></code>
|
|
HTML element to be added to parentNode's children
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="protected">
|
|
<h4>
|
|
<a name="method__initResizeMonitor">_initResizeMonitor</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
protected
|
|
|
|
|
|
void
|
|
<strong>_initResizeMonitor</strong>
|
|
(
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Create and initialize the text resize monitoring iframe.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="private">
|
|
<h4>
|
|
<a name="method__supportsCWResize">_supportsCWResize</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
private
|
|
|
|
|
|
void
|
|
<strong>_supportsCWResize</strong>
|
|
(
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Text resize monitor helper method.
|
|
Determines if the browser supports resize events on iframe content windows.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="method_appendToBody">appendToBody</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
void
|
|
<strong>appendToBody</strong>
|
|
(
|
|
|
|
|
|
element
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Appends the passed element to the body. If no body is present, one
|
|
will be automatically created.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>element <HTMLElement | DocumentFragment></code>
|
|
The element to
|
|
append to the body. In the case of a document fragment, the
|
|
children of the fragment will be appended to the body.
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="method_appendToFooter">appendToFooter</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
void
|
|
<strong>appendToFooter</strong>
|
|
(
|
|
|
|
|
|
element
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Appends the passed element to the footer. If no footer is present,
|
|
one will be automatically created.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>element <HTMLElement | DocumentFragment></code>
|
|
The element to
|
|
append to the footer. In the case of a document fragment, the
|
|
children of the fragment will be appended to the footer
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="method_appendToHeader">appendToHeader</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
void
|
|
<strong>appendToHeader</strong>
|
|
(
|
|
|
|
|
|
element
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Appends the passed element to the header. If no header is present,
|
|
one will be automatically created.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>element <HTMLElement | DocumentFragment></code>
|
|
The element to
|
|
append to the header. In the case of a document fragment, the
|
|
children of the fragment will be appended to the header.
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="method_configMonitorResize">configMonitorResize</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
void
|
|
<strong>configMonitorResize</strong>
|
|
(
|
|
|
|
|
|
type
|
|
|
|
|
|
,
|
|
args
|
|
|
|
|
|
,
|
|
obj
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Default event handler for the "monitorresize" configuration property
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>type <String></code>
|
|
The CustomEvent type (usually the property name)
|
|
</dd>
|
|
<dd>
|
|
<code>args <Object[]></code>
|
|
The CustomEvent arguments. For configuration
|
|
handlers, args[0] will equal the newly applied value for the property.
|
|
</dd>
|
|
<dd>
|
|
<code>obj <Object></code>
|
|
The scope object. For configuration handlers,
|
|
this will usually equal the owner.
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="method_configVisible">configVisible</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
void
|
|
<strong>configVisible</strong>
|
|
(
|
|
|
|
|
|
type
|
|
|
|
|
|
,
|
|
args
|
|
|
|
|
|
,
|
|
obj
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Default event handler for changing the visibility property of a
|
|
Module. By default, this is achieved by switching the "display" style
|
|
between "block" and "none".
|
|
This method is responsible for firing showEvent and hideEvent.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>type <String></code>
|
|
The CustomEvent type (usually the property name)
|
|
</dd>
|
|
<dd>
|
|
<code>args <Object[]></code>
|
|
The CustomEvent arguments. For configuration
|
|
handlers, args[0] will equal the newly applied value for the property.
|
|
</dd>
|
|
<dd>
|
|
<code>obj <Object></code>
|
|
The scope object. For configuration handlers,
|
|
this will usually equal the owner.
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="method_destroy">destroy</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
void
|
|
<strong>destroy</strong>
|
|
(
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Removes the Module element from the DOM and sets all child elements
|
|
to null.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="method_hide">hide</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
void
|
|
<strong>hide</strong>
|
|
(
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Hides the Module element by setting the visible configuration
|
|
property to false. Also fires two events: beforeHideEvent prior to
|
|
the visibility change, and hideEvent after.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="method_init">init</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
void
|
|
<strong>init</strong>
|
|
(
|
|
|
|
|
|
el
|
|
|
|
|
|
|
|
|
|
,
|
|
userConfig
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
The Module class's initialization method, which is executed for
|
|
Module and all of its subclasses. This method is automatically
|
|
called by the constructor, and sets up all DOM references for
|
|
pre-existing markup, and creates required markup if it is not
|
|
already present.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>el <String></code>
|
|
The element ID representing the Module <em>OR</em>
|
|
</dd>
|
|
<dd>
|
|
<code>el <HTMLElement></code>
|
|
The element representing the Module
|
|
</dd>
|
|
<dd>
|
|
<code>userConfig <Object></code>
|
|
The configuration Object literal
|
|
containing the configuration that should be set for this module.
|
|
See configuration documentation for more details.
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="method_initDefaultConfig">initDefaultConfig</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
void
|
|
<strong>initDefaultConfig</strong>
|
|
(
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Initializes the custom events for Module which are fired
|
|
automatically at appropriate times by the Module class.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="method_initEvents">initEvents</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
void
|
|
<strong>initEvents</strong>
|
|
(
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Initializes the custom events for Module which are fired
|
|
automatically at appropriate times by the Module class.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="method_initResizeMonitor">initResizeMonitor</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
void
|
|
<strong>initResizeMonitor</strong>
|
|
(
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Initialize an empty IFRAME that is placed out of the visible area
|
|
that can be used to detect text resize.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="method_onDomResize">onDomResize</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
void
|
|
<strong>onDomResize</strong>
|
|
(
|
|
|
|
|
|
e
|
|
|
|
|
|
,
|
|
obj
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Event handler fired when the resize monitor element is resized.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>e <DOMEvent></code>
|
|
The DOM resize event
|
|
</dd>
|
|
<dd>
|
|
<code>obj <Object></code>
|
|
The scope object passed to the handler
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="method_render">render</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
Boolean
|
|
<strong>render</strong>
|
|
(
|
|
|
|
|
|
appendToNode
|
|
|
|
|
|
|
|
|
|
,
|
|
moduleElement
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Renders the Module by inserting the elements that are not already
|
|
in the main Module into their correct places. Optionally appends
|
|
the Module to the specified node prior to the render's execution.
|
|
<p>
|
|
For Modules without existing markup, the appendToNode argument
|
|
is REQUIRED. If this argument is ommitted and the current element is
|
|
not present in the document, the function will return false,
|
|
indicating that the render was a failure.
|
|
</p>
|
|
<p>
|
|
NOTE: As of 2.3.1, if the appendToNode is the document's body element
|
|
then the module is rendered as the first child of the body element,
|
|
and not appended to it, to avoid Operation Aborted errors in IE when
|
|
rendering the module before window's load event is fired. You can
|
|
use the appendtodocumentbody configuration property to change this
|
|
to append to document.body if required.
|
|
</p>
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>appendToNode <String></code>
|
|
The element id to which the Module
|
|
should be appended to prior to rendering <em>OR</em>
|
|
</dd>
|
|
<dd>
|
|
<code>appendToNode <HTMLElement></code>
|
|
The element to which the Module
|
|
should be appended to prior to rendering
|
|
</dd>
|
|
<dd>
|
|
<code>moduleElement <HTMLElement></code>
|
|
OPTIONAL. The element that
|
|
represents the actual Standard Module container.
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
Boolean
|
|
</code></dt>
|
|
<dd>Success or failure of the render</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="method_setBody">setBody</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
void
|
|
<strong>setBody</strong>
|
|
(
|
|
|
|
|
|
bodyContent
|
|
|
|
|
|
|
|
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Sets the Module's body content to the HTML specified.
|
|
If no body is present, one will be automatically created.
|
|
An empty string can be passed to the method to clear the contents of the body.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>bodyContent <String></code>
|
|
The HTML used to set the body.
|
|
As a convenience, non HTMLElement objects can also be passed into
|
|
the method, and will be treated as strings, with the body innerHTML
|
|
set to their default toString implementations.
|
|
<em>OR</em>
|
|
</dd>
|
|
<dd>
|
|
<code>bodyContent <HTMLElement></code>
|
|
The HTMLElement to add as the first and only
|
|
child of the body element.
|
|
<em>OR</em>
|
|
</dd>
|
|
<dd>
|
|
<code>bodyContent <DocumentFragment></code>
|
|
The document fragment
|
|
containing elements which are to be added to the body
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="method_setFooter">setFooter</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
void
|
|
<strong>setFooter</strong>
|
|
(
|
|
|
|
|
|
footerContent
|
|
|
|
|
|
|
|
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Sets the Module's footer content to the HTML specified, or appends
|
|
the passed element to the footer. If no footer is present, one will
|
|
be automatically created. An empty string can be passed to the method
|
|
to clear the contents of the footer.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>footerContent <String></code>
|
|
The HTML used to set the footer
|
|
As a convenience, non HTMLElement objects can also be passed into
|
|
the method, and will be treated as strings, with the footer innerHTML
|
|
set to their default toString implementations.
|
|
<em>OR</em>
|
|
</dd>
|
|
<dd>
|
|
<code>footerContent <HTMLElement></code>
|
|
The HTMLElement to append to
|
|
the footer
|
|
<em>OR</em>
|
|
</dd>
|
|
<dd>
|
|
<code>footerContent <DocumentFragment></code>
|
|
The document fragment containing
|
|
elements which are to be added to the footer
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="method_setHeader">setHeader</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
void
|
|
<strong>setHeader</strong>
|
|
(
|
|
|
|
|
|
headerContent
|
|
|
|
|
|
|
|
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Sets the Module's header content to the string specified, or appends
|
|
the passed element to the header. If no header is present, one will
|
|
be automatically created. An empty string can be passed to the method
|
|
to clear the contents of the header.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>headerContent <String></code>
|
|
The string used to set the header.
|
|
As a convenience, non HTMLElement objects can also be passed into
|
|
the method, and will be treated as strings, with the header innerHTML
|
|
set to their default toString implementations.
|
|
<em>OR</em>
|
|
</dd>
|
|
<dd>
|
|
<code>headerContent <HTMLElement></code>
|
|
The HTMLElement to append to
|
|
<em>OR</em>
|
|
</dd>
|
|
<dd>
|
|
<code>headerContent <DocumentFragment></code>
|
|
The document fragment
|
|
containing elements which are to be added to the header
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="method_show">show</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
void
|
|
<strong>show</strong>
|
|
(
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Shows the Module element by setting the visible configuration
|
|
property to true. Also fires two events: beforeShowEvent prior to
|
|
the visibility change, and showEvent after.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="method_toString">toString</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
String
|
|
<strong>toString</strong>
|
|
(
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Returns a String representation of the Object.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
String
|
|
</code></dt>
|
|
<dd>The string representation of the Module</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<div class="section method details">
|
|
<h3 id="events">Events</h3>
|
|
<div class="content">
|
|
<div class="">
|
|
<h4>
|
|
<a name="event_appendEvent">appendEvent</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
<strong>appendEvent</strong>
|
|
|
|
(
|
|
)
|
|
|
|
</code>
|
|
|
|
<div class="description">
|
|
CustomEvent fired when the Module is appended to the DOM
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="event_beforeHideEvent">beforeHideEvent</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
<strong>beforeHideEvent</strong>
|
|
|
|
(
|
|
)
|
|
|
|
</code>
|
|
|
|
<div class="description">
|
|
CustomEvent fired before the Module is hidden
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="event_beforeInitEvent">beforeInitEvent</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
<strong>beforeInitEvent</strong>
|
|
|
|
(
|
|
|
|
|
|
classRef
|
|
|
|
|
|
)
|
|
|
|
</code>
|
|
|
|
<div class="description">
|
|
CustomEvent fired prior to class initalization.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>classRef <class></code>
|
|
class reference of the initializing
|
|
class, such as this.beforeInitEvent.fire(Module)
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="event_beforeRenderEvent">beforeRenderEvent</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
<strong>beforeRenderEvent</strong>
|
|
|
|
(
|
|
)
|
|
|
|
</code>
|
|
|
|
<div class="description">
|
|
CustomEvent fired before the Module is rendered
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="event_beforeShowEvent">beforeShowEvent</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
<strong>beforeShowEvent</strong>
|
|
|
|
(
|
|
)
|
|
|
|
</code>
|
|
|
|
<div class="description">
|
|
CustomEvent fired before the Module is shown
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="event_changeBodyEvent">changeBodyEvent</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
<strong>changeBodyEvent</strong>
|
|
|
|
(
|
|
|
|
|
|
content
|
|
|
|
|
|
)
|
|
|
|
</code>
|
|
|
|
<div class="description">
|
|
CustomEvent fired when the body content of the Module is modified
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>content <String/HTMLElement></code>
|
|
String/element representing
|
|
the new body content
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="event_changeContentEvent">changeContentEvent</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
<strong>changeContentEvent</strong>
|
|
|
|
(
|
|
)
|
|
|
|
</code>
|
|
|
|
<div class="description">
|
|
CustomEvent fired when the content of the Module is modified
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="event_changeFooterEvent">changeFooterEvent</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
<strong>changeFooterEvent</strong>
|
|
|
|
(
|
|
|
|
|
|
content
|
|
|
|
|
|
)
|
|
|
|
</code>
|
|
|
|
<div class="description">
|
|
CustomEvent fired when the footer content of the Module
|
|
is modified
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>content <String/HTMLElement></code>
|
|
String/element representing
|
|
the new footer content
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="event_changeHeaderEvent">changeHeaderEvent</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
<strong>changeHeaderEvent</strong>
|
|
|
|
(
|
|
|
|
|
|
content
|
|
|
|
|
|
)
|
|
|
|
</code>
|
|
|
|
<div class="description">
|
|
CustomEvent fired when the header content of the Module
|
|
is modified
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>content <String/HTMLElement></code>
|
|
String/element representing
|
|
the new header content
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="event_destroyEvent">destroyEvent</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
<strong>destroyEvent</strong>
|
|
|
|
(
|
|
)
|
|
|
|
</code>
|
|
|
|
<div class="description">
|
|
CustomEvent fired when the Module is destroyed
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="event_hideEvent">hideEvent</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
<strong>hideEvent</strong>
|
|
|
|
(
|
|
)
|
|
|
|
</code>
|
|
|
|
<div class="description">
|
|
CustomEvent fired after the Module is hidden
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="event_initEvent">initEvent</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
<strong>initEvent</strong>
|
|
|
|
(
|
|
|
|
|
|
classRef
|
|
|
|
|
|
)
|
|
|
|
</code>
|
|
|
|
<div class="description">
|
|
CustomEvent fired after class initalization.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>classRef <class></code>
|
|
class reference of the initializing
|
|
class, such as this.beforeInitEvent.fire(Module)
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="event_renderEvent">renderEvent</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
<strong>renderEvent</strong>
|
|
|
|
(
|
|
)
|
|
|
|
</code>
|
|
|
|
<div class="description">
|
|
CustomEvent fired after the Module is rendered
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="event_showEvent">showEvent</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
<strong>showEvent</strong>
|
|
|
|
(
|
|
)
|
|
|
|
</code>
|
|
|
|
<div class="description">
|
|
CustomEvent fired after the Module is shown
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="event_YAHOO.widget.Module.textResizeEvent">YAHOO.widget.Module.textResizeEvent</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
<strong>YAHOO.widget.Module.textResizeEvent</strong>
|
|
|
|
(
|
|
)
|
|
|
|
</code>
|
|
|
|
<div class="description">
|
|
Singleton CustomEvent fired when the font size is changed in the browser.
|
|
Opera's "zoom" functionality currently does not support text
|
|
size detection.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
<div class="section field details">
|
|
<h3 id="configattributes">Configuration Attributes</h3>
|
|
<div class="content">
|
|
<div class="">
|
|
<h4><a name="config_appendtodocumentbody">appendtodocumentbody</a>
|
|
<code>- Boolean</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
Specifies if the module should be rendered as the first child
|
|
of document.body or appended as the last child when render is called
|
|
with document.body as the "appendToNode".
|
|
<p>
|
|
Appending to the body while the DOM is still being constructed can
|
|
lead to Operation Aborted errors in IE hence this flag is set to
|
|
false by default.
|
|
</p>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<div class="default">
|
|
Default Value: false
|
|
</div>
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4><a name="config_effect">effect</a>
|
|
<code>- Object</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
<p>
|
|
Object or array of objects representing the ContainerEffect
|
|
classes that are active for animating the container.
|
|
</p>
|
|
<p>
|
|
<strong>NOTE:</strong> Although this configuration
|
|
property is introduced at the Module level, an out of the box
|
|
implementation is not shipped for the Module class so setting
|
|
the proroperty on the Module class has no effect. The Overlay
|
|
class is the first class to provide out of the box ContainerEffect
|
|
support.
|
|
</p>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<div class="default">
|
|
Default Value: null
|
|
</div>
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4><a name="config_monitorresize">monitorresize</a>
|
|
<code>- Boolean</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
Specifies whether to create a special proxy iframe to monitor
|
|
for user font resizing in the document
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<div class="default">
|
|
Default Value: true
|
|
</div>
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4><a name="config_visible">visible</a>
|
|
<code>- Boolean</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
Specifies whether the Module is visible on the page.
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<div class="default">
|
|
Default Value: true
|
|
</div>
|
|
|
|
<hr />
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
<div class="yui-b">
|
|
<div class="nav">
|
|
|
|
<div class="module">
|
|
<h4>Modules</h4>
|
|
<ul class="content">
|
|
|
|
<li class=""><a href="module_animation.html">animation</a></li>
|
|
|
|
<li class=""><a href="module_autocomplete.html">autocomplete</a></li>
|
|
|
|
<li class=""><a href="module_button.html">button</a></li>
|
|
|
|
<li class=""><a href="module_calendar.html">calendar</a></li>
|
|
|
|
<li class=""><a href="module_carousel.html">carousel</a></li>
|
|
|
|
<li class=""><a href="module_charts.html">charts</a></li>
|
|
|
|
<li class=""><a href="module_colorpicker.html">colorpicker</a></li>
|
|
|
|
<li class=""><a href="module_connection.html">connection</a></li>
|
|
|
|
<li class="selected"><a href="module_container.html">container</a></li>
|
|
|
|
<li class=""><a href="module_cookie.html">cookie</a></li>
|
|
|
|
<li class=""><a href="module_datasource.html">datasource</a></li>
|
|
|
|
<li class=""><a href="module_datatable.html">datatable</a></li>
|
|
|
|
<li class=""><a href="module_dom.html">dom</a></li>
|
|
|
|
<li class=""><a href="module_dragdrop.html">dragdrop</a></li>
|
|
|
|
<li class=""><a href="module_editor.html">editor</a></li>
|
|
|
|
<li class=""><a href="module_element.html">element</a></li>
|
|
|
|
<li class=""><a href="module_event.html">event</a></li>
|
|
|
|
<li class=""><a href="module_get.html">get</a></li>
|
|
|
|
<li class=""><a href="module_history.html">history</a></li>
|
|
|
|
<li class=""><a href="module_imagecropper.html">imagecropper</a></li>
|
|
|
|
<li class=""><a href="module_imageloader.html">imageloader</a></li>
|
|
|
|
<li class=""><a href="module_json.html">json</a></li>
|
|
|
|
<li class=""><a href="module_layout.html">layout</a></li>
|
|
|
|
<li class=""><a href="module_logger.html">logger</a></li>
|
|
|
|
<li class=""><a href="module_menu.html">menu</a></li>
|
|
|
|
<li class=""><a href="module_paginator.html">paginator</a></li>
|
|
|
|
<li class=""><a href="module_profiler.html">profiler</a></li>
|
|
|
|
<li class=""><a href="module_profilerviewer.html">profilerviewer</a></li>
|
|
|
|
<li class=""><a href="module_resize.html">resize</a></li>
|
|
|
|
<li class=""><a href="module_selector.html">selector</a></li>
|
|
|
|
<li class=""><a href="module_slider.html">slider</a></li>
|
|
|
|
<li class=""><a href="module_tabview.html">tabview</a></li>
|
|
|
|
<li class=""><a href="module_treeview.html">treeview</a></li>
|
|
|
|
<li class=""><a href="module_uploader.html">uploader</a></li>
|
|
|
|
<li class=""><a href="module_yahoo.html">yahoo</a></li>
|
|
|
|
<li class=""><a href="module_yuiloader.html">yuiloader</a></li>
|
|
|
|
<li class=""><a href="module_yuitest.html">yuitest</a></li>
|
|
</ul>
|
|
</div>
|
|
|
|
<div class="module">
|
|
<h4>Classes</h4>
|
|
<ul class="content">
|
|
<li class=""><a href="YAHOO.util.Config.html">YAHOO.util.Config</a></li>
|
|
<li class=""><a href="YAHOO.widget.ContainerEffect.html">YAHOO.widget.ContainerEffect</a></li>
|
|
<li class=""><a href="YAHOO.widget.Dialog.html">YAHOO.widget.Dialog</a></li>
|
|
<li class="selected"><a href="YAHOO.widget.Module.html">YAHOO.widget.Module</a></li>
|
|
<li class=""><a href="YAHOO.widget.Overlay.html">YAHOO.widget.Overlay</a></li>
|
|
<li class=""><a href="YAHOO.widget.OverlayManager.html">YAHOO.widget.OverlayManager</a></li>
|
|
<li class=""><a href="YAHOO.widget.Panel.html">YAHOO.widget.Panel</a></li>
|
|
<li class=""><a href="YAHOO.widget.SimpleDialog.html">YAHOO.widget.SimpleDialog</a></li>
|
|
<li class=""><a href="YAHOO.widget.Tooltip.html">YAHOO.widget.Tooltip</a></li>
|
|
</ul>
|
|
</div>
|
|
|
|
<div class="module">
|
|
<h4>Files</h4>
|
|
<ul class="content">
|
|
<li class=""><a href="Config.js.html">Config.js</a></li>
|
|
<li class=""><a href="ContainerEffect.js.html">ContainerEffect.js</a></li>
|
|
<li class=""><a href="Dialog.js.html">Dialog.js</a></li>
|
|
<li class=""><a href="Module.js.html">Module.js</a></li>
|
|
<li class=""><a href="Overlay.js.html">Overlay.js</a></li>
|
|
<li class=""><a href="OverlayManager.js.html">OverlayManager.js</a></li>
|
|
<li class=""><a href="Panel.js.html">Panel.js</a></li>
|
|
<li class=""><a href="SimpleDialog.js.html">SimpleDialog.js</a></li>
|
|
<li class=""><a href="Tooltip.js.html">Tooltip.js</a></li>
|
|
</ul>
|
|
</div>
|
|
|
|
<div class="module">
|
|
<h4>Properties</h4>
|
|
<ul class="content">
|
|
<li class=""><a href="#property_body">body</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li class=" deprecated"><a href="#property_browser">browser</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li class=""><a href="#property_cfg">cfg</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li class=""><a href="#property_contructor">contructor</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li class="private"><a href="#property_DEFAULT_CONFIG">DEFAULT_CONFIG</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li class=""><a href="#property_element">element</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li class="private"><a href="#property_EVENT_TYPES">EVENT_TYPES</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li class=""><a href="#property_footer">footer</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li class=""><a href="#property_header">header</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li class=""><a href="#property_id">id</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li class=" deprecated"><a href="#property_imageRoot">imageRoot</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li class=""><a href="#property_isSecure">isSecure</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li class=""><a href="#property_platform">platform</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li class=""><a href="#property_YAHOO.widget.Module.CSS_BODY">YAHOO.widget.Module.CSS_BODY</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li class=""><a href="#property_YAHOO.widget.Module.CSS_FOOTER">YAHOO.widget.Module.CSS_FOOTER</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li class=""><a href="#property_YAHOO.widget.Module.CSS_HEADER">YAHOO.widget.Module.CSS_HEADER</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li class=""><a href="#property_YAHOO.widget.Module.CSS_MODULE">YAHOO.widget.Module.CSS_MODULE</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li class=""><a href="#property_YAHOO.widget.Module.IMG_ROOT">YAHOO.widget.Module.IMG_ROOT</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li class=""><a href="#property_YAHOO.widget.Module.IMG_ROOT_SSL">YAHOO.widget.Module.IMG_ROOT_SSL</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li class=""><a href="#property_YAHOO.widget.Module.RESIZE_MONITOR_SECURE_URL">YAHOO.widget.Module.RESIZE_MONITOR_SECURE_URL</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
|
|
<div class="module">
|
|
<h4>Methods</h4>
|
|
<ul class="content">
|
|
<li class="protected"><!--<code>void</code>-->
|
|
<a href="#method__addToParent">_addToParent</a>
|
|
</li>
|
|
<li class="protected"><!--<code>void</code>-->
|
|
<a href="#method__initResizeMonitor">_initResizeMonitor</a>
|
|
</li>
|
|
<li class="private"><!--<code>void</code>-->
|
|
<a href="#method__supportsCWResize">_supportsCWResize</a>
|
|
</li>
|
|
<li class=""><!--<code>void</code>-->
|
|
<a href="#method_appendToBody">appendToBody</a>
|
|
</li>
|
|
<li class=""><!--<code>void</code>-->
|
|
<a href="#method_appendToFooter">appendToFooter</a>
|
|
</li>
|
|
<li class=""><!--<code>void</code>-->
|
|
<a href="#method_appendToHeader">appendToHeader</a>
|
|
</li>
|
|
<li class=""><!--<code>void</code>-->
|
|
<a href="#method_configMonitorResize">configMonitorResize</a>
|
|
</li>
|
|
<li class=""><!--<code>void</code>-->
|
|
<a href="#method_configVisible">configVisible</a>
|
|
</li>
|
|
<li class=""><!--<code>void</code>-->
|
|
<a href="#method_destroy">destroy</a>
|
|
</li>
|
|
<li class=""><!--<code>void</code>-->
|
|
<a href="#method_hide">hide</a>
|
|
</li>
|
|
<li class=""><!--<code>void</code>-->
|
|
<a href="#method_init">init</a>
|
|
</li>
|
|
<li class=""><!--<code>void</code>-->
|
|
<a href="#method_initDefaultConfig">initDefaultConfig</a>
|
|
</li>
|
|
<li class=""><!--<code>void</code>-->
|
|
<a href="#method_initEvents">initEvents</a>
|
|
</li>
|
|
<li class=""><!--<code>void</code>-->
|
|
<a href="#method_initResizeMonitor">initResizeMonitor</a>
|
|
</li>
|
|
<li class=""><!--<code>void</code>-->
|
|
<a href="#method_onDomResize">onDomResize</a>
|
|
</li>
|
|
<li class=""><!--<code>Boolean</code>-->
|
|
<a href="#method_render">render</a>
|
|
</li>
|
|
<li class=""><!--<code>void</code>-->
|
|
<a href="#method_setBody">setBody</a>
|
|
</li>
|
|
<li class=""><!--<code>void</code>-->
|
|
<a href="#method_setFooter">setFooter</a>
|
|
</li>
|
|
<li class=""><!--<code>void</code>-->
|
|
<a href="#method_setHeader">setHeader</a>
|
|
</li>
|
|
<li class=""><!--<code>void</code>-->
|
|
<a href="#method_show">show</a>
|
|
</li>
|
|
<li class=""><!--<code>String</code>-->
|
|
<a href="#method_toString">toString</a>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
|
|
<div class="module">
|
|
<h4>Events</h4>
|
|
<ul class="content">
|
|
<li class="">
|
|
<a href="#event_appendEvent">appendEvent</a>
|
|
</li>
|
|
<li class="">
|
|
<a href="#event_beforeHideEvent">beforeHideEvent</a>
|
|
</li>
|
|
<li class="">
|
|
<a href="#event_beforeInitEvent">beforeInitEvent</a>
|
|
</li>
|
|
<li class="">
|
|
<a href="#event_beforeRenderEvent">beforeRenderEvent</a>
|
|
</li>
|
|
<li class="">
|
|
<a href="#event_beforeShowEvent">beforeShowEvent</a>
|
|
</li>
|
|
<li class="">
|
|
<a href="#event_changeBodyEvent">changeBodyEvent</a>
|
|
</li>
|
|
<li class="">
|
|
<a href="#event_changeContentEvent">changeContentEvent</a>
|
|
</li>
|
|
<li class="">
|
|
<a href="#event_changeFooterEvent">changeFooterEvent</a>
|
|
</li>
|
|
<li class="">
|
|
<a href="#event_changeHeaderEvent">changeHeaderEvent</a>
|
|
</li>
|
|
<li class="">
|
|
<a href="#event_destroyEvent">destroyEvent</a>
|
|
</li>
|
|
<li class="">
|
|
<a href="#event_hideEvent">hideEvent</a>
|
|
</li>
|
|
<li class="">
|
|
<a href="#event_initEvent">initEvent</a>
|
|
</li>
|
|
<li class="">
|
|
<a href="#event_renderEvent">renderEvent</a>
|
|
</li>
|
|
<li class="">
|
|
<a href="#event_showEvent">showEvent</a>
|
|
</li>
|
|
<li class="">
|
|
<a href="#event_YAHOO.widget.Module.textResizeEvent">YAHOO.widget.Module.textResizeEvent</a>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
|
|
<div class="module">
|
|
<h4>Configuration Attributes</h4>
|
|
<ul class="content">
|
|
<li class="">
|
|
<a href="#config_appendtodocumentbody">appendtodocumentbody</a>
|
|
</li>
|
|
<li class="">
|
|
<a href="#config_effect">effect</a>
|
|
</li>
|
|
<li class="">
|
|
<a href="#config_monitorresize">monitorresize</a>
|
|
</li>
|
|
<li class="">
|
|
<a href="#config_visible">visible</a>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div id="ft">
|
|
<hr />
|
|
Copyright © 2008 Yahoo! Inc. All rights reserved.
|
|
</div>
|
|
</div>
|
|
</body>
|
|
</html>
|