Class PageManager

constructor

• new PageManager(): PageManager

  Returns PageManager

current

pages

timeout

allPages

• get allPages(): Page[]

  return all pages that are registered in PageManager.pages

  Returns Page[]

pagesToSetup

• get pagesToSetup(): Page[]

  Returns Page[]

requestID

• get requestID(): int

  Returns int

afterPyodideLoaded

• afterPyodideLoaded(): void

  call afterPyodideLoaded on all registered Pages in PageManager.pages

  Returns void

changePage

• changePage(newPage: Page, force?: boolean, history?: boolean): Promise<void>

  Parameters

  • newPage: Page

    {Page} the page that shall be displayed
  • force: boolean = false

    {boolean} force the page change, if page is already set
  • history: boolean = true

    {boolean} adding the page to the history

  Returns Promise<void>

changePageAnimated

• changePageAnimated(newPage: Page, force?: boolean): void

  Parameters

  • newPage: Page

    {Page} the page that shall be displayed
  • force: boolean = false

    {boolean} force the page change, if page is already set

  Returns void

enableTooltips

• enableTooltips(): void

  method used to enable the tooltips on the tools page (todo: see if this can be moved to live tracking)

  Returns void

getPageDivider

• getPageDivider(id: string): HTMLHRElement

  return an HTML element that is a thin line and can be used to separate content on pages

  Parameters

  • id: string

    {string} unique id for the element in the dom, is concatenated like this: "settings-divider-" + id

  Returns HTMLHRElement

onError

• onError(): void

  method called if an error is produced in the code

  Returns void

pageReady

• pageReady(page: Page, requestID: int, intervall?: int): Promise<any>

  Parameters

  • page: Page

    {Page}
  • requestID: int

    {int} the id of the page change request, necessary to abort showing the page if another page change was requested in the meantime
  • intervall: int = 100

    {int}

  Returns Promise<any>

ready

• ready(checkFn: Function, requestID: int, interval?: int): Promise<any>

  Parameters

  • checkFn: Function

    {function}
  • requestID: int

    {int} the id of the page change request, necessary to abort showing the page if another page change was requested in the meantime
  • interval: int = 100

    {int}

  Returns Promise<any>

setColorScheme

• setColorScheme(): void

  uses window.matchMedia to determine the browser language and set the page language accordingly

  Returns void

setup

• setup(startPage?: Page): Promise<void>

  Setup simpliPFy.org

  Parameters

  • startPage: Page = ...

  Returns Promise<void>

setupEasterEggs

• setupEasterEggs(): Promise<void>

  Returns Promise<void>

showPage

• showPage(newPage: Page, history?: boolean): void

  Parameters

  • newPage: Page

    {Page} the page that shall be displayed
  • history: boolean = true

    {boolean} adding the page to the history

  Returns void

slideOut

• slideOut(fade?: int, hideOffset?: int): void

  slide out the page to the left

  Parameters

  • fade: int = 300

    {int} time the page slides out
  • hideOffset: int = 500

    {int} time that is waited to hide the page after fade is done

  Returns void

tellWhenReady

• tellWhenReady(showWhileWaiting: any, condition: any): Promise<boolean>

  shows a pages and tells when the condition is met, returns true if no page change was requested in the meantime, otherwise false

  Parameters

  • showWhileWaiting: any
  • condition: any

  Returns Promise<boolean>

updateColor

• updateColor(): void

  update the color of each registered page in PageManager.pages

  Returns void

updateLang

• updateLang(): Promise<void>

  update the language of each registered page in PageManager.pages

  Returns Promise<void>

updatePageOpacity

• updatePageOpacity(newOpacity: number, page: Page, all?: boolean): void

  Parameters

  • newOpacity: number

    {number} a number between 0 and 1, set opacity to this value
  • page: Page

    {Page} the page the opacity shall be set of, can be null if all is true
  • all: boolean = false

    {boolean} if true opacity of all pages is set to newOpacity, page value is ignored

  Returns void

waitTillReady

• waitTillReady(
      waitFor: Page,
      showWhileWaiting: Page,
      condition: () => boolean,
  ): Promise<void>

  shows a page while waiting for a condition to be true, then shows the waitFor page, returns when the waitFor page is shown, if meanwhile another page change was requested, the function returns immediately and does not show the waitFor page

  Parameters

  • waitFor: Page

    {Page}
  • showWhileWaiting: Page

    {Page}
  • condition: () => boolean

    {() => boolean}

  Returns Promise<void>