Options
All
  • Public
  • Public/Protected
  • All
Menu

Group the ToC for easier observability.

Hierarchy

  • RendererComponent
    • SdkClientTocPlugin

Implements

  • ComponentHost

Index

Constructors

constructor

  • new SdkClientTocPlugin(owner: Renderer | typeof DUMMY_APPLICATION_OWNER): SdkClientTocPlugin

Properties

Private Optional clientDir

clientDir: string

Private Optional clientsNavigationItem

clientsNavigationItem: NavigationItem

Private Optional commandsNavigationItem

commandsNavigationItem: NavigationItem

componentName

componentName: string

Private Optional paginatorsNavigationItem

paginatorsNavigationItem: NavigationItem

Private Optional waitersNavigationItem

waitersNavigationItem: NavigationItem

Accessors

application

  • get application(): Application

owner

  • get owner(): Renderer

Methods

Private belongsToClientPackage

  • belongsToClientPackage(model: DeclarationReflection): boolean

Protected bubble

  • bubble(name: Event | EventMap | string, ...args: any[]): this
  • Parameters

    • name: Event | EventMap | string
    • Rest ...args: any[]

    Returns this

buildToc

  • buildToc(model: Reflection, trail: Reflection[], parent: NavigationItem, restriction?: string[]): void
  • Create a toc navigation item structure.

    Parameters

    • model: Reflection

      The models whose children should be written to the toc.

    • trail: Reflection[]

      Defines the active trail of expanded toc entries.

    • parent: NavigationItem

      The parent [[NavigationItem]] the toc should be appended to.

    • Optional restriction: string[]

      The restricted table of contents.

    Returns void

getOptionDeclarations

  • getOptionDeclarations(): DeclarationOption[]

initialize

  • initialize(): void

Private isClient

  • isClient(model: DeclarationReflection): boolean

Private isCommand

  • isCommand(model: DeclarationReflection): boolean

Private isInputOrOutput

  • isInputOrOutput(model: DeclarationReflection): boolean

Private isPaginator

  • isPaginator(model: DeclarationReflection): boolean

Private isWaiter

  • isWaiter(model: DeclarationReflection): boolean

listenTo

  • listenTo(obj: EventDispatcher, name: EventMap | string, callback?: EventCallback, priority?: number): this
  • Parameters

    • obj: EventDispatcher
    • name: EventMap | string
    • Optional callback: EventCallback
    • Optional priority: number

    Returns this

listenToOnce

  • listenToOnce(obj: EventDispatcher, eventMap: EventMap): any
  • listenToOnce(obj: EventDispatcher, name: string, callback: EventCallback, priority?: number): any
  • Parameters

    • obj: EventDispatcher
    • eventMap: EventMap

    Returns any

  • Parameters

    • obj: EventDispatcher
    • name: string
    • callback: EventCallback
    • Optional priority: number

    Returns any

Private loadClientDir

  • loadClientDir(model: Reflection): string

off

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

  • Parameters

    • eventMap: EventMap | undefined
    • Optional context: any

    Returns any

  • Parameters

    • name: string | undefined
    • Optional callback: EventCallback
    • Optional context: any

    Returns any

on

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

    • eventMap: EventMap
    • Optional context: any

    Returns any

  • Parameters

    • eventMap: EventMap
    • Optional callback: EventCallback
    • Optional context: any
    • Optional priority: number

    Returns any

  • Parameters

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

    Returns any

Private onRendererBeginPage

  • onRendererBeginPage(page: PageEvent): void

once

  • once(eventMap: EventMap, context?: any): any
  • once(name: string, callback: EventCallback, context?: any, priority?: any): any
  • Parameters

    • eventMap: EventMap
    • Optional context: any

    Returns any

  • Parameters

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

    Returns any

stopListening

  • stopListening(obj?: EventDispatcher, name?: EventMap | string, callback?: EventCallback): this
  • Parameters

    • Optional obj: EventDispatcher
    • Optional name: EventMap | string
    • Optional callback: EventCallback

    Returns this

trigger

  • trigger(name: Event | EventMap | string, ...args: any[]): this
  • Parameters

    • name: Event | EventMap | string
    • Rest ...args: any[]

    Returns this