Class: LayoutService

molecule.LayoutService

Hierarchy

• Component<ILayout>

  ↳ LayoutService

Implements

• ILayoutService

Constructors

constructor

• new LayoutService()

Overrides

Component.constructor

Defined in

services/workbench/layoutService.ts:105

Properties

_container

• Private _container: null | HTMLElement

Defined in

services/workbench/layoutService.ts:104

---

state

• Protected state: ILayout

Implementation of

ILayoutService.state

Overrides

Component.state

Defined in

services/workbench/layoutService.ts:103

Accessors

container

• get container(): HTMLElement

Get the container of the molecule

Returns

HTMLElement

Implementation of

ILayoutService.container

Defined in

services/workbench/layoutService.ts:114

Methods

count

▸ count(name): number

Count the service event

Parameters

Name	Type	Description
name	string	Event name

Returns

number

Implementation of

ILayoutService.count

Inherited from

Component.count

Defined in

common/event/eventBus.ts:28

---

emit

▸ emit(name, ...args): void

Emit the service event

Parameters

Name	Type	Description
name	string	Event name
...args	any	Arguments

Returns

void

Implementation of

ILayoutService.emit

Inherited from

Component.emit

Defined in

common/event/eventBus.ts:20

---

forceUpdate

▸ forceUpdate(): void

Force to update the Component

Returns

void

Implementation of

ILayoutService.forceUpdate

Inherited from

Component.forceUpdate

Defined in

react/component.ts:81

---

getMenuBarMode

▸ getMenuBarMode(): "horizontal" | "vertical"

Get the mode of the MenuBar

Returns

"horizontal" | "vertical"

Implementation of

ILayoutService.getMenuBarMode

Defined in

services/workbench/layoutService.ts:200

---

getState

▸ getState(): ILayout

Get the Component state

Returns

ILayout

Implementation of

ILayoutService.getState

Inherited from

Component.getState

Defined in

react/component.ts:85

---

onUpdateState

▸ onUpdateState(listener): void

Listen to the Component state update event

Parameters

Name	Type
listener	(prevState: ILayout, nextState: ILayout) => void

Returns

void

Implementation of

ILayoutService.onUpdateState

Inherited from

Component.onUpdateState

Defined in

react/component.ts:73

---

onWorkbenchDidMount

▸ onWorkbenchDidMount(callback): void

Listen to the workbench did mount event

Parameters

Name	Type
callback	Function

Returns

void

Implementation of

ILayoutService.onWorkbenchDidMount

Defined in

services/workbench/layoutService.ts:110

---

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

ILayoutService.removeOnUpdateState

Inherited from

Component.removeOnUpdateState

Defined in

react/component.ts:77

---

render

▸ render(nextState?): void

Initiative notify the component to render the view by the state

Parameters

Name	Type
nextState?	ILayout

Returns

void

Implementation of

ILayoutService.render

Inherited from

Component.render

Defined in

react/component.ts:69

---

reset

▸ reset(): void

Reset all layout data as default value

Returns

void

Implementation of

ILayoutService.reset

Defined in

services/workbench/layoutService.ts:238

---

setAuxiliaryBar

▸ setAuxiliaryBar(hidden): boolean

Set the visibility of auxiliary bar

Returns the next state of hidden

Parameters

Name	Type
hidden	boolean | (preState: boolean) => boolean

Returns

boolean

Implementation of

ILayoutService.setAuxiliaryBar

Defined in

services/workbench/layoutService.ts:221

---

setEditorGroupDirection

▸ setEditorGroupDirection(direction): void

Set the direction of editor group,default is vertical

Parameters

Name	Type
direction	MenuBarMode | (prev: MenuBarMode) => MenuBarMode

Returns

void

Implementation of

ILayoutService.setEditorGroupDirection

Defined in

services/workbench/layoutService.ts:205

---

setGroupSplitSize

▸ setGroupSplitSize(groupSplitPos): void

Set the sizes between editor groups

Parameters

Name	Type
groupSplitPos	(string | number)[]

Returns

void

Implementation of

ILayoutService.setGroupSplitSize

Defined in

services/workbench/layoutService.ts:185

---

setHorizontalPaneSize

▸ setHorizontalPaneSize(horizontalSplitPanePos): void

Set the sizes between the editor and the panel

Parameters

Name	Type
horizontalSplitPanePos	(string | number)[]

Returns

void

Implementation of

ILayoutService.setHorizontalPaneSize

Defined in

services/workbench/layoutService.ts:179

---

setMenuBarMode

▸ setMenuBarMode(mode): void

Set the mode of the MenuBar, default is vertical

Parameters

Name	Type
mode	"horizontal" | "vertical"

Returns

void

Implementation of

ILayoutService.setMenuBarMode

Defined in

services/workbench/layoutService.ts:191

---

setPaneSize

▸ setPaneSize(splitPanePos): void

Set the sizes between the side bar and main content area

Parameters

Name	Type
splitPanePos	(string | number)[]

Returns

void

Implementation of

ILayoutService.setPaneSize

Defined in

services/workbench/layoutService.ts:176

---

setSideBarPosition

▸ setSideBarPosition(position): void

Set the position of the side bar, default is in left

Parameters

Name	Type
position	"right" | "left"

Returns

void

Implementation of

ILayoutService.setSideBarPosition

Defined in

services/workbench/layoutService.ts:155

---

setState

▸ setState(values, callback?): void

Set the state values, and notify the view component to re render

Parameters

Name	Type	Description
values	Partial<ILayout>	update target state values
callback?	(prevState: ILayout, nextState: ILayout) => void	-

Returns

void

Implementation of

ILayoutService.setState

Inherited from

Component.setState

Defined in

react/component.ts:56

---

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

ILayoutService.subscribe

Inherited from

Component.subscribe

Defined in

common/event/eventBus.ts:11

---

toggleActivityBarVisibility

▸ toggleActivityBarVisibility(): boolean

Toggle the visibility of the activity bar, returns the status of activity bar's hidden

Returns

boolean

Implementation of

ILayoutService.toggleActivityBarVisibility

Defined in

services/workbench/layoutService.ts:141

---

toggleMenuBarVisibility

▸ toggleMenuBarVisibility(): boolean

Toggle the visibility of menu bar, returns the status of menu bar's hidden

Returns

boolean

Implementation of

ILayoutService.toggleMenuBarVisibility

Defined in

services/workbench/layoutService.ts:120

---

togglePanelMaximized

▸ togglePanelMaximized(): boolean

Toggle the maximized status of the panel, returns the status of maximized panel

Returns

boolean

Implementation of

ILayoutService.togglePanelMaximized

Defined in

services/workbench/layoutService.ts:165

---

togglePanelVisibility

▸ togglePanelVisibility(): boolean

Toggle the visibility of the panel, returns the status of panel's hidden

Returns

boolean

Implementation of

ILayoutService.togglePanelVisibility

Defined in

services/workbench/layoutService.ts:127

---

toggleSidebarVisibility

▸ toggleSidebarVisibility(): boolean

Toggle the visibility of side bar, returns the status of side bar's hidden

Returns

boolean

Implementation of

ILayoutService.toggleSidebarVisibility

Defined in

services/workbench/layoutService.ts:134

---

toggleStatusBarVisibility

▸ toggleStatusBarVisibility(): boolean

Toggle the visibility of the status bar, returns the status of status bar's hidden

Returns

boolean

Implementation of

ILayoutService.toggleStatusBarVisibility

Defined in

services/workbench/layoutService.ts:148

---

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

ILayoutService.unsubscribe

Inherited from

Component.unsubscribe

Defined in

common/event/eventBus.ts:37