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
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
onDomResize
(
e
,
obj
)
Event handler fired when the resize monitor element is resized.
- Parameters:
-
e <DOMEvent>
The resize DOM event
-
obj <Object>
The scope object
- Returns:
void
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.
String
toString
(
)
Returns a String representation of the object.
- Returns:
String
- The string representation of the Panel.