Class CandidateController

Helps to control the candidate window.

Index

Constructors

Accessors

currentPage currentPageIndex selectedCandidate selectedIndex totalPageCount

Methods

goToFirst goToLast goToNextItem goToNextPage goToNextPageButFistWhenAtEnd goToPreviousItem goToPreviousPage selectedCandidateWithKey update

Constructors

constructor

new CandidateController(): CandidateController
Returns CandidateController

Accessors

currentPage

get currentPage(): CandidateWrapper[]
Returns in candidate in the current page.

Returns CandidateWrapper[]
- Defined in McBopomofo/CandidateController.ts:105

currentPageIndex

get currentPageIndex(): number
Returns the current page index.

Returns number
- Defined in McBopomofo/CandidateController.ts:84

selectedCandidate

get selectedCandidate(): Candidate
Returns the selected candidate.

Returns Candidate
- Defined in McBopomofo/CandidateController.ts:69

selectedIndex

get selectedIndex(): number
Returns the selected index.

Returns number
- Defined in McBopomofo/CandidateController.ts:74
set selectedIndex(input): void
Sets the selected index.
Parameters
- input: number
Returns void
- Defined in McBopomofo/CandidateController.ts:79

totalPageCount

get totalPageCount(): number
Returns the total page count.

Returns number
- Defined in McBopomofo/CandidateController.ts:89

Methods

goToFirst

goToFirst(): void
Moves to the first one of all candidates.

Returns void
- Defined in McBopomofo/CandidateController.ts:128

goToLast

goToLast(): void
Moves to the last one of all candidates.

Returns void
- Defined in McBopomofo/CandidateController.ts:133

goToNextItem

goToNextItem(): void
Moves to the next candidate.

Returns void
- Defined in McBopomofo/CandidateController.ts:147

goToNextPage

goToNextPage(): void
Moves to the next page.

Returns void
- Defined in McBopomofo/CandidateController.ts:165

goToNextPageButFistWhenAtEnd

goToNextPageButFistWhenAtEnd(): void
Moves to the next page. If it is already at the last page, moves to the first page.

Returns void
- Defined in McBopomofo/CandidateController.ts:177

goToPreviousItem

goToPreviousItem(): void
Moves to the previous candidate.

Returns void
- Defined in McBopomofo/CandidateController.ts:139

goToPreviousPage

goToPreviousPage(): void
Moves to the previous page.

Returns void
- Defined in McBopomofo/CandidateController.ts:155

selectedCandidateWithKey

selectedCandidateWithKey(key): undefined | Candidate
Pass a key and return the corresponding candidate.
Parameters
- key: string
  The key from the keyboard, such as "1", "2", "a" and so on.
Returns undefined | Candidate
The corresponding candidate or the undefined value.
- Defined in McBopomofo/CandidateController.ts:52

update

update(candidates, keyCaps): void
Updates the content of the candidate window.
Parameters
- candidates: Candidate[]
  All candidates.
- keyCaps: string[]
  The key caps such as "123456789", "asdfghjkl" and so on.
Returns void
- Defined in McBopomofo/CandidateController.ts:98