Options
All
  • Public
  • Public/Protected
  • All
Menu

Class AbstractNavItem

An abstract base class for nav item. A nav item must be in nav menu. This class provides a default onClick method implementation calling AbstractNavMenu.navigateTo to navigate the associated nav menu to this item when it is clicked.

author

shiorin, tee4cute

see

AbstractNavMenu

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

active

active: boolean

A flag indicating that this item is currently active or not.

Protected beforeChangeEvent

beforeChangeEvent: EventEmitter<any>

Protected beforeFocusEvent

beforeFocusEvent: EventEmitter<any>

Protected beforeLostFocusEvent

beforeLostFocusEvent: EventEmitter<any>

Protected bypass

bypass: boolean

Protected focusEvent

focusEvent: EventEmitter<any>

Protected i18nKey

i18nKey: string

Protected i18nValue

i18nValue: any

Protected lostFocusEvent

lostFocusEvent: EventEmitter<any>

Protected name

name: string

Protected navMenu

navMenu: AbstractNavMenu<AbstractNavItem>

Protected needFocusService

needFocusService: NeedFocusService

Protected options

options: any

Protected phloxAppService

phloxAppService: PhloxAppService

Methods

applyI18N

  • applyI18N(value: any): void

Protected Abstract doFocus

  • doFocus($event: Event): void

Protected Abstract doLostFocus

  • doLostFocus($event: Event): void

Protected emitBeforeFocusEvent

  • emitBeforeFocusEvent($event?: any): void

Protected emitBeforeLostFocusEvent

  • emitBeforeLostFocusEvent($event?: any): void

Protected emitFocusEvent

  • emitFocusEvent($event: any): void

Protected emitLostFocusEvent

  • emitLostFocusEvent($event: any): void

getApplication

getBeforeFocusEvent

  • getBeforeFocusEvent(): EventEmitter<any>

getBeforeLostFocusEvent

  • getBeforeLostFocusEvent(): EventEmitter<any>

getFocusEvent

  • getFocusEvent(): EventEmitter<any>

getI18NKey

  • getI18NKey(): string

getI18NValue

  • getI18NValue(): any

getLostFocusEvent

  • getLostFocusEvent(): EventEmitter<any>

getName

  • getName(): string

  • Get the name of this item.

    Returns string

getNavMenu

getOptions

  • getOptions(): any

isActive

  • isActive(): boolean

  • Getter method for active flag.

    Returns boolean

isBypassKey

  • isBypassKey(): boolean

onClick

  • onClick(event: any): void

onFocus

  • onFocus($event: any, fireEvent?: boolean): void

  • Parameters

    • $event: any
    • Optional fireEvent: boolean

    Returns void

onFocusing

  • onFocusing($event: Event): void

onLostFocus

  • onLostFocus($event: any, fireEvent?: boolean): void

  • Parameters

    • $event: any
    • Optional fireEvent: boolean

    Returns void

onLostFocusing

  • onLostFocusing($event: Event): void

playRippleEffect

  • playRippleEffect(event: MouseEvent, target?: any): Promise<any>

  • Play a ripple effect at the position specified in event object.

    Parameters

    • event: MouseEvent

      A mouse event causing the ripple effect to be played. For example, a mouse click event, etc.

    • Optional target: any

      A target DOM element to display the effect. By default, this should be an element causing an event to occur (event.target).

    Returns Promise<any>

setBeforeFocusEvent

  • setBeforeFocusEvent(event: EventEmitter<any>): void

setBeforeLostFocusEvent

  • setBeforeLostFocusEvent(event: EventEmitter<any>): void

setBypassKey

  • setBypassKey(bypass: boolean): void

setFocusEvent

  • setFocusEvent(event: EventEmitter<any>): void

setI18NKey

  • setI18NKey(i18nKey: string): void

setLostFocusEvent

  • setLostFocusEvent(event: EventEmitter<any>): void

setOptions

  • setOptions(options: any): void

Generated using TypeDoc