Options
All
  • Public
  • Public/Protected
  • All
Menu

An abstract base class for component providing data lang selector to the user.

author

shiorin, tee4cute

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

_disabled

_disabled: boolean

Protected _loaded

_loaded: boolean

Protected bypass

bypass: boolean

Protected controller

Protected data

data: any

Protected dataChildren

dataChildren: IHasData[]

Protected dataLangList

dataLangList: any[]

Protected dataParent

dataParent: IHasData

Private defaultData

defaultData: any

Protected delegateHistory

delegateHistory: boolean

Protected dialogService

dialogService: DialogService

Protected elementRef

elementRef: ElementRef

Protected help

help: any

Protected histories

histories: UIHistory[]

Protected historyCursor

historyCursor: number

Protected i18nKey

i18nKey: string

Protected i18nValue

i18nValue: any

Protected ignoreParentData

ignoreParentData: boolean

Protected ignoreParentDisabled

ignoreParentDisabled: boolean

Protected kbShortcutService

kbShortcutService: KeyboardShortcutService

Protected langAddEvent

langAddEvent: EventEmitter<any>

Protected langClickEvent

langClickEvent: EventEmitter<any>

Protected langRemoveEvent

langRemoveEvent: EventEmitter<any>

Protected languageList

languageList: LanguageButtonModel[]

Protected loadEvent

loadEvent: EventEmitter<any>

Protected loadingEnabled

loadingEnabled: boolean

Private markCreatedLangs

markCreatedLangs: any[]

Private oldLangs

oldLangs: any[]

Protected onDisabled

onDisabled: Function

Protected onEnabled

onEnabled: Function

Protected options

options: any

Protected selectedLang

selectedLang: LanguageButtonModel

Protected showHelp

showHelp: boolean

Static DEFAULT_DELEGATE_HISTORY

DEFAULT_DELEGATE_HISTORY: boolean = DEFAULT_DELEGATE_HISTORY

Static DEFAULT_IGNORE_PARENT_DATA

DEFAULT_IGNORE_PARENT_DATA: boolean = DEFAULT_IGNORE_PARENT_DATA

Accessors

Protected disabled

  • get disabled(): boolean
  • set disabled(value: boolean): void

Methods

_getDataLangList

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

_getDefaultData

  • _getDefaultData(): any
  • Returns any

_hasButtonIcon

  • Parameters

    Returns boolean

_isDataDirtyByIndex

  • _isDataDirtyByIndex(index: number): boolean
  • Parameters

    • index: number

    Returns boolean

_isSelectedLanguageByIndex

  • _isSelectedLanguageByIndex(index: number): boolean
  • Parameters

    • index: number

    Returns boolean

_langHasDataByIndex

  • _langHasDataByIndex(index: number): boolean
  • Parameters

    • index: number

    Returns boolean

addDataChild

applyI18N

  • applyI18N(value: any): void

canRedo

  • canRedo(): boolean

canUndo

  • canUndo(): boolean

clearBackwardHistories

clearForwardHistories

clearHistories

Private createNewLang

  • createNewLang(langCode: string): any
  • Parameters

    • langCode: string

    Returns any

createNewLangWithConfirmDialog

  • createNewLangWithConfirmDialog(langCode: string): Promise<any>
  • Create a new data lang by showing confirmation dialog first. If the given language code (langCode) already exists in component data, this method will return a resolved Promise having result as data object of the corresponding language.

    Parameters

    • langCode: string

      The language code to create.

    Returns Promise<any>

    A Promise with result's value as in the following cases:

    • If DialogService is not available, returns null.
    • If the user clicks NO button, returns null.
    • If the given langCode already exists, returns data object of the corresponding language.
    • Otherwise, returns a newly created data object of the given language.

doLoaded

  • doLoaded(): void

doPreload

  • doPreload(): Promise<any>

getData

  • getData(): any

getDataChildren

Private getDataObjectByLang

  • getDataObjectByLang(langCode: string, objId?: string): any
  • Parameters

    • langCode: string
    • Optional objId: string

    Returns any

Protected Abstract getDataObjects

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

getDataParent

Protected Abstract getDefaultData

  • getDefaultData(): any
  • Returns any

    any as one object.

Private getDefaultLangData

  • getDefaultLangData(): any
  • Returns any

getElementRef

  • getElementRef(): ElementRef

getHelp

  • getHelp(): any

getHistories

getI18NKey

  • getI18NKey(): string

getI18NValue

  • getI18NValue(): any

getLangAddEvent

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

getLangClickEvent

  • getLangClickEvent(): EventEmitter<any>
  • Get output [[EventEmitter]] which will emit an event when lang button of this component is clicked.

    Returns EventEmitter<any>

getLangRemoveEvent

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

Abstract getLanguageFieldName

  • getLanguageFieldName(): string
  • Returns string

Private getLanguageIndex

  • getLanguageIndex(code: string): number
  • Parameters

    • code: string

    Returns number

getLanguageList

  • getLanguageList(): string[]
  • Returns string[]

    any as object in pattern {iconURL: string, code: string, label: string}

getLoadEvent

  • getLoadEvent(): EventEmitter<any>

getMergedLanguageList

Abstract getObjectIdFieldName

  • getObjectIdFieldName(): string
  • Returns string

getOnDisabled

  • getOnDisabled(): Function

getOnEnabled

  • getOnEnabled(): Function

getOptions

  • getOptions(): any

hasHelp

  • hasHelp(): boolean

hasLanguage

  • hasLanguage(): boolean
  • Returns boolean

