Options
All
  • Public
  • Public/Protected
  • All
Menu

An abstract base class for data editor page component. A single data editor may contain one or more data views (ViewModel). All data views must manipulate with the same data set in that editor. For an instance, when a user edit data from one view and switch to another view, the data shown in the second view must always be identical the same as the first one. An editor may contain a set of actions (ActionModel) which user can perform on editor's data. For more information about creating your own editor page, please see the documentation below.

Data View

To specify the list of views in an editor, you have to provide a view provider (IDataEditorViewProvider) into editor's constructor. The editor's constructor will call IDataEditorViewProvider.getViewModels to obtain the list of data views being displayed in this editor. The concept behind data view is that to provide user the different perspectives on the same data set. For example, if you're going to build a customer data editor page, you may want to provide user a list view which allows user to easily search a customer by typing into search text box, then, it'll show customer data in tabular form. Therefore, in some sense, you may want to provide a calendar view displaying customer's birth date to the user --letting he/she to take less efforts on organizing a CRM work plan. For this kind of use, using data view, instead of building seperate pages, is the best choice to build your application.

Action

abcdef

author

shiorin, tee4cute

see

ViewModel

see

ActionModel

see

IDataEditorViewProvider

see

IDataEditorActionProvider

see

IDataServiceFactory

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Private PAGE_LOOP_TIMEOUT

PAGE_LOOP_TIMEOUT: number = 5

Protected actionModels

actionModels: ActionModel[]

Protected actionProvider

Protected bgProcessMgr

Protected bypass

bypass: boolean

Protected currentView

Protected data

data: any[]

Protected dataComparator

dataComparator: IDataComparator<any>

Protected dataCreateEvent

dataCreateEvent: EventEmitter<any>

Protected dataDeleteEvent

dataDeleteEvent: EventEmitter<any>

Protected dataQueryEvent

dataQueryEvent: EventEmitter<any>

Protected dataReloadEvent

dataReloadEvent: EventEmitter<any>

Protected dataRevertEvent

dataRevertEvent: EventEmitter<any>

Protected dataSchema

dataSchema: DataSchema

Protected dataSchemaLoadEvent

dataSchemaLoadEvent: EventEmitter<any>

Protected dataService

dataService: IDataService

Protected dataServiceFactory

dataServiceFactory: IDataServiceFactory

Protected dataUpdateEvent

dataUpdateEvent: EventEmitter<any>

Protected dialogService

dialogService: DialogService

Protected editorSetting

editorSetting: IEditorSettingService

Protected i18nKey

i18nKey: string

Protected i18nValue

i18nValue: any

Protected menuModelFactory

menuModelFactory: IMenuModelFactory

Protected options

options: any

Protected phloxAppInfo

phloxAppInfo: PhloxAppInfo

Protected phloxAppService

phloxAppService: PhloxAppInfoService

Protected query

query: any

Protected settingServiceFactory

settingServiceFactory: IEditorSettingServiceFactory

Private showViewDelayTimer

showViewDelayTimer: any

Protected viewChangeEvent

viewChangeEvent: EventEmitter<any>

Protected viewChangeHandlerFunction

viewChangeHandlerFunction: Function

Protected viewHideEvent

viewHideEvent: EventEmitter<any>

Protected viewHideHandlerFunction

viewHideHandlerFunction: Function

Protected viewModels

viewModels: ViewModel[]

Protected viewProvider

Protected viewShowEvent

viewShowEvent: EventEmitter<any>

Protected viewShowHandlerFunction

viewShowHandlerFunction: Function

Protected viewWrappers

viewWrappers: ViewWrapper[]

Protected views

Methods

Private _showView

  • Parameters

    Returns boolean

addViewComponent

addViewWrapper

  • Parameters

    Returns void

applyI18N

  • applyI18N(value: any): void

createData

  • createData(data: any): Promise<any>
  • Parameters

    • data: any

    Returns Promise<any>

createDataWithConfirmDialog

  • createDataWithConfirmDialog(data: any): Promise<any>
  • Parameters

    • data: any

    Returns Promise<any>

deleteData

  • deleteData(data: any): Promise<any>
  • Parameters

    • data: any

    Returns Promise<any>

deleteDataWithConfirmDialog

  • deleteDataWithConfirmDialog(data: any): Promise<any>
  • Parameters

    • data: any

    Returns Promise<any>

deleteSelectedData

  • deleteSelectedData(): Promise<any>
  • Returns Promise<any>

deleteSelectedDataWithConfirmDialog

  • deleteSelectedDataWithConfirmDialog(): Promise<any>
  • Returns Promise<any>

