java.awt.im.spi
인터페이스 InputMethod

public interface InputMethod

복합 텍스트 입력을 지원하는 인풋 메서드를 위한 인터페이스를 정의합니다. 종래부터, 인풋 메서드는 중국어, 일본어, 한국어 등, 표준 사이즈의 키보드에서는 표현할 수 없는 문자가 다수 존재하는 언어에서의 텍스트 입력을 지원하고 있습니다. 이러한 인풋 메서드는 영어의 음성 텍스트 입력, 또는 타이어의 문자재순서부의 지원에도 사용됩니다.

InputMethod 서브 클래스는 인풋 메서드 체제로 로드하고 나서, API (InputContext.selectInputMethod ) 또는 사용자 인터페이스 (입력 방식의 변환 메뉴)를 통해서 선택할 수 있습니다.

도입된 버전 :

1.3

메서드 개요

void	activate () 즉시 입력 처리를 위한 인풋 메서드를 시작합니다.
void	deactivate (boolean isTemporary) 인풋 메서드를 종료합니다.
void	dispatchEvent (AWTEvent event) 인풋 메서드에 이벤트를 디스패치 합니다.
void	dispose () 인풋 메서드를 파기해, 이 메서드가 사용한 자원을 해방합니다.
void	endComposition () 이 컨텍스트 으로 현재 진행중의 입력 변환을 종료합니다.
Object	getControlObject () 이 인풋 메서드의 제어 객체 또는 null을 리턴합니다.
Locale	getLocale () 현재의 입력 로케일을 리턴합니다.
void	hideWindows () 이 인풋 메서드의 인스턴스 또는 클래스가 열린 모든 윈도우를 닫는지, 숨깁니다.
boolean	isCompositionEnabled () 이 인풋 메서드가 사용 가능한가 어떤가 판별합니다.
void	notifyClientWindowChange (Rectangle bounds) 클라이언트의 윈도우 위치 또는 상태의 변경을 이 인풋 메서드에 통지합니다.
void	reconvert () 재변환 조작을 개시합니다.
void	removeNotify () 클라이언트 컴퍼넌트가 포함 관계의 계층으로부터 삭제되고 있는지, 또는 인풋 메서드가 그 컴퍼넌트로 사용할 수 없게 되고 있는 것을 인풋 메서드에 통지합니다.
void	setCharacterSubsets (Character.Subset [] subsets) 이 인풋 메서드로 입력 가능한 Unicode 캐릭터셋의 부분집합을 설정합니다.
void	setCompositionEnabled (boolean enable) 파라미터 enable값에 응해, 변환의 인풋 메서드를 사용 가능 또는 사용 불가능하게 합니다.
void	setInputMethodContext (InputMethodContext context) 인풋 메서드 이벤트의 클라이언트 컴퍼넌트에의 디스패치 및 클라이언트 컴퍼넌트로부터의 정보의 요구에 사용하는 인풋 메서드의 컨텍스트를 설정합니다.
boolean	setLocale (Locale locale) 입력 로케일의 설정을 시도합니다.

메서드의 상세

setInputMethodContext

void setInputMethodContext(InputMethodContext  context)

인풋 메서드 이벤트의 클라이언트 컴퍼넌트에의 디스패치 및 클라이언트 컴퍼넌트로부터의 정보의 요구에 사용하는 인풋 메서드의 컨텍스트를 설정합니다.

이 메서드는 인풋 메서드의 인스턴스를 생성하자마자 호출합니다.

파라미터:

context - 이 인풋 메서드용의 인풋 메서드 컨텍스트

예외:

NullPointerException - context이 null인 경우

setLocale

boolean setLocale(Locale  locale)

입력 로케일의 설정을 시도합니다. 인풋 메서드가 목적의 로케일을 지원하고 있는 경우, 이 메서드는 그 동작을 변경해 로케일에 대한 입력을 지원해, true를 리턴합니다. 그렇지 않은 경우는 false를 돌려주고 동작의 변경을 실시하지 않습니다.

이 메서드는 다음의 경우에 호출합니다.

• InputContext.selectInputMethod 에 해
• 사용자가 로케일을 지정했는지, 혹은 이전에 선택 끝난 인풋 메서드의 getLocale 메서드가 null이 아닌 값을 돌려주는 경우에 사용자 인터페이스를 사용해 이 인풋 메서드로 전환할 때

파라미터:

locale - 입력하는 로케일

반환값:

지정된 로케일이 지원되고 있는지 어떤지

예외:

NullPointerException - locale가 null인 경우

getLocale

Locale  getLocale()

