Class KeyHandler

constructor

• new KeyHandler(
      languageModel_: LanguageModel,
      localizedStrings_: LocalizedStrings,
  ): KeyHandler

  Parameters

  • languageModel_: LanguageModel
  • localizedStrings_: LocalizedStrings

  Returns KeyHandler

ReadonlydictionaryServices

allowChangingPriorTone

• get allowChangingPriorTone(): boolean

  Returns boolean

• set allowChangingPriorTone(flag: boolean): void

  Parameters

  • flag: boolean

  Returns void

bopomofoFontAnnotationSupportEnabled

• get bopomofoFontAnnotationSupportEnabled(): boolean

  Returns boolean

• set bopomofoFontAnnotationSupportEnabled(flag: boolean): void

  Parameters

  • flag: boolean

  Returns void

ctrlEnterOption

• get ctrlEnterOption(): CtrlEnterOption

  Returns CtrlEnterOption

• set ctrlEnterOption(flag: CtrlEnterOption): void

  Parameters

  • flag: CtrlEnterOption

  Returns void

cursor

• get cursor(): number

  Returns number

• set cursor(index: number): void

  Parameters

  • index: number

  Returns void

escKeyClearsEntireComposingBuffer

• get escKeyClearsEntireComposingBuffer(): boolean

  Returns boolean

• set escKeyClearsEntireComposingBuffer(value: boolean): void

  Parameters

  • value: boolean

  Returns void

gridLength

• get gridLength(): number

  Returns number

halfWidthPunctuation

• get halfWidthPunctuation(): boolean

  Returns boolean

• set halfWidthPunctuation(flag: boolean): void

  Parameters

  • flag: boolean

  Returns void

keyboardLayout

• get keyboardLayout(): BopomofoKeyboardLayout

  Returns BopomofoKeyboardLayout

• set keyboardLayout(value: BopomofoKeyboardLayout): void

  Parameters

  • value: BopomofoKeyboardLayout

  Returns void

languageCode

• get languageCode(): string

  Returns string

• set languageCode(value: string): void

  Parameters

  • value: string

  Returns void

moveCursorAfterSelection

• get moveCursorAfterSelection(): boolean

  Returns boolean

• set moveCursorAfterSelection(value: boolean): void

  Parameters

  • value: boolean

  Returns void

onOpenUrl

• get onOpenUrl(): ((input: string) => void) | undefined

  Returns ((input: string) => void) | undefined

• set onOpenUrl(onOpenUrl: ((input: string) => void) | undefined): void

  Parameters

  • onOpenUrl: ((input: string) => void) | undefined

  Returns void

putLowercaseLettersToComposingBuffer

• get putLowercaseLettersToComposingBuffer(): boolean

  Returns boolean

• set putLowercaseLettersToComposingBuffer(value: boolean): void

  Parameters

  • value: boolean

  Returns void

repeatedPunctuationToSelectCandidateEnabled

• get repeatedPunctuationToSelectCandidateEnabled(): boolean

  Returns boolean

• set repeatedPunctuationToSelectCandidateEnabled(flag: boolean): void

  Parameters

  • flag: boolean

  Returns void

selectPhraseAfterCursorAsCandidate

• get selectPhraseAfterCursorAsCandidate(): boolean

  Returns boolean

• set selectPhraseAfterCursorAsCandidate(value: boolean): void

  Parameters

  • value: boolean

  Returns void

traditionalMode

• get traditionalMode(): boolean

  Returns boolean

• set traditionalMode(flag: boolean): void

  Parameters

  • flag: boolean

  Returns void

addExcludedPhrase

• addExcludedPhrase(reading: string, phrase: string): void

  Parameters

  • reading: string
  • phrase: string

  Returns void

addUserPhrase

• addUserPhrase(reading: string, phrase: string): void

  Parameters

  • reading: string
  • phrase: string

  Returns void

buildChoosingCandidateState

• buildChoosingCandidateState(originalCursorIndex: number): ChoosingCandidate

  Parameters

  • originalCursorIndex: number

  Returns ChoosingCandidate

buildInputtingState

• buildInputtingState(): Inputting

  Returns Inputting

candidatePanelCancelled

• candidatePanelCancelled(
      originalCursorIndex: number,
      stateCallback: (state: InputState) => void,
  ): void

  Parameters

  • originalCursorIndex: number
  • stateCallback: (state: InputState) => void

  Returns void

candidatePanelPunctuationListCancelled

• candidatePanelPunctuationListCancelled(
      originalCursorIndex: number,
      stateCallback: (state: InputState) => void,
  ): void

  Parameters

  • originalCursorIndex: number
  • stateCallback: (state: InputState) => void

  Returns void

candidatePanelPunctuationMaybeEntered

• candidatePanelPunctuationMaybeEntered(
      maybePunctuation: string,
      originalCursorIndex: number,
      stateCallback: (newState: any) => void,
  ): boolean

  Parameters

  • maybePunctuation: string
  • originalCursorIndex: number
  • stateCallback: (newState: any) => void

  Returns boolean

candidateSelected

• candidateSelected(
      candidate: Candidate,
      originalCursorIndex: number,
      stateCallback: (state: InputState) => void,
  ): void

  Parameters

  • candidate: Candidate
  • originalCursorIndex: number
  • stateCallback: (state: InputState) => void

  Returns void

exportSettings

• exportSettings(): KeyHandlerSettings

  Returns KeyHandlerSettings

handle

• handle(
      key: Key,
      state: InputState,
      stateCallback: (state: InputState) => void,
      errorCallback: () => void,
  ): boolean

  Parameters

  • key: Key
  • state: InputState
  • stateCallback: (state: InputState) => void
  • errorCallback: () => void

  Returns boolean

handleNumberInput

• handleNumberInput(
      key: Key,
      state: NumberInput,
      stateCallback: (state: InputState) => void,
      errorCallback: () => void,
  ): boolean

  Parameters

  • key: Key
  • state: NumberInput
  • stateCallback: (state: InputState) => void
  • errorCallback: () => void

  Returns boolean

handlePunctuationKeyInCandidatePanelForTraditionalMode

• handlePunctuationKeyInCandidatePanelForTraditionalMode(
      key: Key,
      defaultCandidate: string,
      stateCallback: (state: InputState) => void,
      errorCallback: () => void,
  ): boolean

  Parameters

  • key: Key
  • defaultCandidate: string
  • stateCallback: (state: InputState) => void
  • errorCallback: () => void

  Returns boolean

inputtingStateWithMarkingStateUnsupportedTooltip

• inputtingStateWithMarkingStateUnsupportedTooltip(state: Inputting): Inputting

  Parameters

  • state: Inputting

  Returns Inputting

reset

• reset(): void

  Returns void

restoreSettings

• restoreSettings(settings: KeyHandlerSettings): void

  Parameters

  • settings: KeyHandlerSettings

  Returns void