Options
All
  • Public
  • Public/Protected
  • All
Menu

Class AbstractRippleButton

An abstract base class of clickable component (such as buttons) playing ripple effect when it is clicked.

author

shiorin, tee4cute

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

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 needFocusService

needFocusService: NeedFocusService

Protected options

options: any

Protected phloxAppService

phloxAppService: PhloxAppService

Accessors

Private app

  • Returns PhloxApp

Methods

applyI18N

  • applyI18N(value: any): void

Protected Abstract doFocus

  • doFocus($event: Event): void

  • Parameters

    • $event: Event

    Returns void

Protected Abstract doLostFocus

  • doLostFocus($event: Event): void

  • Parameters

    • $event: Event

    Returns void

Protected emitBeforeFocusEvent

  • emitBeforeFocusEvent($event?: any): void

  • Parameters

    • Optional $event: any

    Returns void

Protected emitBeforeLostFocusEvent

  • emitBeforeLostFocusEvent($event?: any): void

  • Parameters

    • Optional $event: any

    Returns void

Protected emitFocusEvent

  • emitFocusEvent($event: any): void

  • Parameters

    • $event: any

    Returns void

Protected emitLostFocusEvent

  • emitLostFocusEvent($event: any): void

  • Parameters

    • $event: any

    Returns void

getApplication

getBeforeFocusEvent

  • getBeforeFocusEvent(): EventEmitter<any>

  • Returns EventEmitter<any>

getBeforeLostFocusEvent

  • getBeforeLostFocusEvent(): EventEmitter<any>

  • Returns EventEmitter<any>

getFocusEvent

  • getFocusEvent(): EventEmitter<any>

  • Returns EventEmitter<any>

getI18NKey

  • getI18NKey(): string

getI18NValue

  • getI18NValue(): any

getLostFocusEvent

  • getLostFocusEvent(): EventEmitter<any>

  • Returns EventEmitter<any>

getOptions

  • getOptions(): any

isBypassKey

  • isBypassKey(): boolean

onClick

  • onClick(event: MouseEvent): void

  • A default implementation of click handler method which automatcially plays a ripple effect (playRippleEffect) at the position specified in event object.

    Parameters

    • event: MouseEvent

    Returns void

onFocus

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

  • Parameters

    • $event: any
    • Optional fireEvent: boolean

    Returns void

onFocusing

  • onFocusing($event: Event): void

  • Parameters

    • $event: Event

    Returns void

onLostFocus

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

  • Parameters

    • $event: any
    • Optional fireEvent: boolean

    Returns void

onLostFocusing

  • onLostFocusing($event: Event): void

  • Parameters

    • $event: Event

    Returns 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

  • Parameters

    • event: EventEmitter<any>

    Returns void

setBeforeLostFocusEvent

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

  • Parameters

    • event: EventEmitter<any>

    Returns void

setBypassKey

  • setBypassKey(bypass: boolean): void

setFocusEvent

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

  • Parameters

    • event: EventEmitter<any>

    Returns void

setI18NKey

  • setI18NKey(i18nKey: string): void

setLostFocusEvent

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

  • Parameters

    • event: EventEmitter<any>

    Returns void

setOptions

  • setOptions(options: any): void

Generated using TypeDoc