현재의 입력 로케일을 리턴합니다. 예외 클래스의 경우는 null을 돌려주는 일이 있습니다.

이 메서드는 다음의 경우에 호출합니다.

• InputContext.getLocale 에 해
• 사용자 인터페이스를 사용해, 이 인풋 메서드로부터 다른 인풋 메서드로 전환할 때

반환값:

현재의 입력 로케일, 또는 null

setCharacterSubsets

void setCharacterSubsets(Character.Subset [] subsets)

이 인풋 메서드로 입력 가능한 Unicode 캐릭터셋의 부분집합을 설정합니다. 모든 문자를 사용할 수 있는 것을 나타내는 경우는 null이 건네받습니다.

이 메서드는 다음의 경우에 호출합니다.

• 이 인풋 메서드의 인스턴스를 생성한 직후
• 다른 인풋 메서드로부터 이 인풋 메서드로 전환할 때
• InputContext.setCharacterSubsets 에 해

파라미터:

subsets - 문자가 입력되는 Unicode 캐릭터셋의 부분집합

setCompositionEnabled

void setCompositionEnabled(boolean enable)

파라미터 enable값에 응해, 변환의 인풋 메서드를 사용 가능 또는 사용 불가능하게 합니다.

변환을 위해서 사용 가능한 인풋 메서드는 변환과 제어의 2개의 목적으로 들어 오는 이벤트를 해석합니다. 한편, 사용 불가능한 인풋 메서드는 변환을 위해서 이벤트를 해석하지 않습니다. 다만, 인풋 메서드가 사용 가능한가 어떤가에 관계없이, 이벤트는 인풋 메서드에게 건네집니다. 또, 변환에 사용 불가능한 인풋 메서드여도, 변환을 위해서 자신을 사용 가능 또는 사용 불가능하게 하는 등의 제어 목적으로 이벤트를 해석할 수 있습니다 .

호스트 OS에 의해 제공되는 인풋 메서드의 경우, 이 조작이 지원되고 있는지를 항상 판단할 수 있다고는 할 수 없습니다. 예를 들어 인풋 메서드가 특정의 로케일로 밖에 변환하지 못하고, 다른 로케일에 대해서는 아무것도 실시하지 않는 경우가 있습니다. 그러한 인풋 메서드의 경우, 이 메서드가 UnsupportedOperationException를 Throw 하지 않을 가능성이 있습니다만, 변환이 가능한지 어떤지에 영향을 주는 일도 없습니다.

이 메서드는 다음의 경우에 호출합니다.

• InputContext.setCompositionEnabled 에 해
• 이전에 선택 끝난 인풋 메서드의 isCompositionEnabled 메서드가 예외를 Throw 하지 않고 리턴된인 경우에 사용자 인터페이스 또는 InputContext.selectInputMethod를 사용해, 다른 인풋 메서드로부터 이 인풋 메서드로 전환할 때

파라미터:

enable - 변환용의 인풋 메서드를 사용 가능하게 할지 어떨지

예외:

UnsupportedOperationException - 이 인풋 메서드가 사용 가능/사용 불가능 오퍼레이션을 지원하지 않는 경우

관련 항목:

isCompositionEnabled()

isCompositionEnabled

boolean isCompositionEnabled()

이 인풋 메서드가 사용 가능한가 어떤가 판별합니다. 변환에 사용할 수 있는 인풋 메서드는 변환과 제어의 2개의 목적으로 들어 오는 이벤트를 해석합니다. 그 때, 사용 불가능한 인풋 메서드는 변환을 위한 이벤트를 해석하지 않습니다.

이 메서드는 다음의 경우에 호출합니다.

• InputContext.isCompositionEnabled 에 해
• 사용자 인터페이스 또는 InputContext.selectInputMethod를 사용해, 이 인풋 메서드로부터 다른 인풋 메서드로 전환할 때

반환값:

이 인풋 메서드가 변환을 위해서 사용 가능한 경우는 true, 그렇지 않은 경우는 false

예외:

UnsupportedOperationException - 이 인풋 메서드가 자신이 변환을 위해서 사용 가능한가 어떤가의 확인을 할 수 없는 경우

관련 항목:

setCompositionEnabled(boolean)

reconvert

void reconvert()

