跳到主要内容
版本:1.x

Class: ExplorerService

molecule.ExplorerService

Hierarchy

Implements

Constructors

constructor

new ExplorerService()

Overrides

Component.constructor

Defined in

services/workbench/explorer/explorerService.ts:96

Properties

state

Protected state: IExplorer

Implementation of

IExplorerService.state

Overrides

Component.state

Defined in

services/workbench/explorer/explorerService.ts:95

Methods

addAction

addAction(action): void

Only add an action in toolbar actions

Parameters

NameType
actionIMenuItemProps | IMenuItemProps[]

Returns

void

Implementation of

IExplorerService.addAction

Defined in

services/workbench/explorer/explorerService.ts:210


addPanel

addPanel(data): void

Add a new panel, as well as add a new data for toolbar data

Parameters

NameType
dataIExplorerPanelItem | IExplorerPanelItem[]

Returns

void

Implementation of

IExplorerService.addPanel

Defined in

services/workbench/explorer/explorerService.ts:177


count

count(name): number

Count the service event

Parameters

NameTypeDescription
namestringEvent name

Returns

number

Implementation of

IExplorerService.count

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

Implementation of

IExplorerService.emit

Inherited from

Component.emit

Defined in

common/event/eventBus.ts:20


forceUpdate

forceUpdate(): void

Force to update the Component

Returns

void

Implementation of

IExplorerService.forceUpdate

Inherited from

Component.forceUpdate

Defined in

react/component.ts:81


getAction

getAction(id): undefined | IMenuItemProps

Get the specific action in toolbar actions

Parameters

NameType
idUniqueId

Returns

undefined | IMenuItemProps

Implementation of

IExplorerService.getAction

Defined in

services/workbench/explorer/explorerService.ts:111


getState

getState(): IExplorer

Get the Component state

Returns

IExplorer

Implementation of

IExplorerService.getState

Inherited from

Component.getState

Defined in

react/component.ts:85


onClick

onClick(callback): void

Listen to the Explorer header toolbar click event

Parameters

NameType
callback(e: MouseEvent, item: IActionBarItemProps<any>) => void

Returns

void

Implementation of

IExplorerService.onClick

Defined in

services/workbench/explorer/explorerService.ts:322


onCollapseAllFolders

onCollapseAllFolders(callback): void

Listen to the FolderTree Panel collapse all folders event

Parameters

NameType
callback() => void

Returns

void

Implementation of

IExplorerService.onCollapseAllFolders

Defined in

services/workbench/explorer/explorerService.ts:332


onPanelToolbarClick

onPanelToolbarClick(callback): void

Listen to the Explorer panel toolbar click event

Parameters

NameType
callback(panel: IExplorerPanelItem, toolbarId: string) => void

Returns

void

Implementation of

IExplorerService.onPanelToolbarClick

Defined in

services/workbench/explorer/explorerService.ts:336


onRemovePanel

onRemovePanel(callback): void

Listen to the Explorer panel remove event

Parameters

NameType
callback(panel: IExplorerPanelItem) => void

Returns

void

Implementation of

IExplorerService.onRemovePanel

Defined in

services/workbench/explorer/explorerService.ts:328


onUpdateState

onUpdateState(listener): void

Listen to the Component state update event

Parameters

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

Returns

void

Implementation of

IExplorerService.onUpdateState

Inherited from

Component.onUpdateState

Defined in

react/component.ts:73


removeAction

removeAction(id): void

Remove the specific header toolbar action

Parameters

NameType
idUniqueId

Returns

void

Implementation of

IExplorerService.removeAction

Defined in

services/workbench/explorer/explorerService.ts:257


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

Implementation of

IExplorerService.removeOnUpdateState

Inherited from

Component.removeOnUpdateState

Defined in

react/component.ts:77


removePanel

removePanel(id): void

Remove a panel via id, as well as remove the corresponding action bar

Parameters

NameType
idUniqueId

Returns

void

Implementation of

IExplorerService.removePanel

Defined in

services/workbench/explorer/explorerService.ts:242


render

render(nextState?): void

Initiative notify the component to render the view by the state

Parameters

NameType
nextState?IExplorer

Returns

void

Implementation of

IExplorerService.render

Inherited from

Component.render

Defined in

react/component.ts:69


reset

reset(): void

Reset the ExplorerService state, it's mainly for customizing the Explorer

Returns

void

Implementation of

IExplorerService.reset

Defined in

services/workbench/explorer/explorerService.ts:315


setExpandedPanels

setExpandedPanels(activePanelKeys): void

Set expanded Panels of Explore

Parameters

NameType
activePanelKeysUniqueId[]

Returns

void

Implementation of

IExplorerService.setExpandedPanels

Defined in

services/workbench/explorer/explorerService.ts:101


setState

setState(values, callback?): void

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

Parameters

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

Returns

void

Implementation of

IExplorerService.setState

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

Implementation of

IExplorerService.subscribe

Inherited from

Component.subscribe

Defined in

common/event/eventBus.ts:11


toggleHeaderBar

toggleHeaderBar(id): void

Only toggle the toolbar status

Parameters

NameType
idUniqueId

Returns

void

Implementation of

IExplorerService.toggleHeaderBar

Defined in

services/workbench/explorer/explorerService.ts:293


toggleIcon

Private toggleIcon(icon?): "" | "check"

Parameters

NameType
icon?string

Returns

"" | "check"

Defined in

services/workbench/explorer/explorerService.ts:107


togglePanel

togglePanel(id): void

Toggle panel hidden, as well as toggle the toolbar status

Parameters

NameType
idUniqueId

Returns

void

Implementation of

IExplorerService.togglePanel

Defined in

services/workbench/explorer/explorerService.ts:277


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

Implementation of

IExplorerService.unsubscribe

Inherited from

Component.unsubscribe

Defined in

common/event/eventBus.ts:37


updateAction

updateAction(action): void

Update the action in toolbar actions

Parameters

NameType
actionPartial<IMenuItemProps>

Returns

void

Implementation of

IExplorerService.updateAction

Defined in

services/workbench/explorer/explorerService.ts:145


updatePanel

updatePanel(data): void

Update the panels data, as well as modify toolbar data

Parameters

NameType
dataPartial<IExplorerPanelItem>

Returns

void

Implementation of

IExplorerService.updatePanel

Defined in

services/workbench/explorer/explorerService.ts:117