38.9 apex.page namespace

Call to remove the handler that checks for unsaved changes. This is useful to do before any kind of cancel operation where the user is intentionally choosing to loose the changes. It is not normally necessary to call this function because the declarative attribute Warn on Unsaved Changes with value Do Not Check will do it automatically. Adding the class js-ignoreChange to a link (anchor element) or button will cause this function to be called before the link or button action.

Parameters

None.

Example

The following sets up a handler on a custom cancel button that leaves the page without checking for changes.

apex.jQuery( "#custom-cancel-button" ).click( function() {
    apex.page.cancelWarnOnUnsavedChanges();
    apex.navigation.redirect( someUrl );
});

Displays a confirmation dialog showing a message, pMessage, and depending on user's choice, submits the page setting the request value to pRequest, or does not submit the page. Once the user chooses to submit the page the behavior is the same as for the apex.page.submit function. The shorter alias for this function apex.confirm with the same parameters can also be used.

Parameters

Example

This example shows a confirmation dialog with the text 'Delete Department'. If the user chooses to proceed with the delete, the current page is submitted with a REQUEST value of 'DELETE'.

apex.page.confirm('Delete Department', 'DELETE');

or

apex.confirm('Delete Department', 'DELETE');

Displays a confirmation dialog showing a message,pMessage, and depending on user's choice, submits the page according to the options in pRequest, or does not submit the page. Once the user chooses to submit the page the behavior is the same as for the apex.page.submit function. The shorter alias for this function apex.confirm with the same parameters can also be used.

Parameters

Example

This example shows a confirmation message with the 'Save Department?' text. If the user chooses to proceed with the save, the page is submitted with a REQUEST value of 'SAVE' and 2 page item values are set, P1_DEPTNO to 10 and P1_EMPNO to 5433.

apex.page.confirm("Save Department?", {
  request:"SAVE",
  set:{"P1_DEPTNO":10, "P1_EMPNO":5433}
  });

or

apex.confirm("Save Department?", {
  request:"SAVE",
  set:{"P1_DEPTNO":10, "P1_EMPNO":5433}
  });

This function submits the page with the Application Express REQUEST value set to pRequest. The shorter alias for this function apex.submit with the same parameters can also be used. Depending on the value of the page's Reload on Submit attribute the page is submitted using ajax or with a normal form submission post request.

This function triggers a “apexbeforepagesubmit” event on the apex.gPageContext$ which can be canceled. If canceled the page is not submitted.

Just before the page is submitted this function triggers a “apexpagesubmit” event on the apex.gPageContext$ which cannot be canceled.

Parameters

Example

Submits the current page with a REQUEST value of 'DELETE'.

apex.page.submit( 'DELETE' );

or

apex.submit( 'DELETE' );

This function submits the page using the options specified in pOptions. The shorter alias for this function apex.submit with the same parameters can also be used. Depending on the value of the page's Reload on Submit attribute the page is submitted using ajax or with a normal form submission post request.

This function triggers a “apexbeforepagesubmit” event on the apex.gPageContext$ which can be canceled. If canceled the page is not submitted.

Just before the page is submitted this function triggers a “apexpagesubmit” event on the apex.gPageContext$ which cannot be canceled.

Parameters

Returns

If the submitIfEnter option is specified, a Boolean value is returned. If the ENTER key is not pressed, true is returned and if the ENTER key was pressed false is returned. If submitIfEnter is not been specified, nothing is returned.

Example

This example submits the page with a REQUEST value of 'DELETE' and 2 page item values are set, P1_DEPTNO to 10 and P1_EMPNO to 5433 . During submit a wait icon is displayed as visual indicator for the user as well.

apex.page.submit({
    request:"DELETE",
    set:{"P1_DEPTNO":10, "P1_EMPNO":5433},
    showWait: true
});

or

apex.submit({
    request:"DELETE",
    set:{"P1_DEPTNO":10, "P1_EMPNO":5433},
    showWait: true
});

Check if page items and submittable Application Express models on the page are valid. Any errors are shown inline using apex.message.showErrors function.

Parameters

None.

Returns

true if the page is valid and false otherwise.

Example

The following example checks if the page is valid when a button with id checkButton is pressed.

apex.jQuery( "#checkButton" ).click( function() {
    if ( !apex.page.validate() ) {
        alert("Please correct errors");
    }
});

Return true if any page items or Application Express models on this page have changed since last being sent to the server. This will call the pExtraIsChanged function set in apex.page.warnOnUnsavedChanges if one was supplied and only if no other changes are found first.

Parameters

None.

Returns

true if any page items or Application Express models on the page have changed and false otherwise.

Example

The following example checks if the page is changed before performing some action.

If ( apex.page.isChanged() ) {
   // do something when the page has changed
} 

Initialize a handler that checks for unsaved changes anytime the page is about to unload. This is safe to call multiple times. The pMessage and pExtraIsChanged override any previous values. This function is called automatically when the page attribute Warn on Unsaved Changes is set to yes. The main reason to call this manually is to customize the parameters.

Parameters

Example

The following example enables the warn on unsaved changes feature with a custom message.

apex.page.warnOnUnsavedChanges( "The employee record has been changed" );