재변환 조작을 개시합니다. 인풋 메서드는 InputMethodRequests.getSelectedText 메서드를 사용해, 현재의 클라이언트 컴퍼넌트로부터 재변환하는 텍스트를 취득합니다. 이 메서드는 다른 InputMethodRequests 메서드를 사용해 재변환 조작에 필요한 추가 정보를 요구할 수 있습니다. 이 조작에 의해 변환해, 확정한 텍스트는 클라이언트 컴퍼넌트에 InputMethodEvent 순서로서 보내집니다. 지정된 텍스트가 재변환할 수 없는 경우는 동일한 텍스트를 확정 텍스트로서 클라이언트 컴퍼넌트에 보낼 필요가 있습니다.

이 메서드는 InputContext.reconvert 에 의해 호출합니다.

예외:

UnsupportedOperationException - 이 인풋 메서드가 재변환 조작을 지원하지 않는 경우

dispatchEvent

void dispatchEvent(AWTEvent  event)

인풋 메서드에 이벤트를 디스패치 합니다. 인풋 메서드의 지원가 포커스 된 컴퍼넌트로 사용 가능한 경우는 특정의 형태의 입력 이벤트가 컴퍼넌트 이벤트 처리 메서드 또는 이벤트 리스너에게 디스패치 되기 전에 이 컴퍼넌트의 현재의 인풋 메서드에 디스패치 됩니다. 인풋 메서드는 그 메서드가 이벤트를 처리할 필요가 있을지 어떨지를 결정합니다. 처리할 필요가 있는 경우는 이벤트의 consume 메서드도 호출합니다. 이것에 의해 이벤트는 그 컴퍼넌트의 이벤트 처리 메서드 또는 이벤트 리스너에게 디스패치 되지 않게 됩니다.

이벤트는 InputEvent 또는 그 서브 클래스의 인스턴스의 경우에 디스패치 됩니다. 이것에는 AWT 클래스의 KeyEvent 및 MouseEvent 인스턴스가 포함됩니다.

이 메서드는 InputContext.dispatchEvent 에 의해 호출합니다.

파라미터:

event - 인풋 메서드에 디스패치 되는 이벤트

예외:

NullPointerException - event이 null인 경우

notifyClientWindowChange

void notifyClientWindowChange(Rectangle  bounds)

클라이언트의 윈도우 위치 또는 상태의 변경을 이 인풋 메서드에 통지합니다. 이 메서드는 이 인풋 메서드가 입력 컨텍스트 으로 현재 사용되고 있는 인풋 메서드이며, 이 메서드에 대한 통지가 사용 가능한 경우에 호출합니다 (InputMethodContext.enableClientWindowNotification를 참조). 입력 컨텍스트 의 removeNotify 메서드가 불려가 면, 이 메서드의 호출은 일시적으로 보류되어 새로운의 클라이언트 컴퍼넌트가 인풋 메서드를 시작하면 재개됩니다. 이 메서드는 다음의 경우에 호출합니다.

• 현재의 클라이언트 컴퍼넌트를 포함한 윈도우의 위치, 사이즈, 가시성,자식아이콘의 표시 상태가 변경되었을 때인가 이 윈도우가 닫혀졌을 때
• 현재의 클라이언트 컴퍼넌트가 존재하는 경우는 enableClientWindowNotification(inputMethod, true)로 부터
• 호출중에 현재의 클라이언트 컴퍼넌트를 사용할 수 없는 경우, enableClientWindowNotification(inputMethod, true) 호출 후에 최초로 인풋 메서드를 시작할 때
• 입력 컨텍스트 의 removeNotify 메서드의 호출 후에 새로운 클라이언트 컴퍼넌트의 인풋 메서드를 시작할 때

파라미터:

bounds - 화면상의 클라이언트 윈도우의 bounds . 클라이언트 윈도우가자식아이콘화 되는지, 불가시의 경우는 null

activate

void activate()

즉시 입력 처리를 위한 인풋 메서드를 시작합니다.

인풋 메서드가 독자적인 윈도우를 소유하는 경우, 이 시점에서 모든 필요한 윈도우가 열려 있어 가시인 것을 확인할 필요가 있습니다.

이 메서드는 다음의 경우에 호출합니다.

• 클라이언트 컴퍼넌트가 FOCUS_GAINED 이벤트를 받을 때에 InputContext.dispatchEvent 에 해
• 사용자 인터페이스 또는 InputContext.selectInputMethod를 사용해, 다른 인풋 메서드로부터 이 인풋 메서드로 전환할 때

이 메서드는 인풋 메서드가 정지하고 있는 경우에만 호출합니다. 새롭게 인스턴스가 생성된 인풋 메서드는 정지하고 있는 것이라고 보여집니다.

deactivate

void deactivate(boolean isTemporary)

인풋 메서드를 종료합니다. isTemporary 인수는 FocusEvent.isTemporary 인수와 같은 미를 가집니다.

