Class Console

Provides the console related functions.

Hierarchy

Console

Index

Constructors

Properties

_conletFunctionRegistry _connectionInactivityTimeout _connectionRefreshInterval _dialogIdCounter _isConfigured _modalDialogTemplate _pageComponentCounter _previewTemplate _renderer _resourceManager _viewTemplate _webSocket

Accessors

configured connectionInactivityTimeout connectionRefreshInterval renderer

Constructors

constructor

new Console(): Console
Returns Console
- Defined in Console.ts:56

Properties

`Private` _conletFunctionRegistry

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

`Private` _connectionInactivityTimeout

_connectionInactivityTimeout: number = 0

`Private` _connectionRefreshInterval

_connectionRefreshInterval: number = 0

`Private` _dialogIdCounter

_dialogIdCounter: number = 0

`Private` _isConfigured

_isConfigured: boolean = false

`Private` _modalDialogTemplate

_modalDialogTemplate: HTMLElement = ...

`Private` _pageComponentCounter

_pageComponentCounter: number = 0

`Private` _previewTemplate

_previewTemplate: HTMLElement = ...

`Private` _renderer

_renderer: null | Renderer = null

`Private` _resourceManager

_resourceManager: ResourceManager

`Private` _viewTemplate

_viewTemplate: HTMLElement = ...

`Private` _webSocket

_webSocket: ConsoleWebSocket = ...

Accessors

configured

get configured(): boolean
Returns boolean
- Defined in Console.ts:245

connectionInactivityTimeout

get connectionInactivityTimeout(): number
Returns number
- Defined in Console.ts:253

connectionRefreshInterval

get connectionRefreshInterval(): number
Returns number
- Defined in Console.ts:249

renderer

set renderer(renderer: Renderer): void
Parameters
- renderer: Renderer
Returns void
- Defined in Console.ts:257

Methods

`Private` _addConletProperties

_addConletProperties(properties: Map<string, string>, element: HTMLElement): void
Parameters
- properties: Map<string, string>
- element: HTMLElement
Returns void
- Defined in Console.ts:317

`Private` _execOnLoad

_execOnLoad(container: HTMLElement, isUpdate: boolean): void
Parameters
- container: HTMLElement
- isUpdate: boolean
Returns void
- Defined in Console.ts:438

`Private` _execOnUnload

_execOnUnload(element: Element, isUpdate: boolean): void
Execute unload functions depth first.
Parameters
- element: Element
- isUpdate: boolean
Returns void
- Defined in Console.ts:458

`Private` _removeEmbedded

_removeEmbedded(notifications: Object[], conlet: Conlet): void
Parameters
- notifications: Object[]
- conlet: Conlet
Returns void
- Defined in Console.ts:704

`Private` _resolveComponents

_resolveComponents(): void
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 addConlet for the conlets that provide the missing component.

Returns void
- Defined in Console.ts:337

`Private` _updateContent

_updateContent(conletType: string, conletId: string, modes: RenderMode[], contentString: string): void
Parameters
- conletType: string
- conletId: string
- modes: RenderMode[]
- contentString: string
Returns void
- Defined in Console.ts:354

`Private` _updatePreview

_updatePreview(conletType: string, conletId: string, modes: RenderMode[], content: string, sticky: boolean, foreground: boolean): void
Parameters
- conletType: string
- conletId: string
- modes: RenderMode[]
- content: string
- sticky: boolean
- foreground: boolean
Returns void
- Defined in Console.ts:397

`Private` _updateView

_updateView(conletType: string, conletId: string, modes: RenderMode[], content: string, foreground: boolean): void
Parameters
- conletType: string
- conletId: string
- modes: RenderMode[]
- content: string
- foreground: boolean
Returns void
- Defined in Console.ts:420

addConlet

addConlet(conletType: string, renderModes: RenderMode[], properties?: null | Map<string, string>): void
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), Foreground is automatically added
- properties: null | Map<string, string> = null
Returns void
- Defined in Console.ts:627

collectConletProperties

collectConletProperties(conlet: Conlet): Map<string, string>
Parameters
- conlet: Conlet
Returns Map<string, string>
- Defined in Console.ts:301

connectionLost

connectionLost(): void
Invokes connectionLost.

Returns void
- Defined in Console.ts:264

connectionRestored

connectionRestored(): void
Invokes connectionRestored.

Returns void
- Defined in Console.ts:271

connectionSuspended

connectionSuspended(resume: (() => void)): void
Invokes connectionSuspended.
Parameters
- resume: (() => void)
  - - (): void
    - Returns void
Returns void
- Defined in Console.ts:278

execOnAction

execOnAction(container: HTMLElement, apply: boolean, close: boolean): void
Invokes the functions defined in data-jgwc-on-action attributes of the tree with root container. If close is true also executes the "on unload" functions. Must be invoked by edit or modal dialogs when they are closed.

Returns
true if the dialog should be closed
Parameters
- container: HTMLElement
  
  the container of the edit dialog
- apply: boolean
- close: boolean
Returns void
- Defined in Console.ts:489

