@genesislcap/foundation-utils 14.311.0 → 14.312.0

package/docs/api/foundation-utils.defaultshortcutmanager.md

@@ -0,0 +1,321 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [DefaultShortcutManager](./foundation-utils.defaultshortcutmanager.md)
+
+## DefaultShortcutManager class
+
+Default implementation of the ShortcutManager interface
+
+**Signature:**
+
+```typescript
+export declare class DefaultShortcutManager implements ShortcutManager 
+```
+**Implements:** [ShortcutManager](./foundation-utils.shortcutmanager.md)
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[isPaused](./foundation-utils.defaultshortcutmanager.ispaused.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[isPaused$](./foundation-utils.defaultshortcutmanager.ispaused_.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+Observable&lt;boolean&gt;
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[isPausedSubject](./foundation-utils.defaultshortcutmanager.ispausedsubject.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+BehaviorSubject&lt;boolean&gt;
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
+
+## Methods
+
+<table><thead><tr><th>
+
+Method
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[clearActiveContext()](./foundation-utils.defaultshortcutmanager.clearactivecontext.md)
+
+
+</td><td>
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[executeShortcut(id)](./foundation-utils.defaultshortcutmanager.executeshortcut.md)
+
+
+</td><td>
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[executeShortcutByContext(context, id)](./foundation-utils.defaultshortcutmanager.executeshortcutbycontext.md)
+
+
+</td><td>
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[findShortcutByKeyCombination(key, ctrlKey, altKey, shiftKey, metaKey)](./foundation-utils.defaultshortcutmanager.findshortcutbykeycombination.md)
+
+
+</td><td>
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[getActiveContext()](./foundation-utils.defaultshortcutmanager.getactivecontext.md)
+
+
+</td><td>
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[getContexts()](./foundation-utils.defaultshortcutmanager.getcontexts.md)
+
+
+</td><td>
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[getShortcuts()](./foundation-utils.defaultshortcutmanager.getshortcuts.md)
+
+
+</td><td>
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[getShortcutsByContext(context)](./foundation-utils.defaultshortcutmanager.getshortcutsbycontext.md)
+
+
+</td><td>
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[getShortcutsByContextMap()](./foundation-utils.defaultshortcutmanager.getshortcutsbycontextmap.md)
+
+
+</td><td>
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[pause()](./foundation-utils.defaultshortcutmanager.pause.md)
+
+
+</td><td>
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[registerContext(context)](./foundation-utils.defaultshortcutmanager.registercontext.md)
+
+
+</td><td>
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[registerShortcut(shortcut)](./foundation-utils.defaultshortcutmanager.registershortcut.md)
+
+
+</td><td>
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[registerShortcuts(shortcuts)](./foundation-utils.defaultshortcutmanager.registershortcuts.md)
+
+
+</td><td>
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[resume()](./foundation-utils.defaultshortcutmanager.resume.md)
+
+
+</td><td>
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[setActiveContext(context)](./foundation-utils.defaultshortcutmanager.setactivecontext.md)
+
+
+</td><td>
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[unregisterShortcut(context, id)](./foundation-utils.defaultshortcutmanager.unregistershortcut.md)
+
+
+</td><td>
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[unregisterShortcutsByContext(context)](./foundation-utils.defaultshortcutmanager.unregistershortcutsbycontext.md)
+
+
+</td><td>
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
+

package/docs/api/foundation-utils.defaultshortcutmanager.pause.md

@@ -0,0 +1,15 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [DefaultShortcutManager](./foundation-utils.defaultshortcutmanager.md) &gt; [pause](./foundation-utils.defaultshortcutmanager.pause.md)
+
+## DefaultShortcutManager.pause() method
+
+**Signature:**
+
+```typescript
+pause(): void;
+```
+**Returns:**
+
+void
+

package/docs/api/foundation-utils.defaultshortcutmanager.registercontext.md

@@ -0,0 +1,50 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [DefaultShortcutManager](./foundation-utils.defaultshortcutmanager.md) &gt; [registerContext](./foundation-utils.defaultshortcutmanager.registercontext.md)
+
+## DefaultShortcutManager.registerContext() method
+
+**Signature:**
+
+```typescript
+registerContext(context: string): void;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+context
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
+
+**Returns:**
+
+void
+

package/docs/api/foundation-utils.defaultshortcutmanager.registershortcut.md

@@ -0,0 +1,50 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [DefaultShortcutManager](./foundation-utils.defaultshortcutmanager.md) &gt; [registerShortcut](./foundation-utils.defaultshortcutmanager.registershortcut.md)
+
+## DefaultShortcutManager.registerShortcut() method
+
+**Signature:**
+
+```typescript
+registerShortcut(shortcut: ShortcutDefinition): ShortcutRegistrationResult;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+shortcut
+
+
+</td><td>
+
+[ShortcutDefinition](./foundation-utils.shortcutdefinition.md)
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
+
+**Returns:**
+
+[ShortcutRegistrationResult](./foundation-utils.shortcutregistrationresult.md)
+

package/docs/api/foundation-utils.defaultshortcutmanager.registershortcuts.md

@@ -0,0 +1,50 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [DefaultShortcutManager](./foundation-utils.defaultshortcutmanager.md) &gt; [registerShortcuts](./foundation-utils.defaultshortcutmanager.registershortcuts.md)
+
+## DefaultShortcutManager.registerShortcuts() method
+
+**Signature:**
+
+```typescript
+registerShortcuts(shortcuts: ShortcutDefinition[]): void;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+shortcuts
+
+
+</td><td>
+
+[ShortcutDefinition](./foundation-utils.shortcutdefinition.md)<!-- -->\[\]
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
+
+**Returns:**
+
+void
+

package/docs/api/foundation-utils.defaultshortcutmanager.resume.md

@@ -0,0 +1,15 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [DefaultShortcutManager](./foundation-utils.defaultshortcutmanager.md) &gt; [resume](./foundation-utils.defaultshortcutmanager.resume.md)
+
+## DefaultShortcutManager.resume() method
+
+**Signature:**
+
+```typescript
+resume(): void;
+```
+**Returns:**
+
+void
+

package/docs/api/foundation-utils.defaultshortcutmanager.setactivecontext.md

@@ -0,0 +1,50 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [DefaultShortcutManager](./foundation-utils.defaultshortcutmanager.md) &gt; [setActiveContext](./foundation-utils.defaultshortcutmanager.setactivecontext.md)
+
+## DefaultShortcutManager.setActiveContext() method
+
+**Signature:**
+
+```typescript
+setActiveContext(context: string): void;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+context
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
+
+**Returns:**
+
+void
+

package/docs/api/foundation-utils.defaultshortcutmanager.unregistershortcut.md

@@ -0,0 +1,64 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [DefaultShortcutManager](./foundation-utils.defaultshortcutmanager.md) &gt; [unregisterShortcut](./foundation-utils.defaultshortcutmanager.unregistershortcut.md)
+
+## DefaultShortcutManager.unregisterShortcut() method
+
+**Signature:**
+
+```typescript
+unregisterShortcut(context: string, id: string): void;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+context
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+id
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
+
+**Returns:**
+
+void
+

package/docs/api/foundation-utils.defaultshortcutmanager.unregistershortcutsbycontext.md

@@ -0,0 +1,50 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [DefaultShortcutManager](./foundation-utils.defaultshortcutmanager.md) &gt; [unregisterShortcutsByContext](./foundation-utils.defaultshortcutmanager.unregistershortcutsbycontext.md)
+
+## DefaultShortcutManager.unregisterShortcutsByContext() method
+
+**Signature:**
+
+```typescript
+unregisterShortcutsByContext(context: string): void;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+context
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
+
+**Returns:**
+
+void
+

package/docs/api/foundation-utils.foundationshortcutlistener.connectedcallback.md

@@ -0,0 +1,15 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [FoundationShortcutListener](./foundation-utils.foundationshortcutlistener.md) &gt; [connectedCallback](./foundation-utils.foundationshortcutlistener.connectedcallback.md)
+
+## FoundationShortcutListener.connectedCallback() method
+
+**Signature:**
+
+```typescript
+connectedCallback(): void;
+```
+**Returns:**
+
+void
+

package/docs/api/foundation-utils.foundationshortcutlistener.disconnectedcallback.md

@@ -0,0 +1,15 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [FoundationShortcutListener](./foundation-utils.foundationshortcutlistener.md) &gt; [disconnectedCallback](./foundation-utils.foundationshortcutlistener.disconnectedcallback.md)
+
+## FoundationShortcutListener.disconnectedCallback() method
+
+**Signature:**
+
+```typescript
+disconnectedCallback(): void;
+```
+**Returns:**
+
+void
+