Class SidePanelHandler

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.

Index

Constructors

constructor

Constructors

constructor

new SidePanelHandler(): SidePanelHandler
Returns SidePanelHandler

Properties

additionalViewsMenu

additionalViewsMenu: AdditionalViewsMenuWidget

Conditional menu placed below the tabBar. Manages overflowing/hidden tabs. Is only visible if there are overflowing tabs.

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

`Protected`sidebarTopWidgetFactory

sidebarTopWidgetFactory: () => 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

`Protected`tabBarToolBarFactory

tabBarToolBarFactory: () => TabBarToolbar

`Protected`tabBarToolBarRegistry

tabBarToolBarRegistry: TabBarToolbarRegistry

`Protected` `Readonly`toDisposeOnCurrentTabChanged

toDisposeOnCurrentTabChanged: DisposableCollection = ...

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.

`Protected` `Static` `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
Activate a widget residing in the side panel by ID.
Parameters
- id: string
Returns undefined | Widget
the activated widget if it was found
- Defined in packages/core/src/browser/shell/side-panel-handler.ts:347

addBottomMenu

addBottomMenu(menu: SidebarMenu): void
Add a menu to the sidebar bottom.

If the menu is already added, it will be ignored.
Parameters
- menu: SidebarMenu
Returns void
- Defined in packages/core/src/browser/shell/side-panel-handler.ts:455

addTopMenu

addTopMenu(menu: SidebarMenu): void
Add a menu to the sidebar top.

If the menu is already added, it will be ignored.
Parameters
- menu: SidebarMenu
Returns void
- Defined in packages/core/src/browser/shell/side-panel-handler.ts:437

addWidget

addWidget(widget: Widget, options: SidePanel.WidgetOptions): void
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
- Defined in packages/core/src/browser/shell/side-panel-handler.ts:425

collapse

collapse(): Promise<void>
Collapse the sidebar so no items are expanded.

Returns Promise<void>
- Defined in packages/core/src/browser/shell/side-panel-handler.ts:410

create

create(side: "left" | "right", options: SidePanel.Options): void
Create the side bar and dock panel widgets.
Parameters
- side: "left" | "right"
- options: SidePanel.Options
Returns void
- Defined in packages/core/src/browser/shell/side-panel-handler.ts:138

`Protected`createAdditionalViewsWidget

createAdditionalViewsWidget(): AdditionalViewsMenuWidget
Returns AdditionalViewsMenuWidget
- Defined in packages/core/src/browser/shell/side-panel-handler.ts:211

`Protected`createContainer

createContainer(): Panel
Returns Panel
- Defined in packages/core/src/browser/shell/side-panel-handler.ts:248

`Protected`createSideBar

createSideBar(): SideTabBar
Returns SideTabBar
- Defined in packages/core/src/browser/shell/side-panel-handler.ts:152

`Protected`createSidebarBottomMenu

createSidebarBottomMenu(): SidebarBottomMenuWidget
Returns SidebarBottomMenuWidget
- Defined in packages/core/src/browser/shell/side-panel-handler.ts:222

`Protected`createSidebarMenu

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

`Protected`createSidebarTopMenu

createSidebarTopMenu(): SidebarTopMenuWidget
Returns SidebarTopMenuWidget
- Defined in packages/core/src/browser/shell/side-panel-handler.ts:218

`Protected`createSidePanel

createSidePanel(): TheiaDockPanel
Returns TheiaDockPanel
- Defined in packages/core/src/browser/shell/side-panel-handler.ts:190

`Protected`createToolbar

createToolbar(): SidePanelToolbar
Returns SidePanelToolbar
- Defined in packages/core/src/browser/shell/side-panel-handler.ts:205

expand

expand(id?: string): undefined | Widget
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
- Optionalid: string
Returns undefined | Widget
the expanded widget if it was found
- Defined in packages/core/src/browser/shell/side-panel-handler.ts:362

`Protected`getDefaultPanelSize

getDefaultPanelSize(): undefined | number
Determine the default size to apply when the panel is expanded for the first time.

Returns undefined | number
- Defined in packages/core/src/browser/shell/side-panel-handler.ts:576

getLayoutData

getLayoutData(): SidePanel.LayoutData
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
- Defined in packages/core/src/browser/shell/side-panel-handler.ts:290

`Protected`getPanelSize

getPanelSize(): undefined | number
Compute the current width of the panel. This implementation assumes that the parent of the panel container is a SplitPanel.

Returns undefined | number
- Defined in packages/core/src/browser/shell/side-panel-handler.ts:554

`Protected`onCurrentTabChanged

onCurrentTabChanged(
sender: SideTabBar,
__namedParameters: TabBar.ICurrentChangedArgs<Widget>,
): void
Handle a currentChanged signal from the sidebar. The side panel is refreshed so it displays the new selected widget.
Parameters
- sender: SideTabBar
- __namedParameters: TabBar.ICurrentChangedArgs<Widget>
Returns void
- Defined in packages/core/src/browser/shell/side-panel-handler.ts:609

`Protected`onTabDetachRequested

onTabDetachRequested(
sender: SideTabBar,
__namedParameters: ITabDetachRequestedArgs<Widget>,
): void
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
- Defined in packages/core/src/browser/shell/side-panel-handler.ts:627

`Protected`onTabsOverflowChanged

onTabsOverflowChanged(
sender: SideTabBar,
event: { startIndex: number; titles: Title<Widget>[] },
): void
Parameters
- sender: SideTabBar
- event: { startIndex: number; titles: Title<Widget>[] }
Returns void
- Defined in packages/core/src/browser/shell/side-panel-handler.ts:657

`Protected`onWidgetAdded

onWidgetAdded(sender: DockPanel, widget: Widget): void
Handle the widgetAdded signal from the dock panel. The widget's title is inserted into the tab bar according to the rankProperty value that may be attached to the widget.
Parameters
- sender: DockPanel
- widget: Widget
Returns void
- Defined in packages/core/src/browser/shell/side-panel-handler.ts:669

`Protected`onWidgetRemoved

onWidgetRemoved(sender: DockPanel, widget: Widget): void
Handle the widgetRemoved signal from the dock panel. The widget's title is also removed from the tab bar.
Parameters
- sender: DockPanel
- widget: Widget
Returns void
- Defined in packages/core/src/browser/shell/side-panel-handler.ts:691

refresh

refresh(): void
Refresh the visibility of the side bar and dock panel.

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

removeBottomMenu

removeBottomMenu(menuId: string): void
Remove a menu from the sidebar bottom.
Parameters
- menuId: string
  id of the menu to remove
Returns void
- Defined in packages/core/src/browser/shell/side-panel-handler.ts:464

removeTopMenu

removeTopMenu(menuId: string): void
Remove a menu from the sidebar top.
Parameters
- menuId: string
  id of the menu to remove
Returns void
- Defined in packages/core/src/browser/shell/side-panel-handler.ts:446

resize

resize(size: number): void
Sets the size of the side panel.
Parameters
- size: number
  the desired size (width) of the panel in pixels.
Returns void
- Defined in packages/core/src/browser/shell/side-panel-handler.ts:542

setLayoutData

setLayoutData(layoutData: SidePanel.LayoutData): void
Apply a side panel layout that has been previously created with getLayoutData.
Parameters
- layoutData: SidePanel.LayoutData
Returns void
- Defined in packages/core/src/browser/shell/side-panel-handler.ts:306

`Protected`setPanelSize

setPanelSize(size: number): Promise<void>
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>
- Defined in packages/core/src/browser/shell/side-panel-handler.ts:587

`Protected`showContextMenu

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

`Protected`updateSashState

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

`Protected`updateToolbarTitle

updateToolbarTitle(): void
should be a property to preserve fn identity

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

Class SidePanelHandler

Index

Constructors

Properties

Methods

Constructors

constructor

Returns SidePanelHandler

Properties

additionalViewsMenu

ProtectedadditionalViewsMenuFactory

Protected ReadonlyapplicationStateService

bottomMenu

container

Protected ReadonlycontextMenuRenderer

dockPanel

Protected ReadonlydockPanelFactory

Protectedoptions

Protectedside

ProtectedsidebarBottomWidgetFactory

ProtectedsidebarTopWidgetFactory

ProtectedsplitPositionHandler

Readonlystate

tabBar

ProtectedtabBarRendererFactory

ProtectedtabBarToolBarFactory

ProtectedtabBarToolBarRegistry

Protected ReadonlytoDisposeOnCurrentTabChanged

toolBar

topMenu

Protected Static ReadonlyrankProperty

Methods

activate

Parameters

Returns undefined | Widget

addBottomMenu

Parameters

Returns void

addTopMenu

Parameters

Returns void

addWidget

Parameters

Returns void

collapse

Returns Promise<void>

create

Parameters

Returns void

ProtectedcreateAdditionalViewsWidget

Returns AdditionalViewsMenuWidget

ProtectedcreateContainer

Returns Panel

ProtectedcreateSideBar

Returns SideTabBar

ProtectedcreateSidebarBottomMenu

Returns SidebarBottomMenuWidget

ProtectedcreateSidebarMenu

Type Parameters

Parameters

Returns T

ProtectedcreateSidebarTopMenu

Returns SidebarTopMenuWidget

ProtectedcreateSidePanel

Returns TheiaDockPanel

ProtectedcreateToolbar

Returns SidePanelToolbar

expand

Parameters

Returns undefined | Widget

ProtectedgetDefaultPanelSize

Returns undefined | number

getLayoutData

Returns SidePanel.LayoutData

ProtectedgetPanelSize

Returns undefined | number

ProtectedonCurrentTabChanged

Parameters

Returns void

ProtectedonTabDetachRequested

`Protected`additionalViewsMenuFactory

`Protected` `Readonly`applicationStateService

`Protected` `Readonly`contextMenuRenderer

`Protected` `Readonly`dockPanelFactory

`Protected`options

`Protected`side

`Protected`sidebarBottomWidgetFactory

`Protected`sidebarTopWidgetFactory

`Protected`splitPositionHandler

`Readonly`state

`Protected`tabBarRendererFactory

`Protected`tabBarToolBarFactory

`Protected`tabBarToolBarRegistry

`Protected` `Readonly`toDisposeOnCurrentTabChanged

`Protected` `Static` `Readonly`rankProperty

`Protected`createAdditionalViewsWidget

`Protected`createContainer

`Protected`createSideBar

`Protected`createSidebarBottomMenu

`Protected`createSidebarMenu

`Protected`createSidebarTopMenu

`Protected`createSidePanel

`Protected`createToolbar

`Protected`getDefaultPanelSize

`Protected`getPanelSize

`Protected`onCurrentTabChanged

`Protected`onTabDetachRequested

`Protected`onTabsOverflowChanged

`Protected`onWidgetAdded

`Protected`onWidgetRemoved

`Protected`setPanelSize

`Protected`showContextMenu

`Protected`updateSashState

`Protected`updateToolbarTitle