This namespace contains functions related to a dialog opened with apex.navigation.dialog. All of the functions in the apex.navigation.dialog namespace need to be run in the context of the specified dialog page.
Functions
(static) cancel(pIsModal)
Closes the dialog window.
Parameters:
Name | Type | Description |
---|---|---|
pIsModal |
boolean | If true, then the dialog is identified as being modal. If false, then the dialog is identified as being non-modal. |
Example
apex.navigation.dialog.cancel( true );
(static) close(pIsModal, pActionopt)
Executes an action and then closes the dialog window.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
pIsModal |
boolean | If true, then the dialog is identified as being modal. If false, then the dialog is identified as being non-modal. | |
pAction |
string | function | Object |
<optional> |
The action can be one of the following:
|
Examples
apex.navigation.dialog.close( true, function( pDialog ) {
apex.navigation.dialog(
url,
{
title: "About",
height: "480",
width: "800",
maxWidth: "1200",
modal: true,
dialog: pDialog,
resizable: false
},
"a-Dialog--uiDialog",
$( "#mybutton_static_id" ) );
} );
apex.navigation.dialog.close( true, ["P3_EMPNO","P3_ENAME"] );
apex.navigation.dialog.close( true, { dialogPageId: 3 } );
(static) fireCloseHandler(pHandler$, pAction)
Fires the internal "close" event of a dialog which was registered with the registerCloseHandler when the dialog was opened.
Parameters:
Name | Type | Description |
---|---|---|
pHandler$ |
jQuery | A jQuery object which has been used in the call to registerCloseHandler. |
pAction |
Object | The value which is passed into the navigation.dialog.close function. |
- Deprecated:
- since version 18.2
Example
var myTriggeringElement;
myTriggeringElement = apex.jQuery( '#myButton' );
navigation.dialog.fureCloseHandler( myTriggeringElement, ["P3_EMPNO”,”P3_ENAME”] );
(static) registerCloseHandler(pOptions)
Registers the internal "close" event of a dialog. The event will be triggered by fireCloseEvent and depending on
the passed in pAction
will:
- Re-use the existing dialog and navigate to a different dialog page
- Navigate to a different page in the caller
- Cancel the dialog
- Close the dialog and trigger the "apexafterclosedialog" event
Parameters:
Name | Type | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
pOptions |
Object | Has to contain the following attributes:
Properties
|
- Deprecated:
- since version 18.2
Example
var myTriggeringElement,
myPopupWindow;
myTriggeringElement = apex.jQuery( '#myButton' );
myPopupWindow = apex.navigation.popup ( {
url: "f?p=102:2:&APP_SESSION.:::2::",
name: "Information",
scroll: "no",
resizable: "no",
toolbar: "yes"
} );
navigation.dialog.registerCloseHandler( {
handler$: myTriggeringElement,
dialog: myPopupWindow,
triggeringElement$: myTriggeringElement,
closeFunction: function() {
myPopupWindow.close();
}
});