org.eclipse.swt.widgets

Class IME

java.lang.Object

org.eclipse.swt.widgets.Widget

org.eclipse.swt.widgets.IME

public class IME
extends Widget

Instances of this class represent input method editors. These are typically in-line pre-edit text areas that allow the user to compose characters from Far Eastern languages such as Japanese, Chinese or Korean.

Styles:

(none)

Events:

ImeComposition

IMPORTANT: This class is not intended to be subclassed.

Since:

3.4

See Also:

Sample code and further information

Structure Diagram

Field Summary

Fields

Modifier and Type	Field and Description
(package private) int	caretOffset
(package private) static byte[]	CLSID_TF_InputProcessorProfiles
(package private) int	commitCount
(package private) static byte[]	GUID_TFCAT_TIP_KEYBOARD
(package private) static byte[]	IID_ITfDisplayAttributeProvider
(package private) static byte[]	IID_ITfInputProcessorProfiles
(package private) Canvas	parent
(package private) int[]	ranges
(package private) int	startOffset
(package private) TextStyle[]	styles
(package private) java.lang.String	text
(package private) static int	UNDERLINE_IME_DASH
(package private) static int	UNDERLINE_IME_DOT
(package private) static int	UNDERLINE_IME_THICK
(package private) static int	WM_MSIME_MOUSE

Fields inherited from class org.eclipse.swt.widgets.Widget

CANVAS, data, DEFAULT_HEIGHT, DEFAULT_WIDTH, DISABLED, display, DISPOSE_SENT, DISPOSED, DRAG_DETECT, DRAW_BACKGROUND, eventTable, FOREIGN_HANDLE, HIDDEN, IGNORE_WM_CHANGEUISTATE, KEYED_DATA, LAYOUT_CHANGED, LAYOUT_CHILD, LAYOUT_NEEDED, MAJOR, MINOR, MOVE_DEFERRED, MOVE_OCCURRED, PARENT_BACKGROUND, RELEASED, RESIZE_DEFERRED, RESIZE_OCCURRED, SKIN_NEEDED, state, style, THEME_BACKGROUND, TRACK_MOUSE

Constructor Summary

Constructors

Constructor and Description
IME() Prevents uninitialized instances from being created outside the package.
IME(Canvas parent, int style) Constructs a new instance of this class given its parent and a style value describing its behavior and appearance.

Method Summary

Methods

Modifier and Type	Method and Description
(package private) void	createWidget()
int	getCaretOffset() Returns the offset of the caret from the start of the document.
int	getCommitCount() Returns the commit count of the composition.
int	getCompositionOffset() Returns the offset of the composition from the start of the document.
(package private) TF_DISPLAYATTRIBUTE	getDisplayAttribute(short langid, int attInfo)
int[]	getRanges() Returns the ranges for the style that should be applied during the in-line edit session.
TextStyle[]	getStyles() Returns the styles for the ranges.
java.lang.String	getText() Returns the composition text.
boolean	getWideCaret() Returns true if the caret should be wide, and false otherwise.
(package private) boolean	isInlineEnabled()
(package private) void	releaseParent()
(package private) void	releaseWidget()
void	setCompositionOffset(int offset) Sets the offset of the composition from the start of the document.
(package private) LRESULT	WM_IME_COMPOSITION_START(int wParam, int lParam)
(package private) LRESULT	WM_IME_COMPOSITION(int wParam, int lParam)
(package private) LRESULT	WM_IME_ENDCOMPOSITION(int wParam, int lParam)
(package private) LRESULT	WM_KILLFOCUS(int wParam, int lParam)
(package private) LRESULT	WM_LBUTTONDOWN(int wParam, int lParam)

Methods inherited from class org.eclipse.swt.widgets.Widget

_addListener, addDisposeListener, addListener, callWindowProc, checkBits, checkOpened, checkOrientation, checkParent, checkSubclass, checkWidget, DeferWindowPos, destroyWidget, dispose, dragDetect, error, filters, findItem, fixMnemonic, fixMnemonic, getData, getData, getDisplay, getListeners, getMenu, getName, getNameText, getStyle, hooks, isDisposed, isListening, isValidSubclass, isValidThread, mapEvent, new_GC, notifyListeners, postEvent, postEvent, release, releaseChildren, releaseHandle, removeDisposeListener, removeListener, removeListener, reskin, reskinChildren, reskinWidget, sendDragEvent, sendDragEvent, sendEvent, sendEvent, sendEvent, sendEvent, sendFocusEvent, sendKeyEvent, sendKeyEvent, sendMouseEvent, sendMouseEvent, sendMouseWheelEvent, sendSelectionEvent, sendSelectionEvent, setData, setData, setInputState, setKeyState, setLocationMask, setTabGroupFocus, setTabItemFocus, SetWindowPos, showMenu, showMenu, toString, updateMenuLocation, wmCaptureChanged, wmChar, wmContextMenu, wmIMEChar, wmKeyDown, wmKeyUp, wmKillFocus, wmLButtonDblClk, wmLButtonDown, wmLButtonUp, wmMButtonDblClk, wmMButtonDown, wmMButtonUp, wmMouseHover, wmMouseHWheel, wmMouseLeave, wmMouseMove, wmMouseWheel, wmNCPaint, wmPaint, wmPrint, wmRButtonDblClk, wmRButtonDown, wmRButtonUp, wmSetFocus, wmSysChar, wmSysKeyDown, wmSysKeyUp, wmXButtonDblClk, wmXButtonDown, wmXButtonUp

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