findConletContents

findConletContents(conletId?: string): Conlet[]
Delegates to findConletContents.
Parameters
- Optional conletId: string
Returns Conlet[]
- Defined in Console.ts:553

findConletPreview

findConletPreview(conletId: string): null | Conlet
Delegates to findConletPreview.
Parameters
- conletId: string
Returns null | Conlet
- Defined in Console.ts:539

findConletView

findConletView(conletId: string): null | Conlet
Delegates to findConletView.
Parameters
- conletId: string
Returns null | Conlet
- Defined in Console.ts:560

findPreviews

findPreviews(): Conlet[]
Delegates to findPreviews.

Returns Conlet[]
- Defined in Console.ts:532

findViews

findViews(): Conlet[]
Delegates to findViews.

Returns Conlet[]
- Defined in Console.ts:546

init

init(connectionId: string, options: {
inactivityTimeout?: number;
refreshInterval?: number;
}): void
Starts the websocket connection to the server, invokes init and sends the consoleReady message to the server.
Parameters
- connectionId: string
  
  the connection id
- options: {
  inactivityTimeout?: number;
  refreshInterval?: number;
  }
  
  additional options
  - Optional inactivityTimeout?: number
  - Optional refreshInterval?: number
Returns void
- Defined in Console.ts:217

lockMessageQueue

lockMessageQueue(): void
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
- Defined in Console.ts:287

notification

notification(content: string, options?: NotificationOptions): Notification
Delegates to notification.

Returns
an object representing the notification
Parameters
- content: string
- options: NotificationOptions = {}
Returns Notification
- Defined in Console.ts:569

notifyConletModel

notifyConletModel(conletId: string, method: string, ...args: any[]): void
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
- Defined in Console.ts:740

registerConletFunction

registerConletFunction(conletClass: string, functionName: string, conletFunction: ((conletId: string, ...args: any[]) => void)): void
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
- Defined in Console.ts:519

removePreview

removePreview(conletId: string): void
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
- Defined in Console.ts:656

removeView

removeView(conletId: string): void
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
- Defined in Console.ts:691

renderConlet

renderConlet(conletId: string, modes: RenderMode[]): void
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
- Defined in Console.ts:615

send

send(method: string, ...params: any[]): void
Invokes the given method on the server.
Parameters
- method: string
- Rest ...params: any[]
  
  the parameters
Returns void
- Defined in Console.ts:596

setLocale

setLocale(locale: string, reload: boolean): void
Sends a notification for changing the language to the server.
Parameters
- locale: string
  
  the id of the selected locale
- reload: boolean
Returns void
- Defined in Console.ts:605

unlockMessageQueue

unlockMessageQueue(): void
Decreases the lock count on the receiver. When the count reaches 0, the invocation of handlers is resumed.

Returns void
- Defined in Console.ts:295

updateConletModes

updateConletModes(conletId: string, modes: RenderMode[]): void
Delegates to updateConletModes.
Parameters
- conletId: string
- modes: RenderMode[]
Returns void
- Defined in Console.ts:584

updateConletTitle

updateConletTitle(conletId: string, title: string): void
Delegates to updateConletTitle.
Parameters
- conletId: string
- title: string
Returns void
- Defined in Console.ts:577

updateLayout

updateLayout(previewLayout: string[], tabLayout: string[], xtraInfo: Object): void
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
- Defined in Console.ts:724

Class Console

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns Console

Properties

Private _conletFunctionRegistry

Private _connectionInactivityTimeout

Private _connectionRefreshInterval

Private _dialogIdCounter

Private _isConfigured

Private _modalDialogTemplate

Private _pageComponentCounter

Private _previewTemplate

Private _renderer

Private _resourceManager

Private _viewTemplate

Private _webSocket

Accessors

configured

Returns boolean

connectionInactivityTimeout

Returns number

connectionRefreshInterval

Returns number

renderer

Parameters

renderer: Renderer

Returns void

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 _removeEmbedded

Parameters

notifications: Object[]

conlet: Conlet

Returns void

Private _resolveComponents

Returns void

Private _updateContent

Parameters

conletType: string

conletId: string

modes: RenderMode[]

contentString: 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

`Private` _conletFunctionRegistry

`Private` _connectionInactivityTimeout

`Private` _connectionRefreshInterval

`Private` _dialogIdCounter

`Private` _isConfigured

`Private` _modalDialogTemplate

`Private` _pageComponentCounter

`Private` _previewTemplate

`Private` _renderer

`Private` _resourceManager

`Private` _viewTemplate

`Private` _webSocket

`Private` _addConletProperties

`Private` _execOnLoad

`Private` _execOnUnload

`Private` _removeEmbedded

`Private` _resolveComponents

`Private` _updateContent

`Private` _updatePreview

`Private` _updateView

`Optional` conletId: string

options: {
inactivityTimeout?: number;
refreshInterval?: number;
}

`Optional` inactivityTimeout?: number

`Optional` refreshInterval?: number

`Rest` ...args: any[]