ConletRepresentation. But as representations of conlets are all we
have in this context, the shorter name was chosen for the sake of
brevity.
-Abstract elementAbstract idGenerated using TypeDoc
Abstract isAbstract isAbstract isGenerated using TypeDoc
Provides the console related functions.
-Private _conletPrivate _connectionPrivate _connectionPrivate _dialogPrivate _isPrivate _modalPrivate _pagePrivate _previewPrivate _rendererPrivate _resourcePrivate _viewPrivate _webPrivate _addPrivate _execPrivate _execPrivate _removePrivate _resolvePrivate _conletPrivate _connectionPrivate _connectionPrivate _dialogPrivate _isPrivate _modalPrivate _pagePrivate _previewPrivate _rendererPrivate _resourcePrivate _viewPrivate _webPrivate _addPrivate _execPrivate _execPrivate _removePrivate _resolveCalled when the console layout is received or when a conlet has been added or updated. Attempts to resolve all unresolved components, i.e. calls Console#addConlet for the conlets that provide the missing component.
-Private _updatePrivate _updatePrivate _updatePrivate _updatePrivate _updatePrivate _updateSends a notification to the server requesting the addition of a conlet.
the type of the conlet to add
the requested render mode(s), RenderMode.Foreground is automatically added
-Invokes Renderer.connectionLost.
-Invokes Renderer.connectionRestored.
-Invokes Renderer.connectionSuspended.
-Invokes Renderer.connectionLost.
+Invokes Renderer.connectionRestored.
+Invokes Renderer.connectionSuspended.
+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.
the container of the edit dialog
true if the dialog should be closed
Delegates to Renderer.findConletContents.
-Optional conletId: stringDelegates to Renderer.findConletPreview.
-Delegates to Renderer.findConletView.
-Delegates to Renderer.findPreviews.
-Delegates to Renderer.findViews.
-Starts the websocket connection to the server, invokes +
Delegates to Renderer.findConletContents.
+Optional conletId: stringDelegates to Renderer.findConletPreview.
+Delegates to Renderer.findConletView.
+Delegates to Renderer.findPreviews.
+Delegates to Renderer.findViews.
+Starts the websocket connection to the server, invokes
Renderer.init and sends the consoleReady message
to the server.
the connection id
additional options
-Optional inactivityOptional refreshDelegates to Renderer.notification.
+Delegates to Renderer.notification.
an object representing the notification
-Sends a JSON RPC notification to the server with method +
Sends a JSON RPC notification to the server with method
notifyConletModel and as parameters the given conletId,
the method and the additional arguments.
the id of the conlet to send to
the method to invoke
Rest ...args: any[]additional arguments to send
-Registers a conlet function that is to be invoked when a
JSON RPC notification with method notifyConletView
is received from the server.
the conlet type for which the method is registered
the method that is registered
the function to invoke
-Rest ...args: any[]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 @@ -106,7 +106,7 @@ conlets and the preview itself (again depth first). The notifications for the component conlets have as additional argument the collected properties.
-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 @@ -115,20 +115,20 @@ conlets and the view itself (again depth first). The notifications for the component conlets have as additional argument the collected properties.
-Sends a notification that requests the rendering of a conlet.
the conlet id
the requested render mode(s)
-Delegates to Renderer.updateConletModes.
-Delegates to Renderer.updateConletTitle.
-Delegates to Renderer.updateConletModes.
+Delegates to Renderer.updateConletTitle.
+Generated using TypeDoc
Generated using TypeDoc
conlet and a dataset attribute conlet-id. Different kinds
of conlet representationa are distinguished by additional classes
conlet-preview, conlet-view and conlet-content.
-Private _elementPrivate _elementGenerated using TypeDoc
Generated using TypeDoc
The class is also registered as window.JGConsole for non-modular
JavaScript.
Static LogStatic NotificationStatic OptionsStatic RenderStatic RendererStatic TableStatic formatUtility function to format a memory size to a maximum +
Static LogStatic NotificationStatic OptionsStatic RenderStatic RendererStatic TableStatic formatUtility function to format a memory size to a maximum of 4 digits for the integer part by appending the appropriate unit.
the size value to format
the number of digits of the factional part
the language (BCP 47 code, used to determine the delimiter)
-Static instanceStatic parseConverts a string with HTML source to a single or multiple DOM trees.
+Static instanceStatic parseConverts a string with HTML source to a single or multiple DOM trees.
the root nodes of the DOM trees
-Static createStatic createReturns the data (data-* Attribute) of the specified
element with the given key. If it does not exist, it
set to the value provided by the supplier function.
the DOM element
the key of the data
the supplier function
-Static findDelegates to the instance's Console.findConletPreview.
-Static findDelegates to the instance's Console.findConletView.
-Static forFinds the lang specific item in a map of items by language. +
Static findDelegates to the instance's Console.findConletPreview.
+Static findDelegates to the instance's Console.findConletView.
+Static forFinds the lang specific item in a map of items by language. The function first tests for a property as specified by lang, then removes any trailing "-..." from lang and tries again. If not successful, it tests for an entry using "en" and @@ -51,8 +51,8 @@
the messages by language identifier
the language identifier
fallback language (defaults to 'en')
-Static initDelegates to Console.init.
-Static localizeLocalizes the given key, using the provided localizations and language.
+Static initDelegates to Console.init.
+Static localizeLocalizes the given key, using the provided localizations and language.
First, the implementation looks up a mapping using
forLang(l10ns, lang, fallback). Then it looks for an entry for key.
If none is found, it returns the value of key.
the language identifier
the key to look up
fallback language (defaults to 'en')
-Static lockDelegates to Console.lockMessageQueue.
-Static notificationDelegates to the instance's Console.notification.
-Static notifyDelegates to Console.notifyConletModel.
-Rest ...params: any[]Static registerDelegates to Console.registerConletFunction.
-Rest ...args: any[]Static unlockDelegates to Console.unlockMessageQueue.
-Static uuidGenerated using TypeDoc
Static lockDelegates to Console.lockMessageQueue.
+Static notificationDelegates to the instance's Console.notification.
+Static notifyDelegates to Console.notifyConletModel.
+Rest ...params: any[]Static registerDelegates to Console.registerConletFunction.
+Rest ...args: any[]Static unlockDelegates to Console.unlockMessageQueue.
+Static uuidGenerated using TypeDoc
Helps to manage options. The main addition to simply using a Set are the toggle functions and the support for temporarily disabling an option.
-Creates a new option set.
-Private _disabledPrivate _enabledDeletes the option with the given name.
+Private _disabledPrivate _enabledGenerated using TypeDoc
Generated using TypeDoc
Private _consoleProtected consolePrivate _findPrivate _consoleProtected consolePrivate _findCalled from the Console when a new conlet type is added.
the conlet type
the display names for the conlet type by lang
the render modes
of components to be added to the page
-Abstract closeCalled by the Console to close a modal dialog +
Abstract closeCalled by the Console to close a modal dialog when a corrsponding request is received from the server.
the container for the dialog
-Called from the console when the connection to the server is suspended. The default implementation logs a warning message. Should be overridden by a method that displays a modal dialog.
The connection can be resumed by invoking the function passed as argument.
called when resuming
-Called from the console when the consoleConfigured notification
+
Find the conlet representations that display content. +
Find the conlet representations that display content.
The default implementation wraps all nodes that match
body .conlet.conlet-content. If a conletId is specified,
the the result set is restricted to conlets with this id.
Optional conletId: stringthe conlet id
the conlets found
-Find the conlet representation that displays the preview of the +
Find the conlet representation that displays the preview of the
conlet with the given id. The default implementation wraps
the node with .conlet-preview[data-conlet-id='<conletId>'.
the conlet id
the conlet or null
-Find the conlet representation that displays the view of the +
Find the conlets that display the preview, view or content of +
Find the conlets that display the preview, view or content of
the conlet with the given id. The default implementation wraps
all nodes with .conlet[data-conlet-id='<conletId>' in
DefaultConlets.
the conlet id
the conlets found
-Find conlet representations that display content and +
Find conlet representations that display content and
are embedded in the given conlet (which is most likely a view
or preview, but may also be a content representation).
The default implementation wraps all nodes (with the exception
@@ -88,30 +88,30 @@
.conlet.conlet-content and returns them in a depth first order.
the containing conlet
the conlets found
-Find the HTML element that displays a modal dialog associated +
Find the HTML element that displays a modal dialog associated
with the conlet with the given id. The default implementation returns
all nodes with .conlet-modal-dialog[data-conlet-id='<conletId>'.
the conlet id
the HTML element or null
-Return all conlet preview representations. The default +
Called from Console.init with the options passed to +
Called from Console.init with the options passed to Console.init.
the options
-Called from the Console when the console layout is received +
Called from the Console when the console layout is received from the server.
the conlet ids from top left to bottom right
the ids of the conlets viewable in tabs
extra information spcific to the console implementation
-Called by the Console to displays a notification.
+Called by the Console to displays a notification.
the content to display
the options
-Abstract openCalled by the Console to open a modal dialog.
+Abstract openCalled by the Console to open a modal dialog.
The container has a generated dialog id and attributes
data-conlet-type and data-conlet-id. If
ModalDialogOptions.useSubmit is true, the submit button
@@ -122,21 +122,21 @@
the container for the dialog
the options
the content as HTML
-Called by the Console to remove the given conlet +
Called from the Console to update a conlet that is used to provide content. The default implementation removes all children from the container and inserts the new content.
the conlet as returned from e.g. Renderer.findConletContents
the component content as DOM received from the server, usually inserted into the container
-Called by the Console to update the modes of the +
Called by the Console to update the modes of the conlet with the given id.
the conlet id
the modes
-Called from the Console to update the preview of +
Called from the Console to update the preview of the given conlet. If the preview is new (no preview with the given conlet id exists), the console provides DOM for the container as a convenience. Implementations of this method @@ -154,17 +154,17 @@ usually inserted into the container
true if the preview (i.e. the overview
plane) is to be made the active tab
Called bythe Console to update the title of the +
Called bythe Console to update the title of the conlet with the given id.
the conlet id
the new title
-Called from the Console when a conlet type is removed.
+Called from the Console when a conlet type is removed.
The expected action of the renderer is to remove the conlet type from e.g. a menu that allows adding conlets. However, front-ends can also force a reload of the application.
the conlet type
the render modes
-Called from the Console to update the view of the given conlet. +
Called from the Console to update the view of the given conlet. If the view is new (no view with the given conlet id exists), the console provides DOM for the container as a convenience. Implementations of this method @@ -180,7 +180,7 @@
the view content, usually inserted into the container
true if the view
is to be made the active tab
Protected wrapProtected wrapProtected wrapGenerated using TypeDoc
Protected wrapGenerated using TypeDoc
the initial sort key
the initial sort order
-Private _filterPrivate _keysPrivate _labelsPrivate _sortPrivate _sortPrivate _filterPrivate _keysPrivate _labelsPrivate _sortPrivate _sortThis method sets the primary sort key. If the order is
undefined, and the current sort key is the same as the
specified key, the current sort order is inverted.
the column key
Optional order: stringthe sort order ('up' for ascending
and 'down' for descending) or undefined
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
String constants for render modes.
-Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Options for notification display.
-Optional applyThe label for the dialog's apply button.
-Optional cancelableIf the notification may be closed by the user. Defaults to true.
-Optional okayThe label for the dialog's okay (apply and close) button.
-Optional titleThe dialog's title.
-Optional useCreate a button that submits the form with the given id.
-Generated using TypeDoc
Optional cancelableIf the notification may be closed by the user. Defaults to true.
+Optional okayThe label for the dialog's okay (apply and close) button.
+Optional titleThe dialog's title.
+Optional useCreate a button that submits the form with the given id.
+Generated using TypeDoc
Closes the notification.
-Generated using TypeDoc
Generated using TypeDoc
Options for notification display.
-Optional autoClose the notification automatically after the given number of milliseconds
-Optional closeableIf the notification may be closed by the user. Defaults to true.
-Optional typeThe notification type. Defaults to Info.
-Generated using TypeDoc
Optional closeableIf the notification may be closed by the user. Defaults to true.
+Optional typeThe notification type. Defaults to Info.
+Generated using TypeDoc
Generated using TypeDoc
Const The singleton that provides the console instance.
-Generated using TypeDoc
Generated using TypeDoc
The root element of the conlet representation.