Class: LayoutService
molecule.LayoutService
Hierarchy
Component
<ILayout
>↳
LayoutService
Implements
Constructors
constructor
• new LayoutService()
Overrides
Defined in
services/workbench/layoutService.ts:99
Properties
_container
• Private
_container: null
| HTMLElement
Defined in
services/workbench/layoutService.ts:98
state
• Protected
state: ILayout
Implementation of
Overrides
Defined in
services/workbench/layoutService.ts:97
Accessors
container
• get
container(): HTMLElement
Get the container of the molecule
Returns
HTMLElement
Implementation of
Defined in
services/workbench/layoutService.ts:104
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
Inherited from
Defined in
getMenuBarMode
▸ getMenuBarMode(): "horizontal"
| "vertical"
Get the mode of the MenuBar
Returns
"horizontal"
| "vertical"
Implementation of
Defined in
services/workbench/layoutService.ts:190
getState
▸ getState(): ILayout
Get the Component state
Returns
ILayout
Implementation of
Inherited from
Defined in
onUpdateState
▸ onUpdateState(listener
): void
Listen to the Component state update event
Parameters
Name | Type |
---|---|
listener | (prevState : ILayout , nextState : ILayout ) => void |
Returns
void
Implementation of
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
ILayoutService.removeOnUpdateState
Inherited from
Defined in
render
▸ render(nextState?
): void
Initiative notify the component to render the view by the state
Parameters
Name | Type |
---|---|
nextState? | ILayout |
Returns
void
Implementation of
Inherited from
Defined in
reset
▸ reset(): void
Reset all layout data as default value
Returns
void
Implementation of
Defined in
services/workbench/layoutService.ts:228
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:211
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:195
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:175
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:169
setMenuBarMode
▸ setMenuBarMode(mode
): void
Set the mode of the MenuBar, default is vertical
Parameters
Name | Type |
---|---|
mode | "horizontal" | "vertical" |
Returns
void
Implementation of
Defined in
services/workbench/layoutService.ts:181
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
Defined in
services/workbench/layoutService.ts:166
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:145
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
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
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:131
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:110
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:155
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:117
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:124
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:138
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