Represents the Application's page object.
Page is one of the essential structural elements of the ABCS applications. The application consists of set of pages. Every Page holds created UI components in a tree structure - every page object has a top level View as a root for the whole component hierarchy in the page.
Every Page has defined PageType. Types can be stated for free designing purposes, for CRUD scenarios etc. If the page is of PageType.CREATE, PageType.EDIT or PageType.DETAILS type, the page is always bound to the specific entity then.
Methods
getDisplayName() → {Translatable}
stable API
Gets display name of the Page.
Page's display names needn't be unique. This naming is usually used for Designer purposes to address Page meaningfully to users.
- Version:
- 16.3.5
- Source:
Returns:
page's display name
- Type
- Translatable
Example
Gets display name of the active page
// gets the active page
var activePage = Navigation.getActivePage();
// will yield display name
activePage.getDisplayName();getId() → {string}
stable API
Gets ID of the Page.
This ID is unique across the whole ABCS application. So the ID as such can be used for referencing, navigation and similar purposes.
- Version:
- 16.3.5
- Source:
- See:
Returns:
page's ID
- Type
- string
Example
Gets ID of the page and uses it for navigation purposes
// we assume that you have the page instance referenced by 'page'
var pageId = page.getId();
// navigate to the particular page
Abcs.Pages().navigateToPage(pageId);getType() → {pages.dt/js/api/PageType}
stable API
Gets type of the Page (like LANDING, CREATE, EDIT, DETAIL).
PageType.CREATE, PageType.EDIT, PageType.DETAILS are the types of pages always bound to a specific BO record. PageType.LANDING type represents initially blank pages used for free designing.
- Version:
- 16.3.5
- Source:
- See:
-
- PageType for enumeration of all possible page types
Returns:
type of the page
Example
Gets type of the active page
// gets the active page
var activePage = Navigation.getActivePage();
// will yield page's type
activePage.getType();