JavaScript Extension Development API for Oracle Visual Builder Cloud Service - Classic Applications

Class: pages.dt/js/api/Navigation

This is a singleton object. Do not create an instance.

Navigation module provides design-time related navigation APIs for ABCS applications.

Most parts of the Navigation APIs are publicly available inside the Pages module. This module should be used for design-time work only - i.e. obtaining of the active page (Page object is known to the ABCS design-time only).

Version:
  • 16.3.5
Source:
See:
  • Pages module for the list of available public Navigation APIs
  • PageUtils module holding helper methods for Pages

Methods

getActivePage() → {pages.dt/js/api/Page|undefined}

stable API

Get the active (currently shown) page.

Unlike other public navigation methods within public Navigation API, this method provides instances of the design-time specific object Page.
Page can be used for seeking Archetypes, page's display name, its type or also its views.

Version:
  • 16.3.5
Source:
See:
  • Page class which defines the page structure
  • PageUtils module with helper methods for Pages
Returns:

active page in the Page Designer, undefined if Page Designer is not visible

Type
pages.dt/js/api/Page | undefined
Example

Example of getting active Page object information.

// getting the active page instance
var activePage = navigation.getActivePage();
// printing page's information into the console
console.log('Active page information: ' +
        'id' + page.getId() +
        'displayName=' + page.getDisplayName() +
        'pageType=' + page.getType());