Console | Client-side Webconsole base library

Provides the console related functions.

Hierarchy

Console

Constructors

constructor

new Console(): Console

- Defined in Console.ts:47
Returns Console

Properties

Private _conletFunctionRegistry

_conletFunctionRegistry: Map<string, Map<string, (conletId: string, ...args: any) => void>> = ...

Private _editTemplate

_editTemplate: HTMLElement = ...

Private _isConfigured

_isConfigured: boolean = false

Private _previewTemplate

_previewTemplate: HTMLElement = ...

Private _renderer

_renderer: null | Renderer = null

Private _resourceManager

_resourceManager: default

Private _sessionInactivityTimeout

_sessionInactivityTimeout: number = 0

Private _sessionRefreshInterval

_sessionRefreshInterval: number = 0

Private _viewTemplate

_viewTemplate: HTMLElement = ...

Private _webSocket

_webSocket: default = ...

Accessors

configured

get configured(): boolean

- Defined in Console.ts:207
Returns boolean

renderer

set renderer(renderer: Renderer): void

- Defined in Console.ts:219
Parameters
- renderer: Renderer
Returns void

sessionInactivityTimeout

get sessionInactivityTimeout(): number

- Defined in Console.ts:215
Returns number

sessionRefreshInterval

get sessionRefreshInterval(): number

- Defined in Console.ts:211
Returns number

Methods

Private _addConletProperties

_addConletProperties(properties: Map<string, string>, element: HTMLElement): void

- Defined in Console.ts:263
Parameters
- properties: Map<string, string>
- element: HTMLElement
Returns void

Private _execOnLoad

_execOnLoad(container: HTMLElement, isUpdate: boolean): void

- Defined in Console.ts:382
Parameters
- container: HTMLElement
- isUpdate: boolean
Returns void

Private _execOnUnload

_execOnUnload(element: Element, isUpdate: boolean): void

- Defined in Console.ts:402
Execute unload functions depth first.

Parameters
- element: Element
- isUpdate: boolean
Returns void

Private _removeComponents

_removeComponents(notifications: Object[], element: HTMLElement): void

- Defined in Console.ts:645
Parameters
- notifications: Object[]
- element: HTMLElement
Returns void

Private _resolveComponents

_resolveComponents(): void

