Classes

Files

Class YAHOO.widget.Panel

Object
   |
   +--YAHOO.widget.Panel
class YAHOO.widget.Panel
Quick Links:  Field Summary | Constructor Summary | Method Summary | Method Details

Field Summary [top]

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 

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)
The default event handler fired when the "keylisteners" property is changed. 
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 Overlay initialization method, which is executed for Overlay 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. 
string toString ()
Returns a string representation of the object. 

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

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.
HASH(0x1d1d778)

Method Detail [top]

buildMask

void buildMask ()
Builds the mask that is laid over the document when the Panel is configured to be modal. HASH(0x1d1d340)

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(0x1da2bfc)

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(0x1d60860)

configDraggable

void configDraggable (type, args, obj)
The default event handler fired when the "draggable" property is changed. HASH(0x1da2f44)

configHeight

void configHeight (type, args, obj)
The default event handler fired when the "height" property is changed. HASH(0x1da8b6c)

configKeyListeners

void configKeyListeners (type, args, obj)
The default event handler fired when the "keylisteners" property is changed. HASH(0x1da8b84)

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(0x1da8f68)

configUnderlay

void configUnderlay (type, args, obj)
The default event handler fired when the "underlay" property is changed. HASH(0x1d608c0)

configWidth

void configWidth (type, args, obj)
The default event handler fired when the "width" property is changed. HASH(0x1da92b0)

hideMask

void hideMask ()
Hides the modality mask. HASH(0x1da9460)

init

void init (<string> <Element> el, <object> userConfig)
The Overlay initialization method, which is executed for Overlay 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 Overlay OR
el - The element representing the Overlay
userConfig - The configuration object literal containing the configuration that should be set for this Overlay. See configuration documentation for more details.
HASH(0x1da95a4)

initDefaultConfig

void initDefaultConfig ()
Initializes the class's configurable properties which can be changed using the Panel's Config object (cfg). HASH(0x1da9868)

initEvents

void initEvents ()
Initializes the custom events for Module which are fired automatically at appropriate times by the Module class. HASH(0x1d60068)

onDomResize

void onDomResize (e, obj)
Event handler fired when the resize monitor element is resized. HASH(0x1d60170)

registerDragDrop

void registerDragDrop ()
Registers the Panel's header for drag & drop capability. HASH(0x1d60350)

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
HASH(0x1d604d0)

showMask

void showMask ()
Shows the modality mask. HASH(0x1d4a3e0)

sizeMask

void sizeMask ()
Sets the size of the modality mask to cover the entire scrollable area of the document HASH(0x1da2620)

sizeUnderlay

void sizeUnderlay ()
Adjusts the size of the shadow based on the size of the element. HASH(0x1d4a7f4)

toString

string toString ()
Returns a string representation of the object. HASH(0x1d4a9b0)