Class Console

Provides the console related functions.

Constructors

constructor

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

Accessors

configured

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

connectionInactivityTimeout

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

connectionRefreshInterval

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

renderer

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

Methods

addConlet

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

closeModalDialog

closeModalDialog(_conletType: string, conletId: string): void
Closes the modal dialog that has been opened by the conlet with the given id.
Parameters
- _conletType: string
  the conlet's type
- conletId: string
  the conlet's id
Returns void
- Defined in Console.ts:549

collectConletProperties

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

connectionLost

connectionLost(): void
Invokes Renderer.connectionLost.

Returns void
- Defined in Console.ts:257

connectionRestored

connectionRestored(): void
Invokes Renderer.connectionRestored.

Returns void
- Defined in Console.ts:264

connectionSuspended

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

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.
Parameters
- container: HTMLElement
  the container of the edit dialog
- apply: boolean
- close: boolean
Returns void
true if the dialog should be closed
- Defined in Console.ts:567

findConletContents

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

findConletPreview

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

findConletView

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

findPreviews

findPreviews(): Conlet[]
Delegates to Renderer.findPreviews.

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

findViews

findViews(): Conlet[]
Delegates to Renderer.findViews.

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

init

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

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

notification

notification(content: string, options?: NotificationOptions): Notification
Delegates to Renderer.notification.
Parameters
- content: string
- options: NotificationOptions = {}
Returns Notification
an object representing the notification
- Defined in Console.ts:647

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
- ...args: any[]
  additional arguments to send
Returns void
- Defined in Console.ts:820

openModalDialog

openModalDialog(
    conletType: string,
    conletId: string,
    content: string,
    options: ModalDialogOptions,
): void
Opens a modal dialog related to the conlet with the given type and id.
Parameters
- conletType: string
  the opening conlet's type
- conletId: string
  the opening conlet's id
- content: string
  the dialog's content as HTML
- options: ModalDialogOptions
  the dialog options
Returns void
- Defined in Console.ts:515

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
Returns void
- Defined in Console.ts:597

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 conletsDeleted 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
  the conlet id
Returns void
- Defined in Console.ts:734

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 conletsDeleted 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
  the conlet id
Returns void
- Defined in Console.ts:769

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

send

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

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

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

updateConletModes

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

updateConletTitle

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

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[]
  the ids of the conlets viewable in tabs
- xtraInfo: Object
  extra information spcific to the console implementation
Returns void
- Defined in Console.ts:804

whenLocaleChanged

whenLocaleChanged(callback: (locale: string) => void): () => void
Registers a callback to be invoked when the locale changes.
Parameters
- callback: (locale: string) => void
Returns () => void
- Defined in Console.ts:471

Class Console

Index

Constructors

Accessors

Methods

Constructors

constructor

Returns Console

Accessors

configured

Returns boolean

connectionInactivityTimeout

Returns number

connectionRefreshInterval

Returns number

renderer

Parameters

Returns void

Methods

addConlet

Parameters

Returns void

closeModalDialog

Parameters

Returns void

collectConletProperties

Parameters

Returns Map<string, string>

connectionLost

Returns void

connectionRestored

Returns void

connectionSuspended

Parameters

Returns void

execOnAction

Parameters

Returns void

findConletContents

Parameters

Returns Conlet[]

findConletPreview

Parameters

Returns Conlet | null

findConletView

Parameters

Returns Conlet | null

findPreviews

Returns Conlet[]

findViews

Returns Conlet[]

init

Parameters

Returns void

lockMessageQueue

Returns void

notification

Parameters

Returns Notification

notifyConletModel

Parameters

Returns void

openModalDialog

Parameters

Returns void

registerConletFunction

Parameters

Returns void

removePreview

Parameters

Returns void

removeView

Parameters

Returns void

renderConlet

Parameters

Returns void

send

Parameters

Returns void