Skip to main content
Version: 8.1

PageNavigator class

Level: advanced

The Terrasoft.PageNavigator class manages the life cycle of the pages. The class enables opening and closing of the pages, updating of the irrelevant data and storing the page history.

Methods

forward(openingPageConfig)

Method opens page according to the properties of the openingPageConfig configuration parameter object. Main properties of this object are listed in the table.

openingPageConfig object properties

controllerName

name of the controller class

viewXType

view type according to xtype

type

page type from the Terrasoft.core.enums.PageType enumeration

modelName

name of the page model

pageSchemaName

name of the page schema in configuration

isStartPage

flag indicating that the page is a start page. If previously the pages have been opened, they will be closed

isStartRecord

flag indicating that the view/edit page should be the first after the list. If there are other opened pages after the list, they will be closed

recordId

Id of the record of the page being opened

detailConfig

settings of the standard detail

backward()

The method is closing the page.

markPreviousPagesAsDirty(operationConfig)

Method marks all previous pages as irrelevant. After returning to previous pages, the refreshDirtyData() method is called for each page. The method re-loads the data or updates the data basing on the operationConfig object.

refreshPreviousPages(operationConfig, currentPageHistoryItem)

Method re-loads data for all previous pages and updates the data basing on the operationConfig object. If the value is set for the currentPageHistoryItem parameter, the method performs the same actions for the previous pages.

refreshAllPages(operationConfig, excludedPageHistoryItems)

Method re-loads data for all pages or updates the data basing on the operationConfig object. If the excludedPageHistoryItems parameter is set, the method does not update the specified pages.