跳到主要内容
版本:Next

Class: SearchService

molecule.SearchService

Hierarchy

Implements

Constructors

constructor

new SearchService()

Overrides

Component.constructor

Defined in

services/workbench/searchService.ts:101

Properties

builtinService

Private builtinService: IBuiltinService

Defined in

services/workbench/searchService.ts:100


state

Protected state: ISearchProps

Implementation of

ISearchService.state

Overrides

Component.state

Defined in

services/workbench/searchService.ts:99

Methods

count

count(name): number

Count the service event

Parameters

NameTypeDescription
namestringEvent name

Returns

number

Implementation of

ISearchService.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

ISearchService.emit

Inherited from

Component.emit

Defined in

common/event/eventBus.ts:20


forceUpdate

forceUpdate(): void

Force to update the Component

Returns

void

Implementation of

ISearchService.forceUpdate

Inherited from

Component.forceUpdate

Defined in

react/component.ts:81


getState

getState(): ISearchProps

Get the Component state

Returns

ISearchProps

Implementation of

ISearchService.getState

Inherited from

Component.getState

Defined in

react/component.ts:85


onChange

onChange(callback): void

Listen to the event about the value of search input changed

Parameters

NameType
callback(value: string, replaceValue: string) => void

Returns

void

Implementation of

ISearchService.onChange

Defined in

services/workbench/searchService.ts:230


onReplaceAll

onReplaceAll(callback): void

Listen to the event about replace all text in result

Parameters

NameType
callback() => void

Returns

void

Implementation of

ISearchService.onReplaceAll

Defined in

services/workbench/searchService.ts:226


onResultClick

onResultClick(callback): void

Listen to the click event in result data

Parameters

NameType
callback(item: ITreeNodeItemProps<any>, resultData: ITreeNodeItemProps<any>[]) => void

Returns

void

Implementation of

ISearchService.onResultClick

Defined in

services/workbench/searchService.ts:251


onSearch

onSearch(callback): void

Listen to the event about going to search result via values or config changed

Parameters

NameType
callback(value: string, replaceValue: string, config: { isCaseSensitive: boolean ; isRegex: boolean ; isWholeWords: boolean ; preserveCase: boolean }) => void

Returns

void

Implementation of

ISearchService.onSearch

Defined in

services/workbench/searchService.ts:236


onUpdateState

onUpdateState(listener): void

Listen to the Component state update event

Parameters

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

Returns

void

Implementation of

ISearchService.onUpdateState

Inherited from

Component.onUpdateState

Defined in

react/component.ts:73


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

ISearchService.removeOnUpdateState

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?ISearchProps

Returns

void

Implementation of

ISearchService.render

Inherited from

Component.render

Defined in

react/component.ts:69


reset

reset(): void

Reset the search input data

Returns

void

Implementation of

ISearchService.reset

Defined in

services/workbench/searchService.ts:209


setReplaceValue

setReplaceValue(value?): void

Set replace value for replace input

Parameters

NameType
value?string

Returns

void

Implementation of

ISearchService.setReplaceValue

Defined in

services/workbench/searchService.ts:125


setResult

setResult(value?): void

Set result data for searching result

Parameters

NameType
value?ITreeNodeItemProps<any>[]

Returns

void

Implementation of

ISearchService.setResult

Defined in

services/workbench/searchService.ts:131


setSearchValue

setSearchValue(value?): void

Set search value for search input

Parameters

NameType
value?string

Returns

void

Implementation of

ISearchService.setSearchValue

Defined in

services/workbench/searchService.ts:119


setState

setState(values, callback?): void

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

Parameters

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

Returns

void

Implementation of

ISearchService.setState

Inherited from

Component.setState

Defined in

react/component.ts:56


setValidateInfo

setValidateInfo(info): void

Set informations about validating,

Parameters

NameType
infoundefined | string | { text: string ; type: "warning" | "info" | "error" }

Returns

void

Implementation of

ISearchService.setValidateInfo

Defined in

services/workbench/searchService.ts:107


subscribe

subscribe(name, listener): void

Subscribe the service event

Parameters

NameTypeDescription
namestring | string[]Event name
listenerFunctionListener function

Returns

void

Implementation of

ISearchService.subscribe

Inherited from

Component.subscribe

Defined in

common/event/eventBus.ts:11


toggleCaseSensitive

toggleCaseSensitive(): void

Toggle the rule for case senstitive when searching

Returns

void

Implementation of

ISearchService.toggleCaseSensitive

Defined in

services/workbench/searchService.ts:143


toggleMode

toggleMode(status): void

Toggle search mode, true for replace mode

Parameters

NameType
statusboolean

Returns

void

Implementation of

ISearchService.toggleMode

Defined in

services/workbench/searchService.ts:137


togglePreserveCase

togglePreserveCase(): void

Toggle the rule for preserving case when replacing

Returns

void

Implementation of

ISearchService.togglePreserveCase

Defined in

services/workbench/searchService.ts:182


toggleRegex

toggleRegex(): void

Toggle the rule for enabling regex when searching

Returns

void

Implementation of

ISearchService.toggleRegex

Defined in

services/workbench/searchService.ts:170


toggleWholeWord

toggleWholeWord(): void

Toggle the rule for finding whole word when searching

Returns

void

Implementation of

ISearchService.toggleWholeWord

Defined in

services/workbench/searchService.ts:158


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

ISearchService.unsubscribe

Inherited from

Component.unsubscribe

Defined in

common/event/eventBus.ts:37


updateStatus

updateStatus(addonId, checked): void

Update the status of specific addon icon to checked

Parameters

NameType
addonIdstring
checkedboolean

Returns

void

Implementation of

ISearchService.updateStatus

Defined in

services/workbench/searchService.ts:194