Class Page

Static properties and methods related to the page.

Index

Constructors

Methods

addEventListener get getFormCt navigate navigateToNextPage removeEventListener scrollTo updateFormElementsDictionary

Constructors

constructor

new Page(): Page
Returns Page

Methods

`Static`addEventListener

addEventListener(
    type:
        | "sectionRendered"
        | "rendered"
        | "viewrendered"
        | "disposed"
        | "resized"
        | "scrolled"
        | "navigated"
        | "formStatusChanged"
        | "navigatedAway",
    callback: (ev: any) => void,
): void
Add an event listener to the form page.
Parameters
- type:
      | "sectionRendered"
      | "rendered"
      | "viewrendered"
      | "disposed"
      | "resized"
      | "scrolled"
      | "navigated"
      | "formStatusChanged"
      | "navigatedAway"
  Type of the event listener, defined in the PageEventsEnum.
- callback: (ev: any) => void
  A callback function
Returns void

`Static`get

get(): any
Gets the current form page.

Returns any

`Static`getFormCt

getFormCt(): HTMLElement
Returns HTMLElement

`Static`navigate

navigate(id: string): void
Navigates to a page of the form page.
Parameters
- id: string
  html element id
Returns void

`Static`navigateToNextPage

navigateToNextPage(condition?: NextPageConditionEnum): void
Navigates to next page of the form page depending of given condition. If condition is 'fullfilled' the next editable page is navigated to. If condition is 'visible' the next visible page is navigated to.
Parameters
- Optionalcondition: NextPageConditionEnum
  define if next page is navigated to depending of fullfilled or visible condition.
Returns void

`Static`removeEventListener

removeEventListener(
    type:
        | "sectionRendered"
        | "rendered"
        | "viewrendered"
        | "disposed"
        | "resized"
        | "scrolled"
        | "navigated"
        | "formStatusChanged"
        | "navigatedAway",
    callback: (ev: any) => void,
): void
Always remove previously registered event listeners!
Parameters
- type:
      | "sectionRendered"
      | "rendered"
      | "viewrendered"
      | "disposed"
      | "resized"
      | "scrolled"
      | "navigated"
      | "formStatusChanged"
      | "navigatedAway"
  Type of the event listener, defined in the PageEventsEnum.
- callback: (ev: any) => void
  A callback function.
Returns void

`Static`scrollTo

scrollTo(element: HTMLElement, duration?: number): void
Scroll to a html element on the page.
Parameters
- element: HTMLElement
- duration: number = 200
  the duration of the scrolling, default = 200;
Returns void

`Static`updateFormElementsDictionary

updateFormElementsDictionary(): void
Returns void