parent

Canvas parent

caretOffset

int caretOffset

startOffset

int startOffset

commitCount

int commitCount

text

java.lang.String text

ranges

int[] ranges

styles

TextStyle[] styles

WM_MSIME_MOUSE

static final int WM_MSIME_MOUSE

IID_ITfInputProcessorProfiles

static final byte[] IID_ITfInputProcessorProfiles

IID_ITfDisplayAttributeProvider

static final byte[] IID_ITfDisplayAttributeProvider

CLSID_TF_InputProcessorProfiles

static final byte[] CLSID_TF_InputProcessorProfiles

GUID_TFCAT_TIP_KEYBOARD

static final byte[] GUID_TFCAT_TIP_KEYBOARD

UNDERLINE_IME_DOT

static final int UNDERLINE_IME_DOT

See Also:

Constant Field Values

UNDERLINE_IME_DASH

static final int UNDERLINE_IME_DASH

See Also:

Constant Field Values

UNDERLINE_IME_THICK

static final int UNDERLINE_IME_THICK

See Also:

Constant Field Values

Constructor Detail

IME

IME()

Prevents uninitialized instances from being created outside the package.

IME

public IME(Canvas parent,
   int style)

Constructs a new instance of this class given its parent and a style value describing its behavior and appearance.

The style value is either one of the style constants defined in class SWT which is applicable to instances of this class, or must be built by bitwise OR'ing together (that is, using the int "|" operator) two or more of those SWT style constants. The class description lists the style constants that are applicable to the class. Style bits are also inherited from superclasses.

Parameters:

parent - a canvas control which will be the parent of the new instance (cannot be null)

style - the style of control to construct

Throws:

java.lang.IllegalArgumentException -

• ERROR_NULL_ARGUMENT - if the parent is null

SWTException -

• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the parent
• ERROR_INVALID_SUBCLASS - if this class is not an allowed subclass

See Also:

Widget.checkSubclass(), Widget.getStyle()

Method Detail

createWidget

void createWidget()

getCaretOffset

public int getCaretOffset()

Returns the offset of the caret from the start of the document. The caret is within the current composition.

Returns:

the caret offset

Throws:

SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

getCommitCount

public int getCommitCount()

Returns the commit count of the composition. This is the number of characters that have been composed. When the commit count is equal to the length of the composition text, then the in-line edit operation is complete.

Returns:

the commit count

Throws:

SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

See Also:

getText()

getCompositionOffset

public int getCompositionOffset()

Returns the offset of the composition from the start of the document. This is the start offset of the composition within the document and in not changed by the input method editor itself during the in-line edit session.

Returns:

the offset of the composition

Throws:

SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

getDisplayAttribute

TF_DISPLAYATTRIBUTE getDisplayAttribute(short langid,
                                      int attInfo)

getRanges

public int[] getRanges()

Returns the ranges for the style that should be applied during the in-line edit session.

The ranges array contains start and end pairs. Each pair refers to the corresponding style in the styles array. For example, the pair that starts at ranges[n] and ends at ranges[n+1] uses the style at styles[n/2] returned by getStyles().

Returns:

the ranges for the styles

Throws:

SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

See Also:

getStyles()

getStyles

public TextStyle[] getStyles()

Returns the styles for the ranges.

The ranges array contains start and end pairs. Each pair refers to the corresponding style in the styles array. For example, the pair that starts at ranges[n] and ends at ranges[n+1] uses the style at styles[n/2].

Returns:

the ranges for the styles

Throws:

SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

See Also:

getRanges()

getText

public java.lang.String getText()

Returns the composition text.

The text for an IME is the characters in the widget that are in the current composition. When the commit count is equal to the length of the composition text, then the in-line edit operation is complete.

Returns:

the widget text

Throws:

SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

getWideCaret

public boolean getWideCaret()

Returns true if the caret should be wide, and false otherwise. In some languages, for example Korean, the caret is typically widened to the width of the current character in the in-line edit session.

Returns:

the wide caret state

Throws:

SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

isInlineEnabled

boolean isInlineEnabled()

releaseParent

void releaseParent()

Overrides:

releaseParent in class Widget

releaseWidget

void releaseWidget()

Overrides:

releaseWidget in class Widget

setCompositionOffset

public void setCompositionOffset(int offset)

Sets the offset of the composition from the start of the document. This is the start offset of the composition within the document and in not changed by the input method editor itself during the in-line edit session but may need to be changed by clients of the IME. For example, if during an in-line edit operation, a text editor inserts characters above the IME, then the IME must be informed that the composition offset has changed.

Parameters:

offset - the offset of the composition

Throws:

SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

WM_IME_COMPOSITION

LRESULT WM_IME_COMPOSITION(int wParam,
                         int lParam)

WM_IME_COMPOSITION_START

LRESULT WM_IME_COMPOSITION_START(int wParam,
                               int lParam)

WM_IME_ENDCOMPOSITION

LRESULT WM_IME_ENDCOMPOSITION(int wParam,
                            int lParam)

WM_KILLFOCUS

LRESULT WM_KILLFOCUS(int wParam,
                   int lParam)

WM_LBUTTONDOWN

LRESULT WM_LBUTTONDOWN(int wParam,
                     int lParam)