SidePanelHandler | Theia TypeDoc

A class which manages a dock panel and a related side bar. This is used for the left and right panel of the application shell.

Hierarchy

SidePanelHandler

Constructors

constructor

new SidePanelHandler(): SidePanelHandler

Returns SidePanelHandler

Properties

Protected Readonly applicationStateService

applicationStateService: FrontendApplicationStateService

bottomMenu

bottomMenu: SidebarMenuWidget

The menu placed on the sidebar bottom. Displayed as icons. Open menus when on clicks.

container

container: Panel

The panel that contains the tab bar and the dock panel. This one is hidden whenever the dock panel is empty.

Protected Readonly contextMenuRenderer

contextMenuRenderer: ContextMenuRenderer

dockPanel

dockPanel: TheiaDockPanel

The widget container is a dock panel in single-document mode, which means that the panel cannot be split.

Protected Readonly dockPanelFactory

dockPanelFactory: TheiaDockPanel.Factory

Protected options

options: SidePanel.Options

Options that control the behavior of the side panel.

Protected side

side: "left" | "right"

The shell area where the panel is placed. This property should not be modified directly, but only by calling create.

Protected sidebarBottomWidgetFactory

sidebarBottomWidgetFactory: (() => SidebarBottomMenuWidget)

Type declaration

- (): SidebarBottomMenuWidget
- Returns SidebarBottomMenuWidget

Protected sidebarTopWidgetFactory

sidebarTopWidgetFactory: (() => SidebarTopMenuWidget)

Type declaration

- (): SidebarTopMenuWidget
- Returns SidebarTopMenuWidget

Protected splitPositionHandler

splitPositionHandler: SplitPositionHandler

Readonly state

state: SidePanel.State = ...

The current state of the side panel.

tabBar

tabBar: SideTabBar

The tab bar displays the titles of the widgets in the side panel. Visibility of the widgets is controlled entirely through tab selection: a widget is revealed by setting the currentTitle accordingly in the tab bar, and the panel is hidden by setting that property to null. The tab bar itself remains visible as long as there is at least one widget.

Protected tabBarRendererFactory

tabBarRendererFactory: (() => TabBarRenderer)

Type declaration

- (): TabBarRenderer
- Returns TabBarRenderer

Protected tabBarToolBarFactory

tabBarToolBarFactory: (() => TabBarToolbar)

Type declaration

- (): TabBarToolbar
- Returns TabBarToolbar

Protected tabBarToolBarRegistry

tabBarToolBarRegistry: TabBarToolbarRegistry

Protected Readonly toDisposeOnCurrentTabChanged

toDisposeOnCurrentTabChanged: DisposableCollection = ...

toolBar

toolBar: SidePanelToolbar

A tool bar, which displays a title and widget specific command buttons.

topMenu

topMenu: SidebarMenuWidget

The menu placed on the sidebar top. Displayed as icons. Open menus when on clicks.

Static Protected Readonly rankProperty

rankProperty: AttachedProperty<Widget, undefined | number> = ...

A property that can be attached to widgets in order to determine the insertion index of their title in the tab bar.

Methods

activate

activate(id: string): undefined | Widget

- Defined in packages/core/src/browser/shell/side-panel-handler.ts:329
Activate a widget residing in the side panel by ID.

Parameters
- id: string
Returns undefined | Widget
the activated widget if it was found

addBottomMenu

addBottomMenu(menu: SidebarMenu): void

- Defined in packages/core/src/browser/shell/side-panel-handler.ts:437
Add a menu to the sidebar bottom.

If the menu is already added, it will be ignored.

Parameters
- menu: SidebarMenu
Returns void

addTopMenu

addTopMenu(menu: SidebarMenu): void

- Defined in packages/core/src/browser/shell/side-panel-handler.ts:419
Add a menu to the sidebar top.

If the menu is already added, it will be ignored.

Parameters
- menu: SidebarMenu
Returns void

addWidget

addWidget(widget: Widget, options: SidePanel.WidgetOptions): void

- Defined in packages/core/src/browser/shell/side-panel-handler.ts:407
Add a widget and its title to the dock panel and side bar.

If the widget is already added, it will be moved.