Private editData

  • editData(data: any): void
  • Parameters

    • data: any

    Returns void

getActionModels

  • Returns ActionModel[]

getAppSetting

  • getAppSetting(): any
  • Returns any

getCurrentView

getData

  • getData(): any[]
  • Returns any[]

Abstract getDataComparator

  • Returns IDataComparator<any>

getDataCreateEvent

  • getDataCreateEvent(): EventEmitter<any>
  • Returns EventEmitter<any>

getDataDeleteEvent

  • getDataDeleteEvent(): EventEmitter<any>
  • Returns EventEmitter<any>

Private getDataFromObjectId

  • getDataFromObjectId(objId: string): any
  • Parameters

    • objId: string

    Returns any

getDataQueryEvent

  • getDataQueryEvent(): EventEmitter<any>
  • Returns EventEmitter<any>

getDataReloadEvent

  • getDataReloadEvent(): EventEmitter<any>
  • Returns EventEmitter<any>

getDataRevertEvent

  • getDataRevertEvent(): EventEmitter<any>
  • Returns EventEmitter<any>

getDataSchema

  • Returns DataSchema

getDataSchemaLoadEvent

  • getDataSchemaLoadEvent(): EventEmitter<any>
  • Returns EventEmitter<any>

getDataService

  • Returns IDataService

getDataUpdateEvent

  • getDataUpdateEvent(): EventEmitter<any>
  • Returns EventEmitter<any>

getDialogService

  • Returns DialogService

getI18NKey

  • getI18NKey(): string

Private getI18NMessage

  • getI18NMessage(key: string): string
  • Parameters

    • key: string

    Returns string

getI18NObject

  • getI18NObject(key: string): any
  • Parameters

    • key: string

    Returns any

getI18NValue

  • getI18NValue(): any

getLanguageField

  • getLanguageField(): string
  • Returns string

Abstract getMenuModelFactory

getObjectIdField

  • getObjectIdField(): string
  • Returns string

getOptions

  • getOptions(): any

getQuery

  • getQuery(): any
  • Returns any

Protected getRevertData

  • getRevertData(checkData: any): any
  • Parameters

    • checkData: any

    Returns any

Private getSavePromise

  • getSavePromise(dataProm: Promise<any>): Promise<any>
  • Parameters

    • dataProm: Promise<any>

    Returns Promise<any>

getViewChangeEvent

  • getViewChangeEvent(): EventEmitter<any>
  • Returns EventEmitter<any>

getViewChangeHandler

  • getViewChangeHandler(): Function
  • Returns Function

Protected getViewComponentFromModel

getViewComponentFromType

  • Parameters

    • viewType: string

    Returns AbstractDataEditorView

getViewHideEvent

  • getViewHideEvent(): EventEmitter<any>
  • Returns EventEmitter<any>

getViewHideHandler

  • getViewHideHandler(): Function
  • Returns Function

getViewModelIndex

  • Parameters

    Returns number

getViewModels

  • Returns ViewModel[]

getViewShowEvent

  • getViewShowEvent(): EventEmitter<any>
  • Returns EventEmitter<any>

getViewShowHandler

  • getViewShowHandler(): Function
  • Returns Function

hideDialog

  • hideDialog(): void
  • Returns void

Protected initPage

  • initPage(): void
  • Returns void

isBypassKey

  • isBypassKey(): boolean

Abstract isPageLoaded

  • isPageLoaded(): boolean
  • Returns boolean

Abstract newDataObject

  • newDataObject(): any
  • Returns any

ngOnInit

  • ngOnInit(): void
  • Returns void

Protected Abstract onEditorSettingLoaded

  • onEditorSettingLoaded(settings: any): void
  • Parameters

    • settings: any

    Returns void

Private onViewChangeHandler

  • onViewChangeHandler(event: any): void
  • Parameters

    • event: any

    Returns void

Private onViewHideHandler

  • onViewHideHandler(event: any): void
  • Parameters

    • event: any

    Returns void

Private onViewShowHandler

  • onViewShowHandler(event: any): void
  • Parameters

    • event: any

    Returns void

queryData

  • queryData(queryObject: any): Promise<any>
  • Parameters

    • queryObject: any

    Returns Promise<any>

reInit

  • reInit(): void
  • Returns void

recreateDataService

  • Returns Promise<IDataService>

reloadData

  • reloadData(): Promise<any>
  • Returns Promise<any>

reloadEditorSetting

  • reloadEditorSetting(): Promise<any>
  • Returns Promise<any>

reloadViewSetting

  • reloadViewSetting(): void
  • Returns void

