YAHOO.util.CustomEvent |
hideMaskEvent
CustomEvent fired after the modality mask is hidden
args: none
|
YAHOO.util.CustomEvent |
showMaskEvent
CustomEvent fired after the modality mask is shown
args: none
|
string |
CSS_PANEL
Constant representing the default CSS class used for a Panel
|
string |
CSS_PANEL_CONTAINER
Constant representing the default CSS class used for a Panel's wrapping container
|
class |
superclass
Reference to the Panel's superclass, Overlay
|
Class YAHOO.widget.Panel
Object | +--YAHOO.widget.Module | +--YAHOO.widget.Overlay | +--YAHOO.widget.Panel
- Direct Known Subclasses:
- YAHOO.widget.Dialog
class
YAHOO.widget.Panel
Field Summary [top]
Fields inherited from class YAHOO.widget.Overlay [top]
Fields inherited from class YAHOO.widget.Module [top]
Constructor Summary [top]
YAHOO.widget.Panel
Copyright (c) 2006, Yahoo!
Method Summary [top]
void |
buildMask
()
Builds the mask that is laid over the document when the Panel is configured to be modal.
|
void |
buildWrapper
()
Builds the wrapping container around the Panel that is used for positioning the shadow and matte underlays.
|
void |
configClose
(type, args, obj)
The default event handler fired when the "close" property is changed.
|
void |
configDraggable
(type, args, obj)
The default event handler fired when the "draggable" property is changed.
|
void |
configHeight
(type, args, obj)
The default event handler fired when the "height" property is changed.
|
void |
configKeyListeners
(type, args, obj)
|
void |
configModal
(type, args, obj)
The default event handler fired when the "modal" property is changed.
|
void |
configUnderlay
(type, args, obj)
The default event handler fired when the "underlay" property is changed.
|
void |
configWidth
(type, args, obj)
The default event handler fired when the "width" property is changed.
|
void |
hideMask
()
Hides the modality mask.
|
void |
init
(<string> <Element> el, <object> userConfig)
The Module class's initialization method, which is executed for Module and all of its subclasses.
|
void |
initDefaultConfig
()
Initializes the class's configurable properties which can be changed using the Panel's Config object (cfg).
|
void |
initEvents
()
Initializes the custom events for Module which are fired automatically at appropriate times by the Module class.
|
void |
onDomResize
(e, obj)
Event handler fired when the resize monitor element is resized.
|
void |
registerDragDrop
()
Registers the Panel's header for drag & drop capability.
|
boolean |
render
(<string> <Element> appendToNode)
Renders the Panel by inserting the elements that are not already in the main Panel into their correct places.
|
void |
showMask
()
Shows the modality mask.
|
void |
sizeMask
()
Sets the size of the modality mask to cover the entire scrollable area of the document
|
void |
sizeUnderlay
()
Adjusts the size of the shadow based on the size of the element.
|
Methods inherited from class YAHOO.widget.Overlay
Methods inherited from class YAHOO.widget.Module
Field Detail [top]
hideMaskEvent
YAHOO.util.CustomEvent
hideMaskEvent
CustomEvent fired after the modality mask is hidden
args: none
showMaskEvent
YAHOO.util.CustomEvent
showMaskEvent
CustomEvent fired after the modality mask is shown
args: none
CSS_PANEL
string
CSS_PANEL
Constant representing the default CSS class used for a Panel
CSS_PANEL_CONTAINER
string
CSS_PANEL_CONTAINER
Constant representing the default CSS class used for a Panel's wrapping container
superclass
class
superclass
Reference to the Panel's superclass, Overlay
Constructor Detail [top]
YAHOO.widget.Panel
YAHOO.widget.Panel
()
Copyright (c) 2006, Yahoo! Inc. All rights reserved.
Code licensed under the BSD License:
http://developer.yahoo.net/yui/license.txt
- Parameters:
-
el
- The element ID representing the Panel OR -
el
- The element representing the Panel -
userConfig
- The configuration object literal containing the configuration that should be set for this Panel. See configuration documentation for more details.
Method Detail [top]
buildMask
void
buildMask
()
Builds the mask that is laid over the document when the Panel is configured to be modal.
HASH(0x1db3844)
buildWrapper
void
buildWrapper
()
Builds the wrapping container around the Panel that is used for positioning the shadow and matte underlays. The container element is assigned to a local instance variable called container, and the element is reinserted inside of it.
HASH(0x1db1e58)
configClose
void
configClose
(type, args, obj)
The default event handler fired when the "close" property is changed. The method controls the appending or hiding of the close icon at the top right of the Panel.
HASH(0x1db2188)
configDraggable
void
configDraggable
(type, args, obj)
The default event handler fired when the "draggable" property is changed.
HASH(0x1db310c)
configHeight
void
configHeight
(type, args, obj)
The default event handler fired when the "height" property is changed.
HASH(0x1db3328)
configKeyListeners
void
configKeyListeners
(type, args, obj)
HASH(0x1dcdbe8)
configModal
void
configModal
(type, args, obj)
The default event handler fired when the "modal" property is changed. This handler subscribes or unsubscribes to the show and hide events to handle the display or hide of the modality mask.
HASH(0x1dce0b0)
configUnderlay
void
configUnderlay
(type, args, obj)
The default event handler fired when the "underlay" property is changed.
HASH(0x1dfcd8c)
configWidth
void
configWidth
(type, args, obj)
The default event handler fired when the "width" property is changed.
HASH(0x1dce3f8)
hideMask
void
hideMask
()
Hides the modality mask.
HASH(0x1db367c)
init
void
init
(<string> <Element> el, <object> userConfig)
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.
- Parameters:
-
el
- The element ID representing the Module OR -
el
- The element representing the Module -
userConfig
- The configuration object literal containing the configuration that should be set for this module. See configuration documentation for more details.
initDefaultConfig
void
initDefaultConfig
()
Initializes the class's configurable properties which can be changed using the Panel's Config object (cfg).
HASH(0x1db3f04)
initEvents
void
initEvents
()
Initializes the custom events for Module which are fired automatically at appropriate times by the Module class.
HASH(0x1dfd0bc)
onDomResize
void
onDomResize
(e, obj)
Event handler fired when the resize monitor element is resized.
HASH(0x1dfd1dc)
registerDragDrop
void
registerDragDrop
()
Registers the Panel's header for drag & drop capability.
HASH(0x1dfd2fc)
render
boolean
render
(<string> <Element> appendToNode)
Renders the Panel by inserting the elements that are not already in the main Panel into their correct places. Optionally appends the Panel to the specified node prior to the render's execution. NOTE: For Panels 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.
- Parameters:
-
appendToNode
- The element id to which the Module should be appended to prior to rendering OR -
appendToNode
- The element to which the Module should be appended to prior to rendering
- Returns:
- Success or failure of the render
showMask
void
showMask
()
Shows the modality mask.
HASH(0x1dfd560)
sizeMask
void
sizeMask
()
Sets the size of the modality mask to cover the entire scrollable area of the document
HASH(0x1dfd680)
sizeUnderlay
void
sizeUnderlay
()
Adjusts the size of the shadow based on the size of the element.
HASH(0x1dfd7a0)