Skip to main content
Version: Next

Interface: IActivityBarService

molecule.IActivityBarService

Hierarchy

Implemented by

Properties

state

Protected Abstract state: IActivityBar

Inherited from

Component.state

Defined in

react/component.ts:44

Methods

add

add(data, isActive?): void

Add IActivityBarItem data

Parameters

NameTypeDescription
dataIActivityBarItem | IActivityBarItem[]-
isActive?booleanIf provide, Activity Bar will set data active automatically. Only works in one data

Returns

void

Defined in

services/workbench/activityBarService.ts:27


addContextMenu

addContextMenu(data): void

Add new contextMenus for the activityBar

Parameters

NameType
dataIActivityMenuItemProps | IActivityMenuItemProps[]

Returns

void

Defined in

services/workbench/activityBarService.ts:50


count

count(name): number

Count the service event

Parameters

NameTypeDescription
namestringEvent name

Returns

number

Inherited from

Component.count

Defined in

common/event/eventBus.ts:28


emit

emit(name, ...args): void

Emit the service event

Parameters

NameTypeDescription
namestringEvent name
...argsanyArguments

Returns

void

Inherited from

Component.emit

Defined in

common/event/eventBus.ts:20


forceUpdate

forceUpdate(): void

Force to update the Component

Returns

void

Inherited from

Component.forceUpdate

Defined in

react/component.ts:81


getState

getState(): IActivityBar

Get the Component state

Returns

IActivityBar

Inherited from

Component.getState

Defined in

react/component.ts:85


onChange

onChange(callback): any

Called when activity bar item which is not global is changed

Parameters

NameType
callback(prevSelectedKey?: UniqueId, nextSelectedKey?: UniqueId) => void

Returns

any

Defined in

services/workbench/activityBarService.ts:66


onClick

onClick(callback): any

Add click event listener

Parameters

NameType
callback(selectedKey: UniqueId, item: IActivityBarItem) => void

Returns

any

Defined in

services/workbench/activityBarService.ts:62


onUpdateState

onUpdateState(listener): void

Listen to the Component state update event

Parameters

NameType
listener(prevState: IActivityBar, nextState: IActivityBar) => void

Returns

void

Inherited from

Component.onUpdateState

Defined in

react/component.ts:73


remove

remove(id): void

Remove the specific activity bar by id

Parameters

NameType
idUniqueId | UniqueId[]

Returns

void

Defined in

services/workbench/activityBarService.ts:36


removeContextMenu

removeContextMenu(id): void

Remove the specific contextMenu item by id

Parameters

NameTypeDescription
idUniqueId | UniqueId[]contextmenu id

Returns

void

Defined in

services/workbench/activityBarService.ts:57


removeOnUpdateState

removeOnUpdateState(listener?): void

Remove the Component update event listening, default is remove all, also you can remove one by pass the listener

Parameters

NameType
listener?Function

Returns

void

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

NameType
nextState?IActivityBar

Returns

void

Inherited from

Component.render

Defined in

react/component.ts:69


reset

reset(): void

Reset the activityBar state data, if you want to whole customize the activityBar, you can reset it first, and then using the activityBar.add() method to fill the data you need.

Returns

void

Defined in

services/workbench/activityBarService.ts:22


setActive

setActive(id?): void

Set active bar

Parameters

NameType
id?UniqueId

Returns

void

Defined in

services/workbench/activityBarService.ts:31


setState

setState(values, callback?): void

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

Parameters

NameTypeDescription
valuesPartial<IActivityBar>update target state values
callback?(prevState: IActivityBar, nextState: IActivityBar) => void-

Returns

void

Inherited from

Component.setState

Defined in

react/component.ts:56


subscribe

subscribe(name, listener): void

Subscribe the service event

Parameters

NameTypeDescription
namestring | string[]Event name
listenerFunctionListener function

Returns

void

Inherited from

Component.subscribe

Defined in

common/event/eventBus.ts:11


toggleBar

toggleBar(id): void

Toggle the specific activity bar between show or hide

Parameters

NameTypeDescription
idUniqueIdactivity bar id

Returns

void

Defined in

services/workbench/activityBarService.ts:41


toggleContextMenuChecked

toggleContextMenuChecked(id): void

Toggle the contextMenu between checked or unchecked

Parameters

NameTypeDescription
idUniqueIdcontextmenu id

Returns

void

Defined in

services/workbench/activityBarService.ts:46


unsubscribe

unsubscribe(name, listener?): void

Unsubscribe the specific event and the listener function

Parameters

NameTypeDescription
nameanyThe event name
listener?Functionoptional, it unsubscribes events via name if not pass the listener function

Returns

void

Inherited from

Component.unsubscribe

Defined in

common/event/eventBus.ts:37