- Known Subclasses:
-
YAHOO.widget.Dialog
Panel is an implementation of Overlay that behaves like an OS window,
with a draggable header and an optional close icon at the top right.
Constructor
YAHOO.widget.Panel
(
el
,
userConfig
)
- Parameters:
-
el
<String>
The element ID representing the Panel OR
-
el
<HTMLElement>
The element representing the Panel
-
userConfig
<Object>
The configuration object literal containing
the configuration that should be set for this Panel. See configuration
documentation for more details.
Properties
Constant representing the Panel's configuration properties
EVENT_TYPES
- private final Object
Constant representing the name of the Panel's events
Constant representing the default CSS class used for a Panel
Constant representing the default CSS class used for a Panel's
wrapping container
body,
browser,
cfg,
contructor,
DEFAULT_CONFIG,
element,
EVENT_TYPES,
footer,
header,
id,
imageRoot,
isSecure,
platform
Methods
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. The container element is
assigned to a local instance variable called container, and the
element is reinserted inside of it.
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.
- Parameters:
-
type <String>
The CustomEvent type (usually the property name)
-
args <Object[]>
The CustomEvent arguments. For configuration
handlers, args[0] will equal the newly applied value for the property.
-
obj <Object>
The scope object. For configuration handlers,
this will usually equal the owner.
- Returns:
void
void
configDraggable
(
type
,
args
,
obj
)
The default event handler fired when the "draggable" property
is changed.
- Parameters:
-
type <String>
The CustomEvent type (usually the property name)
-
args <Object[]>
The CustomEvent arguments. For configuration
handlers, args[0] will equal the newly applied value for the property.
-
obj <Object>
The scope object. For configuration handlers,
this will usually equal the owner.
- Returns:
void
void
configHeight
(
type
,
args
,
obj
)
The default event handler fired when the "height" property is changed.
- Parameters:
-
type <String>
The CustomEvent type (usually the property name)
-
args <Object[]>
The CustomEvent arguments. For configuration
handlers, args[0] will equal the newly applied value for the property.
-
obj <Object>
The scope object. For configuration handlers,
this will usually equal the owner.
- Returns:
void
void
configKeyListeners
(
type
,
args
,
obj
)
The default event handler fired when the "keylisteners" property
is changed.
- Parameters:
-
type <String>
The CustomEvent type (usually the property name)
-
args <Object[]>
The CustomEvent arguments. For configuration
handlers, args[0] will equal the newly applied value for the property.
-
obj <Object>
The scope object. For configuration handlers,
this will usually equal the owner.
- Returns:
void
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.
- Parameters:
-
type <String>
The CustomEvent type (usually the property name)
-
args <Object[]>
The CustomEvent arguments. For configuration
handlers, args[0] will equal the newly applied value for the property.
-
obj <Object>
The scope object. For configuration handlers,
this will usually equal the owner.
- Returns:
void
void
configUnderlay
(
type
,
args
,
obj
)
The default event handler fired when the "underlay" property
is changed.
- Parameters:
-
type <String>
The CustomEvent type (usually the property name)
-
args <Object[]>
The CustomEvent arguments. For configuration
handlers, args[0] will equal the newly applied value for the property.
-
obj <Object>
The scope object. For configuration handlers,
this will usually equal the owner.
- Returns:
void
void
configWidth
(
type
,
args
,
obj
)
The default event handler fired when the "width" property is changed.
- Parameters:
-
type <String>
The CustomEvent type (usually the property name)
-
args <Object[]>
The CustomEvent arguments. For configuration
handlers, args[0] will equal the newly applied value for the property.
-
obj <Object>
The scope object. For configuration handlers,
this will usually equal the owner.
- Returns:
void
void
configzIndex
(
type
,
args
,
obj
)
The default event handler fired when the "zIndex" property is changed.
- Parameters:
-
type <String>
The CustomEvent type (usually the property name)
-
args <Object[]>
The CustomEvent arguments. For configuration
handlers, args[0] will equal the newly applied value for the property.
-
obj <Object>
The scope object. For configuration handlers,
this will usually equal the owner.
- Returns:
void
void
destroy
(
)
Removes the Panel element from the DOM and sets all child elements
to null.
void
hideMask
(
)
Hides the modality mask.
void
init
(
el
,
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 <String>
The element ID representing the Overlay OR
-
el <HTMLElement>
The element representing the Overlay
-
userConfig <Object>
The configuration object literal
containing the configuration that should be set for this Overlay.
See configuration documentation for more details.
- Returns:
void
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
registerDragDrop
(
)
Registers the Panel's header for drag & drop capability.
void
removeMask
(
)
Removes the modality mask.
boolean
render
(
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 <String>
The element id to which the Module
should be appended to prior to rendering OR
-
appendToNode <HTMLElement>
The element to which the Module
should be appended to prior to rendering
- Returns:
boolean
- Success or failure of the render
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.
void
stackMask
(
)
Sets the zindex of the mask, if it exists, based on the zindex of
the Panel element. The zindex of the mask is set to be one less
than the Panel element's zindex.
NOTE: This method will not bump up the zindex of the Panel
to ensure that the mask has a non-negative zindex. If you require the
mask zindex to be 0 or higher, the zindex of the Panel
should be set to a value higher than 0, before this method is called.
String
toString
(
)
Returns a String representation of the object.
- Returns:
String
- The string representation of the Panel.
_addToParent, appendToBody, appendToFooter, appendToHeader, configMonitorResize, configVisible, destroy, hide, init, initDefaultConfig, initEvents, initResizeMonitor, onDomResize, render, setBody, setFooter, setHeader, show, toString
align, bringToTop, center, configConstrainToViewport, configContext, configFixedCenter, configHeight, configIframe, configVisible, configWidth, configX, configXY, configY, configzIndex, destroy, doCenterOnDOMEvent, enforceConstraints, hideIframe, hideMacGeckoScrollbars, init, initDefaultConfig, initEvents, moveTo, onDomResize, showIframe, showMacGeckoScrollbars, stackIframe, syncIframe, syncPosition, toString
Events
dragEvent
(
)
CustomEvent when the Panel is dragged
hideMaskEvent
(
)
CustomEvent fired after the modality mask is hidden
showMaskEvent
(
)
CustomEvent fired after the modality mask is shown
Configuration Attributes
True if the Panel should display a "close" button
Default Value: true
Boolean specifying if the Panel should be draggable. The default
value is "true" if the Drag and Drop utility is included,
otherwise it is "false." PLEASE NOTE: There is a
known issue in IE 6 (Strict Mode and Quirks Mode) and IE 7
(Quirks Mode) where Panels that either don't have a value set for
their "width" configuration property, or their "width"
configuration property is set to "auto" will only be draggable by
placing the mouse on the text of the Panel's header element.
To fix this bug, draggable Panels missing a value for their
"width" configuration property, or whose "width" configuration
property is set to "auto" will have it set to the value of
their root HTML element's offsetWidth before they are made
visible. The calculated width is then removed when the Panel is
hidden. This fix is only applied to draggable Panels in IE 6
(Strict Mode and Quirks Mode) and IE 7 (Quirks Mode). For
more information on this issue see:
SourceForge bugs #1726972 and #1589210.
Default Value: true
keylisteners
- YAHOO.util.KeyListener[]
A KeyListener (or array of KeyListeners) that will be enabled
when the Panel is shown, and disabled when the Panel is hidden.
Default Value: null
True if the Panel should be displayed in a modal fashion,
automatically creating a transparent mask over the document that
will not be removed until the Panel is dismissed.
Default Value: false
Sets the type of underlay to display for the Panel. Valid values
are "shadow," "matte," and "none". PLEASE NOTE:
The creation of the underlay element is deferred until the Panel
is initially made visible. For Gecko-based browsers on Mac
OS X the underlay elment is always created as it is used as a
shim to prevent Aqua scrollbars below a Panel instance from poking
through it (See SourceForge bug #836476).
Default Value: shadow
Configuration attributes inherited from YAHOO.widget.Overlay:
constraintoviewport, context, fixedcenter, height, iframe, width, x, xy, y, zIndex,