Options
All
  • Public
  • Public/Protected
  • All
Menu

A main bootstrap component class for PhloxUI application. This class implements the INavigator interface having pages (AbstractPage) as navigatee items (INavigatee). An application may consist of various pages, for example, it may have a login page to allow the user to login, once the user is logged on, it will navigate the user to the main page, etc.

author

shiorin, tee4cute

Hierarchy

  • PhloxApp

Implements

Index

Constructors

constructor

Properties

Private _showLoader

_showLoader: boolean

Private appInfo

appInfo: PhloxAppInfo

A field keeping cache for the last successfully loaded PhloxAppInfo from method reloadAppInfo.

Private appInfoService

appInfoService: PhloxAppInfoService

This field will be automatically injected by ng.

Private barloader

Private bgProcessMgr

This field will be automatically injected by ng.

Private dialogService

dialogService: DialogService

This field will be automatically injected by ng.

Private needFocusService

needFocusService: NeedFocusService

This field will be automatically injected by ng.

Private observableMgr

observableMgr: ObservableManager

This field will be automatically injected by ng.

Private pages

pages: AbstractPage[]

An array keeping all pages of this application.

Private phloxDialog

phloxDialog: any

A PhloxDialog child component instance of this component.

Private router

router: Router

This field will be automatically injected by ng.

Static TYPE_NAME

TYPE_NAME: string = TYPE_NAME

Methods

addItem

  • Add a new page (AbstractPage) into this application. If the page (item) being added is the first page of this application, this method will automatically show the given page and set its active flag to true.

    see

    INavigator.addItem

    Parameters

    Returns boolean

containsItem

getActiveIndex

  • getActiveIndex(): number

getActiveItem

getAppInfo

  • Get app info of currently opened application.

    Returns PhloxAppInfo

getFocusingComponent

getItemByIndex

getItemByName

getItemCount

  • getItemCount(): number

getItemIndex

getItemIndexByName

  • getItemIndexByName(name: string): number

getItems

getRouter

  • getRouter(): Router
  • Returns Router

hideDialog

  • hideDialog(): void

isShowLoader

  • isShowLoader(): boolean
  • Returns boolean

navigateTo

  • navigateTo(item: AbstractPage, options?: any): Promise<boolean>

navigateToIndex

  • navigateToIndex(idx: number, options?: any): Promise<boolean>

navigateToName

  • navigateToName(name: string, options?: any): Promise<boolean>
  • Navigate this application to the given page name. The page name is also a router's uri path specified in [[PHLOX_ROUTES]].

    see

    INavigator.navigateToName

    see

    [[PHLOX_ROUTES]]

    Parameters

    • name: string
    • Optional options: any

    Returns Promise<boolean>

ngOnInit

  • ngOnInit(): void
  • Returns void

reloadAppInfo

  • Reload the app info from PhloxAppInfoService.

    Returns Promise<PhloxAppInfo>

removeItem

  • Remove the given page (AbstractPage) from this application. If the page (item) being removed is currently active, this method will automatically unset its active flag and show the first page (if available) in the array returned from getItems method instead.

    see

    INavigator.removeItem

    Parameters

    Returns boolean

reset

  • reset(): void
  • Try to navigate this application back to the first page.

    see

    INavigator.reset

    Returns void

resetFocusingComponent

  • resetFocusingComponent(event?: any): void

runPageLoader

  • runPageLoader(): void
  • Returns void

setFocusingComponent

  • setFocusingComponent(component: INeedFocus, event?: any): void

setItems

showComponentDialog

showConfirmDialog

  • showConfirmDialog(title: string, message: string, showCancelBtn: boolean, width?: string, height?: string): Promise<any>
  • A delegator method passing method call to phloxDialog.showConfirmDialog().

    see

    PhloxDialog.showConfirmDialog

    Parameters

    • title: string
    • message: string
    • showCancelBtn: boolean
    • Optional width: string
    • Optional height: string

    Returns Promise<any>

showMessageDialog

  • showMessageDialog(title: string, message: string, width?: string, height?: string): Promise<any>
  • A delegator method passing method call to phloxDialog.showMessageDialog().

    see

    PhloxDialog.showMessageDialog

    Parameters

    • title: string
    • message: string
    • Optional width: string
    • Optional height: string

    Returns Promise<any>

stopPageLoader

  • stopPageLoader(): void
  • Returns void

Object literals

Private curRouterLoading

curRouterLoading: object

path

path: null = null

reject

reject: null = null

resolve

resolve: null = null

Generated using TypeDoc