- Defined in Console.ts:295
Called when the console layout is received or when a conlet has been added or updated. Attempts to resolve all unresolved components, i.e. calls {@link Console#addConlet} for the conlets that provide the missing component.

Returns void

Private _updateComponent

_updateComponent(conletType: string, conletId: string, modes: RenderMode[], content: string): void

- Defined in Console.ts:310
Parameters
- conletType: string
- conletId: string
- modes: RenderMode[]
- content: string
Returns void

Private _updatePreview

_updatePreview(conletType: string, conletId: string, modes: RenderMode[], content: string, sticky: boolean, foreground: boolean): void

- Defined in Console.ts:343
Parameters
- conletType: string
- conletId: string
- modes: RenderMode[]
- content: string
- sticky: boolean
- foreground: boolean
Returns void

Private _updateView

_updateView(conletType: string, conletId: string, modes: RenderMode[], content: string, foreground: boolean): void

- Defined in Console.ts:365
Parameters
- conletType: string
- conletId: string
- modes: RenderMode[]
- content: string
- foreground: boolean
Returns void

addConlet

addConlet(conletType: string, renderModes: RenderMode[], properties?: null | Map<string, string>): void

- Defined in Console.ts:567
Sends a notification to the server requesting the addition of a conlet.

Parameters
- conletType: string
  
  the type of the conlet to add
- renderModes: RenderMode[]
  
  the requested render mode(s), RenderMode.Foreground is automatically added
- properties: null | Map<string, string> = null
Returns void

collectConletProperties

collectConletProperties(container: HTMLElement): Map<string, string>

- Defined in Console.ts:277
Parameters
- container: HTMLElement
Returns Map<string, string>

connectionLost

connectionLost(): void

- Defined in Console.ts:226
Invokes Renderer.connectionLost.

Returns void

connectionRestored

connectionRestored(): void

- Defined in Console.ts:233
Invokes Renderer.connectionRestored.

Returns void

connectionSuspended

connectionSuspended(resume: () => void): void

- Defined in Console.ts:240
Invokes Renderer.connectionSuspended.

Parameters
- resume: () => void
  - - (): void
    - Returns void
Returns void

execOnApply

execOnApply(container: Element): void

- Defined in Console.ts:431
Invokes the functions defined in data-jgwc-on-apply attributes of the tree with root container. Must be invoked by edit dialogs when they are closed.

Parameters
- container: Element
  
  the container of the edit dialog
Returns void

findConletPreview

findConletPreview(conletId: string): null | HTMLElement

- Defined in Console.ts:479
Delegates to Renderer.findConletPreview.

Parameters
- conletId: string
Returns null | HTMLElement

findConletView

findConletView(conletId: string): null | HTMLElement

- Defined in Console.ts:493
Delegates to Renderer.findConletView.

Parameters
- conletId: string
Returns null | HTMLElement

findPreviewIds

findPreviewIds(): string[]

- Defined in Console.ts:472
Delegates to Renderer.findPreviewIds.

Returns string[]

findViewIds

findViewIds(): (null | string)[]

- Defined in Console.ts:486
Delegates to Renderer.findViewIds.

Returns (null | string)[]

init

init(consoleSessionId: string, options: { inactivityTimeout?: number; refreshInterval?: number }): void

- Defined in Console.ts:180
Starts the websocket connection to the server, invokes Renderer.init and sends the consoleReady message to the server.

Parameters
- consoleSessionId: string
  
  the session id
- options: { inactivityTimeout?: number; refreshInterval?: number }
  
  additional options
  - Optional inactivityTimeout?: number
  - Optional refreshInterval?: number
Returns void

lockMessageQueue

lockMessageQueue(): void

- Defined in Console.ts:249
Increases the lock count on the receiver. As long as the lock count is greater than 0, the invocation of handlers is suspended.

Returns void

notification

notification(content: string, options?: NotificationOptions): Notification

- Defined in Console.ts:502
Delegates to Renderer.notification.

Parameters
- content: string
- options: NotificationOptions = {}
Returns Notification
an object representing the notification

notifyConletModel

notifyConletModel(conletId: string, method: string, ...args: any[]): void

- Defined in Console.ts:695
Sends a JSON RPC notification to the server with method notifyConletModel and as parameters the given conletId, the method and the additional arguments.

Parameters
- conletId: string
  
  the id of the conlet to send to
- method: string
  
  the method to invoke
- Rest ...args: any[]
  
  additional arguments to send
Returns void

registerConletFunction

registerConletFunction(conletClass: string, functionName: string, conletFunction: (conletId: string, ...args: any[]) => void): void

- Defined in Console.ts:459
Registers a conlet function that is to be invoked when a JSON RPC notification with method notifyConletView is received from the server.

Parameters
- conletClass: string
  
  the conlet type for which the method is registered
- functionName: string
  
  the method that is registered
- conletFunction: (conletId: string, ...args: any[]) => void
  
  the function to invoke
  - - (conletId: string, ...args: any[]): void
    - Parameters
      - conletId: string
      - Rest ...args: any[]
      Returns void
Returns void

removePreview

removePreview(conletId: string): void

- Defined in Console.ts:596
Removes a conlet preview by invoking the respective methods of the associated renderer. If a view of the conlet is displayed, it will be removed, too.

After un-displaying the conlet, any "execOnUnload" functions in the conlet tree are invoked (depth first) and JSON RPC notifications with method conletDeleted and the conlet id as parameter are sent to the server for nested component conlets and the preview itself (again depth first). The notifications for the component conlets have as additional argument the collected properties.

Parameters
- conletId: string
Returns void

removeView

removeView(conletId: string): void

- Defined in Console.ts:628
Removes a conlet view by invoking the respective methods of the associated renderer.

After un-displaying the conlet, any "execOnUnload" functions in the conlet tree are invoked (depth first) and JSON RPC notifications with method conletDeleted and the conlet id as parameter are sent to the server for nested component conlets and the view itself (again depth first). The notifications for the component conlets have as additional argument the collected properties.

Parameters
- conletId: string
Returns void

renderConlet

renderConlet(conletId: string, modes: RenderMode[]): void

- Defined in Console.ts:555
Sends a notification that requests the rendering of a conlet.

Parameters
- conletId: string
  
  the conlet id
- modes: RenderMode[]
  
  the requested render mode(s)
Returns void

send

send(method: string, ...params: any[]): void

- Defined in Console.ts:529
Invokes the given method on the server.

Parameters
- method: string
- Rest ...params: any[]
  
  the parameters
Returns void

setLocale

setLocale(locale: string, reload: boolean): void

- Defined in Console.ts:545
Sends a notification for changing the language to the server.

Parameters
- locale: string
  
  the id of the selected locale
- reload: boolean
Returns void

unlockMessageQueue

unlockMessageQueue(): void

- Defined in Console.ts:257
Decreases the lock count on the receiver. When the count reaches 0, the invocation of handlers is resumed.

Returns void

updateConletModes

updateConletModes(conletId: string, modes: RenderMode[]): void

- Defined in Console.ts:517
Delegates to Renderer.updateConletModes.

Parameters
- conletId: string
- modes: RenderMode[]
Returns void

updateConletTitle

updateConletTitle(conletId: string, title: string): void

- Defined in Console.ts:510
Delegates to Renderer.updateConletTitle.

Parameters
- conletId: string
- title: string
Returns void

updateLayout

updateLayout(previewLayout: string[], tabLayout: string[], xtraInfo: Object): void

- Defined in Console.ts:679
Send the current console layout to the server.

Parameters
- previewLayout: string[]
  
  the conlet ids from top left to bottom right
- tabLayout: string[]
- xtraInfo: Object
  
  extra information spcific to the console implementation
Returns void

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns Console

Properties

Private _conletFunctionRegistry

Private _editTemplate

Private _isConfigured

Private _previewTemplate

Private _renderer

Private _resourceManager

Private _sessionInactivityTimeout

Private _sessionRefreshInterval

Private _viewTemplate

Private _webSocket

Accessors

configured

Returns boolean

renderer

Parameters

renderer: Renderer

Returns void

sessionInactivityTimeout

Returns number

sessionRefreshInterval

Returns number

Methods

Private _addConletProperties

Parameters

properties: Map<string, string>

element: HTMLElement

Returns void

Private _execOnLoad

Parameters

container: HTMLElement

isUpdate: boolean

Returns void

Private _execOnUnload

Parameters

element: Element

isUpdate: boolean

Returns void

Private _removeComponents

Parameters

notifications: Object[]

element: HTMLElement

Returns void

Private _resolveComponents

Returns void

Private _updateComponent

Parameters

conletType: string

conletId: string

modes: RenderMode[]

content: string

Returns void

Private _updatePreview

Parameters

conletType: string

conletId: string

modes: RenderMode[]

content: string

sticky: boolean

foreground: boolean

Returns void

Private _updateView

Parameters

conletType: string

conletId: string

modes: RenderMode[]

content: string

foreground: boolean

Returns void

addConlet

Parameters