Parameters
- widget: Widget
- options: SidePanel.WidgetOptions
Returns void

collapse

collapse(): Promise<void>

- Defined in packages/core/src/browser/shell/side-panel-handler.ts:392
Collapse the sidebar so no items are expanded.

Returns Promise<void>

create

create(side: "left" | "right", options: SidePanel.Options): void

- Defined in packages/core/src/browser/shell/side-panel-handler.ts:131
Create the side bar and dock panel widgets.

Parameters
- side: "left" | "right"
- options: SidePanel.Options
Returns void

Protected createContainer

createContainer(): Panel

- Defined in packages/core/src/browser/shell/side-panel-handler.ts:231
Returns Panel

Protected createSideBar

createSideBar(): SideTabBar

- Defined in packages/core/src/browser/shell/side-panel-handler.ts:144
Returns SideTabBar

Protected createSidePanel

createSidePanel(): TheiaDockPanel

- Defined in packages/core/src/browser/shell/side-panel-handler.ts:181
Returns TheiaDockPanel

Protected createSidebarBottomMenu

createSidebarBottomMenu(): SidebarBottomMenuWidget

- Defined in packages/core/src/browser/shell/side-panel-handler.ts:206
Returns SidebarBottomMenuWidget

Protected createSidebarMenu

createSidebarMenu<T>(factory: (() => T)): T

- Defined in packages/core/src/browser/shell/side-panel-handler.ts:210
Type Parameters
- T extends SidebarMenuWidget<T>
Parameters
- factory: (() => T)
  - - (): T
    - Returns T
Returns T

Protected createSidebarTopMenu

createSidebarTopMenu(): SidebarTopMenuWidget

- Defined in packages/core/src/browser/shell/side-panel-handler.ts:202
Returns SidebarTopMenuWidget

Protected createToolbar

createToolbar(): SidePanelToolbar

- Defined in packages/core/src/browser/shell/side-panel-handler.ts:196
Returns SidePanelToolbar

expand

expand(id?: string): undefined | Widget

- Defined in packages/core/src/browser/shell/side-panel-handler.ts:344
Expand a widget residing in the side panel by ID. If no ID is given and the panel is currently collapsed, the last active tab of this side panel is expanded. If no tab was expanded previously, the first one is taken.

Parameters
- Optional id: string
Returns undefined | Widget
the expanded widget if it was found

Protected getDefaultPanelSize

getDefaultPanelSize(): undefined | number

- Defined in packages/core/src/browser/shell/side-panel-handler.ts:558
Determine the default size to apply when the panel is expanded for the first time.

Returns undefined | number

getLayoutData

getLayoutData(): SidePanel.LayoutData

- Defined in packages/core/src/browser/shell/side-panel-handler.ts:272
Create an object that describes the current side panel layout. This object may contain references to widgets; these need to be transformed before the layout can be serialized.

Returns SidePanel.LayoutData

Protected getPanelSize

getPanelSize(): undefined | number

- Defined in packages/core/src/browser/shell/side-panel-handler.ts:536
Compute the current width of the panel. This implementation assumes that the parent of the panel container is a SplitPanel.

Returns undefined | number

Protected onCurrentTabChanged

onCurrentTabChanged(sender: SideTabBar, __namedParameters: ICurrentChangedArgs<Widget>): void

- Defined in packages/core/src/browser/shell/side-panel-handler.ts:591
Handle a currentChanged signal from the sidebar. The side panel is refreshed so it displays the new selected widget.

Parameters
- sender: SideTabBar
- __namedParameters: ICurrentChangedArgs<Widget>
Returns void

Protected onTabDetachRequested

onTabDetachRequested(sender: SideTabBar, __namedParameters: ITabDetachRequestedArgs<Widget>): void

- Defined in packages/core/src/browser/shell/side-panel-handler.ts:609
Handle a tabDetachRequested signal from the sidebar. A drag is started so the widget can be moved to another application shell area.

Parameters
- sender: SideTabBar
- __namedParameters: ITabDetachRequestedArgs<Widget>
Returns void

Protected onWidgetAdded

onWidgetAdded(sender: DockPanel, widget: Widget): void

