Interface: IEditorService
services.IEditorService
Hierarchy
Component\<IEditor>↳
IEditorService
Table of contents
Properties
Methods
- cloneGroup
- closeAll
- closeOther
- closeTab
- closeToLeft
- closeToRight
- getDefaultActions
- getDefaultMenus
- getGroupById
- getGroupIdByTab
- getTabById
- isOpened
- onActionsClick
- onCloseAll
- onCloseOther
- onCloseTab
- onCloseToLeft
- onCloseToRight
- onMoveTab
- onOpenTab
- onSelectTab
- onUpdateTab
- open
- setActive
- setDefaultActions
- setDefaultMenus
- setEntry
- setGroupEditorValue
- subscribe
- unsubscribe
- updateActions
- updateCurrentGroup
- updateEditorOptions
- updateGroup
- updateTab
Properties
editorInstance
• Readonly editorInstance: IStandaloneCodeEditor
The instance of MonacoEditor
Defined in
src/services/workbench/editorService.ts:191
state
• Protected Abstract state: IEditor
Inherited from
Component.state
Defined in
Methods
cloneGroup
▸ cloneGroup(groupId?): IEditorGroup\<any, any>
Clone a specific group, if the argument groupId is undefined,
there default clone the current group
Parameters
| Name | Type |
|---|---|
groupId? | UniqueId |
Returns
IEditorGroup\<any, any>
Defined in
src/services/workbench/editorService.ts:87
closeAll
▸ closeAll(groupId): void
Close the specific group all opened tabs
Parameters
| Name | Type | Description |
|---|---|---|
groupId | UniqueId | The groupId is required |
Returns
void
Defined in
src/services/workbench/editorService.ts:76
closeOther
▸ closeOther(tab, groupId): void
Close other opened tabs in Editor Group
Parameters
| Name | Type | Description |
|---|---|---|
tab | IEditorTab\<BuiltInEditorTabDataType> | The id is required |
groupId | UniqueId | The groupId is required |
Returns
void
Defined in
src/services/workbench/editorService.ts:59
closeTab
▸ closeTab(tabId, groupId): void
Close the specific Tab opened in Editor Group view
Parameters
| Name | Type | Description |
|---|---|---|
tabId | UniqueId | The tabId is required |
groupId | UniqueId | The groupId is required |
Returns
void
Defined in
src/services/workbench/editorService.ts:53
closeToLeft
▸ closeToLeft(tab, groupId): void
Close the left opened Tabs in Editor Group
Parameters
| Name | Type | Description |
|---|---|---|
tab | IEditorTab\<BuiltInEditorTabDataType> | The id is required, the start point of close to left |
groupId | UniqueId | The groupId is required |
Returns
void
Defined in
src/services/workbench/editorService.ts:71
closeToRight
▸ closeToRight(tab, groupId): void
Close the right opened tabs in Editor Group
Parameters
| Name | Type | Description |
|---|---|---|
tab | IEditorTab\<BuiltInEditorTabDataType> | The id is required, the start point of close to right |
groupId | UniqueId | The groupId is required |
Returns
void
Defined in
src/services/workbench/editorService.ts:65
getDefaultActions
▸ getDefaultActions(): IEditorActionsProps[]
Get the default group actions
Returns
Defined in
src/services/workbench/editorService.ts:178
getDefaultMenus
▸ getDefaultMenus(): IMenuItemProps[]
Get the default group menus
Returns
IMenuItemProps[]
Defined in
src/services/workbench/editorService.ts:182
getGroupById
▸ getGroupById(groupId): undefined | IEditorGroup\<any, any>
Get the specific group
Parameters
| Name | Type | Description |
|---|---|---|
groupId | UniqueId | The groupId is required |
Returns
undefined | IEditorGroup\<any, any>
Defined in
src/services/workbench/editorService.ts:81
getGroupIdByTab
▸ getGroupIdByTab(tabId): null | UniqueId
Get the group's id which contains the tab
Parameters
| Name | Type |
|---|---|
tabId | UniqueId |
Returns
null | UniqueId
Defined in
src/services/workbench/editorService.ts:196
getTabById
▸ getTabById\<T>(tabId, groupId): undefined | IEditorTab\<T>
Get a tab from a specific group via the tab ID
Type parameters
| Name |
|---|
T |
Parameters
| Name | Type |
|---|---|
tabId | UniqueId |
groupId | UniqueId |
Returns
undefined | IEditorTab\<T>
Defined in
src/services/workbench/editorService.ts:26
isOpened
▸ isOpened(tabId): boolean
Judge the specific tabs whether opened in Editor view
Parameters
| Name | Type | Description |
|---|---|---|
tabId | UniqueId | The tabId is required |
Returns
boolean
Defined in
src/services/workbench/editorService.ts:47
onActionsClick
▸ onActionsClick(callback): void
Listen to the Group Actions click event
Parameters
| Name | Type |
|---|---|
callback | (menuId: UniqueId, currentGroup: IEditorGroup\<any, any>) => void |
Returns
void
Defined in
src/services/workbench/editorService.ts:139
onCloseAll
▸ onCloseAll(callback): any
Listen to the all tabs close event
Parameters
| Name | Type |
|---|---|
callback | (groupId?: UniqueId) => void |
Returns
any
Defined in
src/services/workbench/editorService.ts:114
onCloseOther
▸ onCloseOther(callback): any
Listen to the other tabs close event
Parameters
| Name | Type |
|---|---|
callback | (tabItem: IEditorTab\<BuiltInEditorTabDataType>, groupId?: UniqueId) => void |
Returns
any
Defined in
src/services/workbench/editorService.ts:124
onCloseTab
▸ onCloseTab(callback): any
Listen to the tab close event
Parameters
| Name | Type |
|---|---|
callback | (tabId: UniqueId, groupId?: UniqueId) => void |
Returns
any
Defined in
src/services/workbench/editorService.ts:119
onCloseToLeft
▸ onCloseToLeft(callback): any
Listen to the left tabs close event
Parameters
| Name | Type |
|---|---|
callback | (tabItem: IEditorTab\<BuiltInEditorTabDataType>, groupId?: UniqueId) => void |
Returns
any
Defined in
src/services/workbench/editorService.ts:129
onCloseToRight
▸ onCloseToRight(callback): any
Listen to the right tabs close event
Parameters
| Name | Type |
|---|---|
callback | (tabItem: IEditorTab\<BuiltInEditorTabDataType>, groupId?: UniqueId) => void |
Returns
any
Defined in
src/services/workbench/editorService.ts:134
onMoveTab
▸ onMoveTab(callback): any
Listen to the tab move event
Parameters
| Name | Type |
|---|---|
callback | (updateTabs: IEditorTab\<any>[], groupId?: UniqueId) => void |
Returns
any
Defined in
src/services/workbench/editorService.ts:102
onOpenTab
▸ onOpenTab(callback): void
Listen to the tab opening event
Parameters
| Name | Type |
|---|---|
callback | (tab: IEditorTab\<BuiltInEditorTabDataType>) => void |
Returns
void
Defined in
src/services/workbench/editorService.ts:97
onSelectTab
▸ onSelectTab(callback): any
Listen to the tab select event
Parameters
| Name | Type |
|---|---|
callback | (tabId: UniqueId, groupId?: UniqueId) => void |
Returns
any
Defined in
src/services/workbench/editorService.ts:109
onUpdateTab
▸ onUpdateTab(callback): void
Listen to the Editor tab changed event
Parameters
| Name | Type |
|---|---|
callback | (tab: IEditorTab\<BuiltInEditorTabDataType>) => void |
Returns
void
Defined in
src/services/workbench/editorService.ts:92
open
▸ open\<T>(tab, groupId?): void
Open a new tab in a specific group
Type parameters
| Name | Type |
|---|---|
T | any |
Parameters
| Name | Type | Description |
|---|---|---|
tab | IEditorTab\<T> | Tab data |
groupId? | UniqueId | Group ID |
Returns
void
Defined in
src/services/workbench/editorService.ts:20
setActive
▸ setActive(groupId, tabId): any
Set active group and tab
Parameters
| Name | Type | Description |
|---|---|---|
groupId | UniqueId | Target group ID |
tabId | UniqueId | Target tab ID |
Returns
any
Defined in
src/services/workbench/editorService.ts:147
setDefaultActions
▸ setDefaultActions(actions): void
Set default actions when create a new group
Parameters
| Name | Type |
|---|---|
actions | IEditorActionsProps[] |
Returns
void
Defined in
src/services/workbench/editorService.ts:158
setDefaultMenus
▸ setDefaultMenus(menus): void
Set default menus when create a new group
Parameters
| Name | Type |
|---|---|
menus | IMenuItemProps[] |
Returns
void
Defined in
src/services/workbench/editorService.ts:163
setEntry
▸ setEntry(component): void
Specify the Entry page of Workbench
Parameters
| Name | Type |
|---|---|
component | Element |
Returns
void
Defined in
src/services/workbench/editorService.ts:42
setGroupEditorValue
▸ setGroupEditorValue(group, value): void
Updates the editor content for a specific group
Parameters
| Name | Type | Description |
|---|---|---|
group | IEditorGroup\<any, any> | The editorInstance is required |
value | string |
Returns
void
Defined in
src/services/workbench/editorService.ts:38
subscribe
▸ subscribe(name, listener): void
Subscribe the service event
Parameters
| Name | Type | Description |
|---|---|---|
name | string | string[] | Event name |
listener | Function | Listener function |
Returns
void
Inherited from
Component.subscribe
Defined in
src/common/event/eventBus.ts:11
unsubscribe
▸ unsubscribe(name, listener?): void
Unsubscribe the specific event and the listener function
Parameters
| Name | Type | Description |
|---|---|---|
name | any | The event name |
listener? | Function | optional, it unsubscribes events via name if not pass the listener function |
Returns
void
Inherited from
Component.unsubscribe
Defined in
src/common/event/eventBus.ts:39
updateActions
▸ updateActions(actions, groupId?): void
Update actions in specific group
Parameters
| Name | Type |
|---|---|
actions | IMenuItemProps[] |
groupId? | UniqueId |
Returns
void
Defined in
src/services/workbench/editorService.ts:169
updateCurrentGroup
▸ updateCurrentGroup(currentValues): void
Update the current group
Parameters
| Name | Type |
|---|---|
currentValues | any |
Returns
void
Defined in
src/services/workbench/editorService.ts:174
updateEditorOptions
▸ updateEditorOptions(options): void
Update the editor options
Parameters
| Name | Type |
|---|---|
options | IEditorOptions |
Returns
void
Defined in
src/services/workbench/editorService.ts:187
updateGroup
▸ updateGroup(groupId, groupValues): void
Update the specific group
Parameters
| Name | Type |
|---|---|
groupId | UniqueId |
groupValues | Omit\<IEditorGroup\<any, any>, "id"> |
Returns
void
Defined in
src/services/workbench/editorService.ts:153
updateTab
▸ updateTab(tab, groupId?): IEditorTab\<BuiltInEditorTabDataType>
Update the specific tab, if the groupId provide, then update the tab of specific group
Parameters
| Name | Type | Description |
|---|---|---|
tab | IEditorTab\<BuiltInEditorTabDataType> | The id is required |
groupId? | UniqueId |
Returns
IEditorTab\<BuiltInEditorTabDataType>