Class: EditorTreeService
molecule.EditorTreeService
Hierarchy
Implements
Constructors
constructor
• new EditorTreeService()
Overrides
Defined in
services/workbench/explorer/editorTreeService.ts:78
Properties
editorService
• Private Readonly editorService: EditorService
Defined in
services/workbench/explorer/editorTreeService.ts:76
state
• Protected state: IEditor
Implementation of
Overrides
Defined in
services/workbench/explorer/editorTreeService.ts:75
Methods
count
▸ count(name): number
Count the service event
Parameters
| Name | Type | Description |
|---|---|---|
name | string | Event name |
Returns
number
Implementation of
Inherited from
Defined in
emit
▸ emit(name, ...args): void
Emit the service event
Parameters
| Name | Type | Description |
|---|---|---|
name | string | Event name |
...args | any | Arguments |
Returns
void
Implementation of
Inherited from
Defined in
forceUpdate
▸ forceUpdate(): void
Force to update the Component
Returns
void
Implementation of
IEditorTreeService.forceUpdate
Inherited from
Defined in
getState
▸ getState(): IEditor
Get the Component state
Returns
Implementation of
Inherited from
Defined in
onClose
▸ onClose(callback): void
Callabck for close a certain tab
Parameters
| Name | Type |
|---|---|
callback | (tabId: UniqueId, groupId: UniqueId) => void |
Returns
void
Implementation of
Defined in
services/workbench/explorer/editorTreeService.ts:84
onCloseAll
▸ onCloseAll(callback): void
Callback for close all tabs When specify groupId, it'll close that group
Parameters
| Name | Type |
|---|---|
callback | (groupId?: UniqueId) => void |
Returns
void
Implementation of
Defined in
services/workbench/explorer/editorTreeService.ts:102
onCloseOthers
▸ onCloseOthers(callback): void
Callback for close others tabs except this tabItem
Parameters
| Name | Type |
|---|---|
callback | (tabItem: IEditorTab<BuiltInEditorTabDataType>, groupId: UniqueId) => void |
Returns
void
Implementation of
IEditorTreeService.onCloseOthers
Defined in
services/workbench/explorer/editorTreeService.ts:88
onCloseSaved
▸ onCloseSaved(callback): void
Callback for close saved tabs in this group
Parameters
| Name | Type |
|---|---|
callback | (groupId: UniqueId) => void |
Returns
void
Implementation of
IEditorTreeService.onCloseSaved
Defined in
services/workbench/explorer/editorTreeService.ts:94
onContextMenu
▸ onContextMenu(callback): void
Callback for context menu click event which isn't in buit-in menus
Parameters
| Name | Type |
|---|---|
callback | (menu: IMenuItemProps, file: ITabProps<any, any>, groupId: UniqueId) => void |
Returns
void
Implementation of
IEditorTreeService.onContextMenu
Defined in
services/workbench/explorer/editorTreeService.ts:120
onLayout
▸ onLayout(callback): void
Callback for adjust editor layout
Parameters
| Name | Type |
|---|---|
callback | () => void |
Returns
void
Implementation of
Defined in
services/workbench/explorer/editorTreeService.ts:116
onSaveAll
▸ onSaveAll(callback): void
Callback for save all tabs When specify groupId, it'll save that group
Parameters
| Name | Type |
|---|---|
callback | (groupId?: UniqueId) => void |
Returns
void
Implementation of
Defined in
services/workbench/explorer/editorTreeService.ts:106
onSelect
▸ onSelect(callback): void
Callback for select tab in this group
Parameters
| Name | Type |
|---|---|
callback | (tabId: UniqueId, groupId: UniqueId) => void |
Returns
void
Implementation of
Defined in
services/workbench/explorer/editorTreeService.ts:98
onToolbarClick
▸ onToolbarClick(callback): void
Callback for the click event from toolbar buttons, except for saving button and closing button,
if you want to subscribe to the click events for these two buttons, please use the methods of onSaveAll and onCloseAll
Parameters
| Name | Type |
|---|---|
callback | (toolbar: IActionBarItemProps<any>, groupId?: UniqueId) => void |
Returns
void
Implementation of
IEditorTreeService.onToolbarClick
Defined in
services/workbench/explorer/editorTreeService.ts:110
onUpdateState
▸ onUpdateState(listener): void
Listen to the Component state update event
Parameters
| Name | Type |
|---|---|
listener | (prevState: IEditor, nextState: IEditor) => void |
Returns
void
Implementation of
IEditorTreeService.onUpdateState
Inherited from
Defined in
removeOnUpdateState
▸ removeOnUpdateState(listener?): void
Remove the Component update event listening, default is remove all, also you can remove one by pass the listener
Parameters
| Name | Type |
|---|---|
listener? | Function |
Returns
void
Implementation of
IEditorTreeService.removeOnUpdateState
Inherited from
Defined in
render
▸ render(nextState?): void
Initiative notify the component to render the view by the state
Parameters
| Name | Type |
|---|---|
nextState? | IEditor |
Returns
void
Implementation of
Inherited from
Defined in
setState
▸ setState(values, callback?): void
Set the state values, and notify the view component to re render
Parameters
| Name | Type | Description |
|---|---|---|
values | Partial<IEditor> | update target state values |
callback? | (prevState: IEditor, nextState: IEditor) => void | - |
Returns
void
Implementation of
Inherited from
Defined in
subscribe
▸ subscribe(name, listener): void
Subscribe the service event
Parameters
| Name | Type | Description |
|---|---|---|
name | string | string[] | Event name |
listener | Function | Listener function |
Returns
void
Implementation of
Inherited from
Defined in
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
Implementation of
IEditorTreeService.unsubscribe