Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ChildableComponent<O, C>

Component that can have child components.

template

O type of Component's owner

template

C type of Component's children

Type parameters

Hierarchy

Implements

Index

Constructors

constructor

Properties

Private Optional _componentChildren

_componentChildren: undefined | object

Private Optional _defaultComponents

_defaultComponents: undefined | object

componentName

componentName: string

The name of this component as set by the @Component decorator.

Accessors

application

owner

  • get owner(): O

Methods

addComponent

  • addComponent<T>(name: string, componentClass: T | ComponentClass<T, O>): T

Protected bubble

getComponent

  • getComponent(name: string): C | undefined
  • Retrieve a plugin instance.

    Parameters

    • name: string

    Returns C | undefined

    The instance of the plugin or undefined if no plugin with the given class is attached.

getComponents

  • getComponents(): C[]

getOptionDeclarations

hasComponent

  • hasComponent(name: string): boolean

Protected initialize

  • initialize(): void

listenTo

listenToOnce

off

  • off(): any
  • off(eventMap: EventMap | undefined, context?: any): any
  • off(name: string | undefined, callback?: EventCallback, context?: any): any

on

  • on(eventMap: EventMap, context?: any): any
  • on(eventMap: EventMap, callback?: EventCallback, context?: any, priority?: undefined | number): any
  • on(name: string, callback: EventCallback, context?: any, priority?: undefined | number): any

once

  • once(eventMap: EventMap, context?: any): any
  • once(name: string, callback: EventCallback, context?: any, priority?: any): any
  • Bind an event to only be triggered a single time. After the first time the callback is invoked, its listener will be removed. If multiple events are passed in using the space-separated syntax, the handler will fire once for each event, not once for a combination of all events.

    Parameters

    • eventMap: EventMap
    • Optional context: any

    Returns any

  • Parameters

    • name: string
    • callback: EventCallback
    • Optional context: any
    • Optional priority: any

    Returns any

removeAllComponents

  • removeAllComponents(): void

removeComponent

  • removeComponent(name: string): C | undefined

stopListening

trigger

  • Trigger one or many events, firing all bound callbacks. Callbacks are passed the same arguments as trigger is, apart from the event name (unless you're listening on "all", which will cause your callback to receive the true name of the event as the first argument).

    Parameters

    Returns this

Generated using TypeDoc