Protected removeData

  • removeData(data: any): boolean
  • Parameters

    • data: any

    Returns boolean

removeViewComponent

removeViewWrapper

  • Parameters

    Returns void

revertData

  • revertData(data: any): Promise<any>
  • Parameters

    • data: any

    Returns Promise<any>

revertDataWithConfirmDialog

  • revertDataWithConfirmDialog(data: any): Promise<any>
  • Parameters

    • data: any

    Returns Promise<any>

revertDirtyData

  • revertDirtyData(): Promise<any>
  • Returns Promise<any>

revertDirtyDataWithConfirmDialog

  • revertDirtyDataWithConfirmDialog(): Promise<any>
  • Returns Promise<any>

revertSelectedData

  • revertSelectedData(): Promise<any>
  • Returns Promise<any>

revertSelectedDataWithConfirmDialog

  • revertSelectedDataWithConfirmDialog(): Promise<any>
  • Returns Promise<any>

saveDirtyData

  • saveDirtyData(): Promise<any>
  • Returns Promise<any>

saveDirtyDataWithConfirmDialog

  • saveDirtyDataWithConfirmDialog(): Promise<any>
  • Returns Promise<any>

saveSelectedData

  • saveSelectedData(): Promise<any>
  • Returns Promise<any>

saveSelectedDataWithConfirmDialog

  • saveSelectedDataWithConfirmDialog(): Promise<any>
  • Returns Promise<any>

searchData

  • searchData(): Promise<any>
  • Returns Promise<any>

setActionModels

  • Parameters

    Returns void

setBypassKey

  • setBypassKey(bypass: boolean): void

setDataCreateEvent

  • setDataCreateEvent(event: EventEmitter<any>): void
  • Parameters

    • event: EventEmitter<any>

    Returns void

setDataDeleteEvent

  • setDataDeleteEvent(event: EventEmitter<any>): void
  • Parameters

    • event: EventEmitter<any>

    Returns void

setDataQueryEvent

  • setDataQueryEvent(dataQueryEvent: EventEmitter<any>): void
  • Parameters

    • dataQueryEvent: EventEmitter<any>

    Returns void

setDataReloadEvent

  • setDataReloadEvent(dataReloadEvent: EventEmitter<any>): void
  • Parameters

    • dataReloadEvent: EventEmitter<any>

    Returns void

setDataRevertEvent

  • setDataRevertEvent(event: EventEmitter<any>): void
  • Parameters

    • event: EventEmitter<any>

    Returns void

setDataSchema

  • Parameters

    Returns void

setDataSchemaLoadEvent

  • setDataSchemaLoadEvent(dataSchemaLoadEvent: EventEmitter<any>): void
  • Parameters

    • dataSchemaLoadEvent: EventEmitter<any>

    Returns void

setDataUpdateEvent

  • setDataUpdateEvent(event: EventEmitter<any>): void
  • Parameters

    • event: EventEmitter<any>

    Returns void

setI18NKey

  • setI18NKey(i18nKey: string): void

setOptions

  • setOptions(options: any): void

setQuery

  • setQuery(query: any): void
  • Parameters

    • query: any

    Returns void

setViewChangeEvent

  • setViewChangeEvent(event: EventEmitter<any>): void
  • Parameters

    • event: EventEmitter<any>

    Returns void

setViewHideEvent

  • setViewHideEvent(event: EventEmitter<any>): void
  • Parameters

    • event: EventEmitter<any>

    Returns void

setViewShowEvent

  • setViewShowEvent(event: EventEmitter<any>): void
  • Parameters

    • event: EventEmitter<any>

    Returns void

showView

  • showView(view: ViewModel): Promise<boolean>
  • Parameters

    Returns Promise<boolean>

showViewByType

  • showViewByType(viewType: string): Promise<boolean>
  • Parameters

    • viewType: string

    Returns Promise<boolean>

updateData

  • updateData(data: any): Promise<any>
  • Parameters

    • data: any

    Returns Promise<any>

updateDataWithConfirmDialog

  • updateDataWithConfirmDialog(data: any): Promise<any>
  • Parameters

    • data: any

    Returns Promise<any>

updateDirtyData

  • updateDirtyData(): Promise<any>
  • Returns Promise<any>

updateDirtyDataWithConfirmDialog

  • updateDirtyDataWithConfirmDialog(): Promise<any>
  • Returns Promise<any>

updateSelectedData

  • updateSelectedData(): Promise<any>
  • Returns Promise<any>

updateSelectedDataWithConfirmDialog

  • updateSelectedDataWithConfirmDialog(): Promise<any>
  • Returns Promise<any>

Generated using TypeDoc