# static class smartJ$ModalBox
{ } .

CLASS :: Smart ModalBox (ES6)
a Modal iFrame component for JavaScript / jQuery

- Language: Javascript
- Located at: lib/js/framework/smart-framework.pak.js; ifmodalbox.js
- Package: Sf.Javascript:Browser
- Class Name: smartJ$ModalBox
- Frozen: Yes
- Version: 20220730
- Usage: smartJ$ModalBox.method();
- Fires: iFrame: Show / Load / Unload / Hide
- Listens: getHandlerOnBeforeUnload() that can be set by setHandlerOnBeforeUnload(()=>{})
- Depends: jQuery, smartJ$Utils, *smartJ$Browser (optional, for scanner only)

## class Methods

public static getName = ( ) => {} . {String}
@return: {String} The name of the Modal Box
Get the Name of Smart Modal Box
public static getStatus = ( ) => {} . {String}
@return: {String} The status of the Modal Box as: 'visible' or ''
Get the Status of Smart Modal Box
public static setRefreshParent = ( {Boolean} state, {String} yURL ) => {} . {Void}
@param: {Boolean} state :: TRUE will SET / FALSE will UNSET
@param: {String} yURL the Refresh URL that will execute on destruct of the Modal Box
Set/Unset the Refresh Parent State/URL for Smart Modal Box
public static setHandlerOnBeforeUnload = ( {Function} fx ) => {} . {Boolean}
@return: {Boolean} If fx is function and set, will return TRUE else FALSE
@param: {Function} fx :: if type FUNCTION, will set the iFBoxBeforeUnload handler else will log an error
Set Per-Instance Before Unload custom Handler: ()=>{} // return true or false; }
public static function LoadURL ( {String} yURL, {Boolean} yProtect, {Integer} windowWidth, {Integer} windowHeight ) {} . {Void}
@param: {String} yURL :: the URL to be loaded ; must differ from the URL loaded in parent !
@param: {Boolean} yProtect :: default is NULL ; if TRUE will protect closing Modal Box by Escape or click outside and can be closed only by close button
@param: {Integer} windowWidth :: the width of the Modal Box
@param: {Integer} windowHeight :: the height of the Modal Box
Make the Smart Modal Box to Load a new URL ; after load will show
public static function UnloadURL ( ) {} . {Void}
Make the Smart Modal Box to Unload the URL ; after unload will hide

## class Properties

public static let param_UseProtection = false ; . {Boolean}
set [before] smartJ$Options .ModalBox.UseProtection ; [after] can be changed by setting the 2nd param of the LoadURL() method to TRUE or FALSE, will persist
get N/A
Use Protection used to allow (when TRUE) the click on overlay to close the modal

## class Constants

public static const param_LoaderImg = 'lib/js/framework/img/loading.svg' ; . {String}
set [before] smartJ$Options .ModalBox.LoaderImg
get N/A
Loader Image used to display when loading ...
public static const param_CloseImg = 'lib/js/framework/img/close.svg' ; . {String}
set [before] smartJ$Options .ModalBox.CloseImg
get N/A
Close Button Image
public static const param_CloseAlign = 'right' ; . {String}
set [before] smartJ$Options .ModalBox.CloseAlign
get N/A
Close Button Horizontal Align Mode :: 'left' or 'right'
public static const param_vAlign = 'top' ; . {String}
set [before] smartJ$Options .ModalBox.vAlign
get N/A
Close Box Vertical Align Mode :: 'top' or 'middle' / 'center'
public static const param_CssOverlayBgColor = '#333333' ; . {String}
set [before] smartJ$Options .ModalBox.CssOverlayBgColor
get N/A
Overlay Customization - Background Color
Allowed Values: hexa color between '#000000' .. '#FFFFFF'
public static const param_CssOverlayOpacity = 0.85 ; . {Float}
set [before] smartJ$Options .ModalBox.CssOverlayOpacity
get N/A
Overlay Customization - Opacity
Allowed Values: between 0 and 1

documentation generated on: 2024-12-16 17:00:46 +0000

Smart.Framework © 2009-2024 unix-world.org