Protected injectHelpStyleClass

  • injectHelpStyleClass(): void

Protected injectStyleClasses

  • injectStyleClasses(): void

isBypassKey

  • isBypassKey(): boolean

isDataDirty

  • isDataDirty(): boolean

Abstract isDataLanguageDirty

  • isDataLanguageDirty(data: any): boolean
  • Parameters

    • data: any

      as a dataLanguage

    Returns boolean

    boolean is dataLanguageDirty

Private isDataObjectsContainsLang

  • isDataObjectsContainsLang(langCode: string, objId?: string): boolean
  • Parameters

    • langCode: string
    • Optional objId: string

    Returns boolean

isDelegateHistory

  • isDelegateHistory(): boolean

isDisabled

  • isDisabled(): boolean

isDisplayHelp

  • isDisplayHelp(): boolean

isIgnoreParentData

  • isIgnoreParentData(): boolean

isIgnoreParentDisabled

  • isIgnoreParentDisabled(): boolean

isLanguageHasData

  • isLanguageHasData(code: string): boolean
  • To check that the data bound to this component having the given language code or not.

    Parameters

    • code: string

      The language code to check.

    Returns boolean

    True if there is the given language code in the data. Otherwise, returns false.

isLoadSuccess

  • isLoadSuccess(): boolean

isLoaded

  • isLoaded(): boolean

isLoadingEnabled

  • isLoadingEnabled(): boolean

isNew

  • isNew(langCode: string): boolean
  • Parameters

    • langCode: string

    Returns boolean

isSelectedLanguage

  • Parameters

    Returns boolean

isSelfDataDirty

  • isSelfDataDirty(): boolean

isSelfDisabled

  • isSelfDisabled(): boolean

isShowHelp

  • isShowHelp(): boolean

Private langTabChange

  • Parameters

    Returns void

loadDataLanguageList

  • loadDataLanguageList(defaultData: any): Promise<any[]>
  • Parameters

    • defaultData: any

      as any

    Returns Promise<any[]>

    promise that return array of dataLang object

loaded

  • loaded(success: boolean, resultOrError: any): void

makeFirstHistory

makeHistory

markLangAsCreated

  • markLangAsCreated(langCode: string): void
  • Parameters

    • langCode: string

    Returns void

ngOnDestroy

  • ngOnDestroy(): void

ngOnInit

  • ngOnInit(): void

onActionBtnClicked

  • Parameters

    Returns void

onLanguageAdded

  • onLanguageAdded(newLangData: any): void
  • when new language was created this method will be called

    Parameters

    • newLangData: any

      as any

    Returns void

onLanguageRemoved

  • onLanguageRemoved(removedData: any): void
  • when language was removed this method will be called

    Parameters

    • removedData: any

    Returns void

Abstract parseLanguageButtonModel

  • Parameters

    • langCode: string

    Returns LanguageButtonModel

preload

  • preload(): Promise<any>

redo

Private refreshDataLanguageList

  • refreshDataLanguageList(): void
  • Returns void

Private refreshLanguageList

  • refreshLanguageList(): void
  • Returns void

removeDataChild

  • removeDataChild(child: IHasData): void

removeLangWithConfirmDialog

  • removeLangWithConfirmDialog(langCode: string): Promise<any>
  • Remove data lang by showing confirmation dialog first. If the given language code (langCode) does not exist in component data, this method will return a resolved Promise having result as null.

    Parameters

    • langCode: string

      The language code to remove.

    Returns Promise<any>

    A Promise with result's value as in the following cases:

    • If DialogService is not available, returns null.
    • If the user clicks NO button, returns null.
    • If the given langCode does not exist, returns null.
    • Otherwise, returns data object of the corresponding langCode.

Private removeLanguageData

  • removeLanguageData(langCode: string): any
  • Parameters

    • langCode: string

    Returns any

resetData

  • resetData(): void

saveData

  • saveData(): void

selfResetData

  • selfResetData(): void

selfSaveData

  • selfSaveData(): void

selfValidateData

setBypassKey

  • setBypassKey(bypass: boolean): void

setController

setData

  • setData(data: any): void

setDataParent

  • setDataParent(dataParent: IHasData): void

setDelegateHistory

  • setDelegateHistory(delegate: boolean): void

setDisabled

  • setDisabled(disabled: boolean): void

setHelp

  • setHelp(help: any): void

setI18NKey

  • setI18NKey(i18nKey: string): void

setIgnoreParentData

  • setIgnoreParentData(ignore: boolean): void

setIgnoreParentDisabled

  • setIgnoreParentDisabled(ignore: boolean): void

setLangAddEvent

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

    • event: EventEmitter<any>

    Returns void

setLangClickEvent

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

    • event: EventEmitter<any>

    Returns void

setLangRemoveEvent

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

    • event: EventEmitter<any>

    Returns void

setLoadEvent

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

    • event: EventEmitter<any>

    Returns void

setOnDisabled

  • setOnDisabled(handler: Function): void

setOnEnabled

  • setOnEnabled(handler: Function): void

setOptions

  • setOptions(options: any): void

setShowHelp

  • setShowHelp(show: boolean): void

Private sortLanguageList

  • sortLanguageList(objArray: any[]): void
  • Parameters

    • objArray: any[]

    Returns void

toggleShowHelp

  • toggleShowHelp(): boolean

undo

unmarkLangAsCreated

  • unmarkLangAsCreated(langCode: string): void
  • Parameters

    • langCode: string

    Returns void

validateData

Generated using TypeDoc