Interface: ISearchService

molecule.ISearchService

Hierarchy

• Component<ISearchProps>

  ↳ ISearchService

Implemented by

• SearchService

Properties

state

• Protected Abstract state: ISearchProps

Inherited from

Component.state

Defined in

src/react/component.ts:42

Methods

count

▸ count(name): number

Count the service event

Parameters

Name	Type	Description
name	string	Event name

Returns

number

Inherited from

Component.count

Defined in

src/common/event/eventBus.ts:28

---

emit

▸ emit(name, ...args): void

Emit the service event

Parameters

Name	Type	Description
name	string	Event name
...args	any	Arguments

Returns

void

Inherited from

Component.emit

Defined in

src/common/event/eventBus.ts:20

---

forceUpdate

▸ forceUpdate(): void

Force to update the Component

Returns

void

Inherited from

Component.forceUpdate

Defined in

src/react/component.ts:79

---

getState

▸ getState(): ISearchProps

Get the Component state

Returns

ISearchProps

Inherited from

Component.getState

Defined in

src/react/component.ts:83

---

onChange

▸ onChange(callback): void

Listen to the event about the value of search input changed

Parameters

Name	Type
callback	(value: string, replaceValue: string) => void

Returns

void

Defined in

src/services/workbench/searchService.ts:63

---

onReplaceAll

▸ onReplaceAll(callback): void

Listen to the event about replace all text in result

Parameters

Name	Type
callback	() => void

Returns

void

Defined in

src/services/workbench/searchService.ts:82

---

onResultClick

▸ onResultClick(callback): void

Listen to the click event in result data

Parameters

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

Returns

void

Defined in

src/services/workbench/searchService.ts:86

---

onSearch

▸ onSearch(callback): void

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

Parameters

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

Returns

void

Defined in

src/services/workbench/searchService.ts:67

---

onUpdateState

▸ onUpdateState(callback): void

Listen to the Component state update event

Parameters

Name	Type
callback	(prevState: ISearchProps, nextState: ISearchProps) => void

Returns

void

Inherited from

Component.onUpdateState

Defined in

src/react/component.ts:71

---

removeOnUpdateState

▸ removeOnUpdateState(): void

Remove the Component update event listening

Returns

void

Inherited from

Component.removeOnUpdateState

Defined in

src/react/component.ts:75

---

render

▸ render(nextState?): void

Initiative notify the component to render the view by the state

Parameters

Name	Type
nextState?	ISearchProps

Returns

void

Inherited from

Component.render

Defined in

src/react/component.ts:67

---

reset

▸ reset(): void

Reset the search input data

Returns

void

Defined in

src/services/workbench/searchService.ts:59

---

setReplaceValue

▸ setReplaceValue(value?): void

Set replace value for replace input

Parameters

Name	Type
value?	string

Returns

void

Defined in

src/services/workbench/searchService.ts:27

---

setResult

▸ setResult(value?): void

Set result data for searching result

Parameters

Name	Type
value?	ITreeNodeItemProps<any>[]

Returns

void

Defined in

src/services/workbench/searchService.ts:31

---

setSearchValue

▸ setSearchValue(value?): void

Set search value for search input

Parameters

Name	Type
value?	string

Returns

void

Defined in

src/services/workbench/searchService.ts:23

---

setState

▸ setState(values, callback?): void

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

Parameters

Name	Type	Description
values	Partial<ISearchProps>	update target state values
callback?	(prevState: ISearchProps, nextState: ISearchProps) => void	-

Returns

void

Inherited from

Component.setState

Defined in

src/react/component.ts:54

---

setValidateInfo

▸ setValidateInfo(info): void

Set informations about validating,

Parameters

Name	Type	Description
info	undefined | string | { text: string ; type: "warning" | "info" | "error" }	If provided a string, molecule will set it type as info

Returns

void

Defined in

src/services/workbench/searchService.ts:19

---

subscribe

▸ subscribe(name, callback): void

Subscribe the service event

Parameters

Name	Type	Description
name	string | string[]	Event name
callback	Function	Callback function

Returns

void

Inherited from

Component.subscribe

Defined in

src/common/event/eventBus.ts:11

---

toggleCaseSensitive

▸ toggleCaseSensitive(): void

Toggle the rule for case senstitive when searching

Returns

void

Defined in

src/services/workbench/searchService.ts:39

---

toggleMode

▸ toggleMode(status): void

Toggle search mode, true for replace mode

Parameters

Name	Type
status	boolean

Returns

void

Defined in

src/services/workbench/searchService.ts:35

---

togglePreserveCase

▸ togglePreserveCase(): void

Toggle the rule for preserving case when replacing

Returns

void

Defined in

src/services/workbench/searchService.ts:51

---

toggleRegex

▸ toggleRegex(): void

Toggle the rule for enabling regex when searching

Returns

void

Defined in

src/services/workbench/searchService.ts:47

---

toggleWholeWord

▸ toggleWholeWord(): void

Toggle the rule for finding whole word when searching

Returns

void

Defined in

src/services/workbench/searchService.ts:43

---

unsubscribe

▸ unsubscribe(name): void

Unsubscribe the specific event

Parameters

Name	Type	Description
name	any	The event name

Returns

void

Inherited from

Component.unsubscribe

Defined in

src/common/event/eventBus.ts:37

---

updateStatus

▸ updateStatus(addonId, checked): void

Update the status of specific addon icon to checked

Parameters

Name	Type
addonId	string
checked	boolean

Returns

void

Defined in

src/services/workbench/searchService.ts:55