인풋 메서드가 독자적인 윈도우를 소유하는 경우, 룩 업 선택 윈도우 등 현재의 변환에 관련된 윈도우만이, 여기서 닫혀집니다. 이 인풋 메서드를, 다른 클라이언트 컴퍼넌트를 위해서 곧바로 재시작하는 일도 가능하지만, 컨트롤 패널등의 보다 지속적인 윈도우를 닫거나 다시 열거나 하면, 불필요한 화면 플릭커가 생성됩니다. 다른 인풋 메서드 클래스의 인스턴스를 시작하는 경우는 그 전에 hideWindows()를 현재의 인풋 메서드로 호출합니다.

이 메서드는 다음의 경우에 호출합니다.

• 클라이언트 컴퍼넌트가 FOCUS_LOST 이벤트를 받을 때에 InputContext.dispatchEvent 에 해
• 사용자 인터페이스 또는 InputContext.selectInputMethod를 사용해, 이 인풋 메서드로부터 다른 인풋 메서드로 전환할 때
• 현재의 클라이언트 컴퍼넌트가 삭제되는 경우는 removeNotify 가 불려가기 전

이 메서드는 인풋 메서드가 활성화된 경우에만 호출합니다.

파라미터:

isTemporary - 포커스 변경이 일시적인가 어떤가

hideWindows

void hideWindows()

이 인풋 메서드의 인스턴스 또는 클래스가 열린 모든 윈도우를 닫는지, 숨깁니다.

이 메서드는 다음의 경우에 호출합니다.

• 다른 인풋 메서드 클래스의 인스턴스로 activate를 호출하기 전
• 이 인풋 메서드로 dispose를 호출하기 전

이 메서드는 인풋 메서드가 정지하고 있는 경우에만 호출합니다.

removeNotify

void removeNotify()

클라이언트 컴퍼넌트가 포함 관계의 계층으로부터 삭제되고 있는지, 또는 인풋 메서드가 그 컴퍼넌트로 사용할 수 없게 되고 있는 것을 인풋 메서드에 통지합니다.

이 메서드는 InputContext.removeNotify 에 의해 호출합니다.

이 메서드는 인풋 메서드가 정지하고 있는 경우에만 호출합니다.

endComposition

void endComposition()

이 컨텍스트 으로 현재 진행중의 입력 변환을 종료합니다. 플랫폼 및 사용자 설정에 응해, 미확정의 텍스트를 확정 또는 삭제합니다. 텍스트에 대한 변경은 인풋 메서드 이벤트를 사용해 활성화된 컴퍼넌트에 통지됩니다.

텍스트 편집 컴퍼넌트는 예를 들어 사용자가 텍스트내에서 (변환 텍스트의 외부에) 삽입 포인트를 이동했을 때나, 컴퍼넌트의 텍스트가 파일에 보존되거나 클립보드에 카피되었을 때 등, 다양한 상황으로 이 메서드를 호출하는 일이 있습니다.

이 메서드는 다음의 경우에 호출합니다.

• InputContext.endComposition 에 해
• 다른 클라이언트 컴퍼넌트로 전환하는 경우에 InputContext.dispatchEvent 에 해
• 사용자 인터페이스 또는 InputContext.selectInputMethod를 사용해, 이 인풋 메서드로부터 다른 인풋 메서드로 전환할 때

dispose

void dispose()

인풋 메서드를 파기해, 이 메서드가 사용한 자원을 해방합니다. 특히, 인풋 메서드는 윈도우를 파기해, 필요가 없어진 파일을 닫을 필요가 있습니다.

이 메서드는 InputContext.dispose 에 의해 호출합니다.

이 메서드는 인풋 메서드가 정지하고 있는 경우에만 호출합니다. 파기한 뒤에 이 인스턴스로 호출되는 이 인터페이스의 메서드는 없습니다.

getControlObject

Object  getControlObject()

이 인풋 메서드의 제어 객체 또는 null을 리턴합니다. 제어 객체는 인풋 메서드의 동작을 제어하거나 인풋 메서드로부터 정보를 얻는 메서드를 제공합니다. 객체의 형태는 인풋 메서드 고유의 클래스입니다. 클라이언트는 기존의 인풋 메서드 제어 객체 클래스와 결과를 비교해, 제공되는 메서드를 호출하기 위해서 적절한 클래스에 캐스트 할 필요가 있습니다.

이 메서드는 InputContext.getInputMethodControlObject 에 의해 호출합니다.

반환값:

현재의 인풋 메서드의 제어 객체, 또는 null