Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ParrotsApp

Hierarchy

  • PhloxApp
    • ParrotsApp

Implements

  • INavigator<AbstractPage>
  • OnInit

Index

Constructors

Properties

Methods

Constructors

constructor

  • new ParrotsApp(router: Router, appInfoService: PhloxAppInfoService, appSvc: PhloxAppService, observableMgr: ObservableManager, needFocusService: NeedFocusService, dialogService: DialogService, parrotsLoaderService: ParrotsLoaderService, bgProcessMgr: BackgroundProcessManager, userService: UserService, connectionManager: ConnectionManager, phloxAppService: PhloxAppService, parrotsAccountService: ParrotsAccountService): ParrotsApp

  • Parameters

    • router: Router
    • appInfoService: PhloxAppInfoService
    • appSvc: PhloxAppService
    • observableMgr: ObservableManager
    • needFocusService: NeedFocusService
    • dialogService: DialogService
    • parrotsLoaderService: ParrotsLoaderService
    • bgProcessMgr: BackgroundProcessManager
    • userService: UserService
    • connectionManager: ConnectionManager
    • phloxAppService: PhloxAppService
    • parrotsAccountService: ParrotsAccountService

    Returns ParrotsApp

Properties

Private connectionManager

connectionManager: ConnectionManager

Private parrotsAccountService

parrotsAccountService: ParrotsAccountService

Private parrotsLoader

parrotsLoader: any

Private parrotsLoaderService

parrotsLoaderService: ParrotsLoaderService

Private phloxAppService

phloxAppService: PhloxAppService

Private routered

routered: Router

Private userService

userService: UserService

Static TYPE_NAME

TYPE_NAME: string

Methods

addItem

  • addItem(item: AbstractPage): boolean

  • 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

    • item: AbstractPage

    Returns boolean

containsItem

  • containsItem(item: AbstractPage): boolean

  • An implementation of [[INavigator.containsItem]] method. Please see the documentation of super class or super interface for more details.

    see

    [[INavigator.containsItem]]

    Parameters

    • item: AbstractPage

    Returns boolean

getActiveIndex

  • getActiveIndex(): number

  • Get current active page ([[AbstractPage]]) index in the array returned from getItems method.

    see

    [[INavigator.getActiveIndex]]

    Returns number

    Returns -1 if there is no current active page.

getActiveItem

  • getActiveItem(): AbstractPage

  • Get current active page ([[AbstractPage]]) object instance.

    see

    [[INavigator.getActiveItem]]

    Returns AbstractPage

    Returns null if there is no current active page.

getAppInfo

  • getAppInfo(): PhloxAppInfo

  • Get app info of currently opened application.

    Returns PhloxAppInfo

getFocusingComponent

  • getFocusingComponent(): INeedFocus

  • A delegator method passing method call to [[needFocusService]].getFocusingComponent().

    see

    [[NeedFocusService.getFocusingComponent]]

    Returns INeedFocus

getItemByIndex

  • getItemByIndex(idx: number): AbstractPage

  • An implementation of [[INavigator.getItemByIndex]] method. Please see the documentation of super class or super interface for more details.

    see

    [[INavigator.getItemByIndex]]

    Parameters

    • idx: number

    Returns AbstractPage

getItemByName

  • getItemByName(name: string): AbstractPage

  • An implementation of [[INavigator.getItemByName]] method. Please see the documentation of super class or super interface for more details.

    see

    [[INavigator.getItemByName]]

    Parameters

    • name: string

    Returns AbstractPage

getItemCount

  • getItemCount(): number

  • Get all available page count ([[AbstractPage]]) in this application.

    see

    [[INavigator.getItemCount]]

    Returns number

getItemIndex

  • getItemIndex(item: AbstractPage): number

  • An implementation of [[INavigator.getItemIndex]] method. Please see the documentation of super class or super interface for more details.

    see

    [[INavigator.getItemIndex]]

    Parameters

    • item: AbstractPage

    Returns number

getItemIndexByName

  • getItemIndexByName(name: string): number

  • An implementation of [[INavigator.getItemIndexByName]] method. Please see the documentation of super class or super interface for more details.

    see

    [[INavigator.getItemIndexByName]]

    Parameters

    • name: string

    Returns number

getItems

  • getItems(): AbstractPage[]

  • Get all available pages ([[AbstractPage]]) in this application.

    see

    [[INavigator.getItems]]

    Returns AbstractPage[]

getRouter

  • getRouter(): Router

  • Returns Router

hideDialog

  • hideDialog(): void

  • A delegator method passing method call to [[phloxDialog]].hideDialog().

    see

    [[PhloxDialog.hideDialog]]

    Returns void

hideLoader

  • hideLoader(): void

  • Returns void

isShowLoader

  • isShowLoader(): boolean

  • Returns boolean

navigateTo

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

  • An alias method of navigateToName passing page's name ([[AbstractPage.getName]]) as a parameter.

    see

    [[INavigator.navigateTo]]

    see

    navigateToName

    Parameters

    • item: AbstractPage
    • Optional options: any

    Returns Promise<boolean>

navigateToIndex

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

  • An alias method of navigateTo passing page instance at the given index (idx) as a parameter.

    see

    [[INavigator.navigateToIndex]]

    see

    navigateTo

    Parameters

    • idx: number
    • Optional options: any

    Returns 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

  • reloadAppInfo(): Promise<PhloxAppInfo>

  • Reload the app info from PhloxAppInfoService.

    Returns Promise<PhloxAppInfo>

removeItem

  • removeItem(item: AbstractPage): boolean

  • 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

    • item: AbstractPage

    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

  • A delegator method passing method call to [[needFocusService]].resetFocusingComponent().

    see

    [[NeedFocusService.resetFocusingComponent]]

    Parameters

    • Optional event: any

    Returns void

runPageLoader

  • runPageLoader(): void

  • Returns void

setFocusingComponent

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

  • A delegator method passing method call to [[needFocusService]].setFocusingComponent().

    see

    [[NeedFocusService.setFocusingComponent]]

    Parameters

    • component: INeedFocus
    • Optional event: any

    Returns void

setItems

  • setItems(items: AbstractPage[]): void

  • An implementation of [[INavigator.setItems]] method. Please see the documentation of super class or super interface for more details.

    see

    [[INavigator.setItems]]

    Parameters

    • items: AbstractPage[]

    Returns void

showComponentDialog

  • showComponentDialog(componentDialogModel: ComponentDialogModel): Promise<any>

  • A delegator method passing method call to [[phloxDialog]].showComponentDialog().

    see

    [[PhloxDialog.showComponentDialog]]

    Parameters

    • componentDialogModel: ComponentDialogModel

    Returns Promise<any>

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>

showLoader

  • showLoader(): Promise<any>

  • A delegator method passing method call to parrotsLoader.showConfirmDialog().

    see

    [[ParrotsLoader.showLoader]]

    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

Generated using TypeDoc