- Defined in packages/core/src/browser/shell/side-panel-handler.ts:643
Parameters
- sender: DockPanel
- widget: Widget
Returns void

Protected onWidgetRemoved

onWidgetRemoved(sender: DockPanel, widget: Widget): void

- Defined in packages/core/src/browser/shell/side-panel-handler.ts:665
Parameters
- sender: DockPanel
- widget: Widget
Returns void

refresh

refresh(): void

- Defined in packages/core/src/browser/shell/side-panel-handler.ts:459
Refresh the visibility of the side bar and dock panel.

Returns void

removeBottomMenu

removeBottomMenu(menuId: string): void

- Defined in packages/core/src/browser/shell/side-panel-handler.ts:446
Remove a menu from the sidebar bottom.

Parameters
- menuId: string
  
  id of the menu to remove
Returns void

removeTopMenu

removeTopMenu(menuId: string): void

- Defined in packages/core/src/browser/shell/side-panel-handler.ts:428
Remove a menu from the sidebar top.

Parameters
- menuId: string
  
  id of the menu to remove
Returns void

resize

resize(size: number): void

- Defined in packages/core/src/browser/shell/side-panel-handler.ts:524
Sets the size of the side panel.

Parameters
- size: number
  
  the desired size (width) of the panel in pixels.
Returns void

setLayoutData

setLayoutData(layoutData: SidePanel.LayoutData): void

- Defined in packages/core/src/browser/shell/side-panel-handler.ts:288
Apply a side panel layout that has been previously created with getLayoutData.

Parameters
- layoutData: SidePanel.LayoutData
Returns void

Protected setPanelSize

setPanelSize(size: number): Promise<void>

- Defined in packages/core/src/browser/shell/side-panel-handler.ts:569
Modify the width of the panel. This implementation assumes that the parent of the panel container is a SplitPanel.

Parameters
- size: number
Returns Promise<void>

Protected showContextMenu

showContextMenu(e: MouseEvent): void

- Defined in packages/core/src/browser/shell/side-panel-handler.ts:216
Parameters
- e: MouseEvent
Returns void

Protected updateSashState

updateSashState(sidePanelElement: null | Panel, sidePanelCollapsed: boolean): void

- Defined in packages/core/src/browser/shell/side-panel-handler.ts:670
Parameters
- sidePanelElement: null | Panel
- sidePanelCollapsed: boolean
Returns void

Protected updateToolbarTitle

updateToolbarTitle(): void

- Defined in packages/core/src/browser/shell/side-panel-handler.ts:451
Returns void

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Returns SidePanelHandler

Properties

Protected Readonly applicationStateService

bottomMenu

container

Protected Readonly contextMenuRenderer

dockPanel

Protected Readonly dockPanelFactory

Protected options

Protected side

Protected sidebarBottomWidgetFactory

Type declaration

Returns SidebarBottomMenuWidget

Protected sidebarTopWidgetFactory

Type declaration

Returns SidebarTopMenuWidget

Protected splitPositionHandler

Readonly state

tabBar

Protected tabBarRendererFactory

Type declaration

Returns TabBarRenderer

Protected tabBarToolBarFactory

Type declaration

Returns TabBarToolbar

Protected tabBarToolBarRegistry

Protected Readonly toDisposeOnCurrentTabChanged

toolBar

topMenu

Static Protected Readonly rankProperty

Methods

activate

Parameters

id: string

Returns undefined | Widget

addBottomMenu

Parameters

menu: SidebarMenu

Returns void

addTopMenu

Parameters

menu: SidebarMenu

Returns void

addWidget

Parameters

widget: Widget

options: SidePanel.WidgetOptions

Returns void

collapse

Returns Promise<void>

create

Parameters

side: "left" | "right"

options: SidePanel.Options

Returns void

Protected createContainer

Returns Panel

Protected createSideBar

Returns SideTabBar

Protected createSidePanel

Returns TheiaDockPanel

Protected createSidebarBottomMenu

Returns SidebarBottomMenuWidget

Protected createSidebarMenu

Type Parameters

T extends SidebarMenuWidget<T>

Parameters

factory: (() => T)

Returns T

Returns T

Protected createSidebarTopMenu

Returns SidebarTopMenuWidget

Protected createToolbar