Class IMENotifyMessage

public class IMENotifyMessage extends InputMethodMessage
{
  // Fields
  public final static int CHANGE_CANDIDATE;
  public final static int CLOSE_CANDIDATE;
  public final static int CLOSE_STATUS_WINDOW;
  public final static int OPEN_CANDIDATE;
  public final static int OPEN_STATUS_WINDOW;
  public final static int UNKNOWN;

  // Constructors
  public IMENotifyMessage( int id );

  // Methods
  public String[] getCandidateList();
  public int getID();
  public String toString();
}

This class provides message objects that notify an Input Method Editor (IME) object to perform an action with one of the various windows associated with it.

InputMethodMessage
  |
  +--IMENotifyMessage

Constructors

IMENotifyMessage

public IMENotifyMessage( int id );

Creates an Input Method Notify Message that includes a specific flag.

Parameter	Description
id	The flag used to create the message. This flag may be one of the following: CLOSE_STATUS_WINDOW CLOSE_CANDIDATE UNKNOWN OPEN_STATUS_WINDOW OPEN_CANDIDATE CHANGE_CANDIDATE

Methods

getCandidateList

public String[] getCandidateList();

Retrieves a list of candidate windows.

Return Value:

Returns an array of strings that list the associated candidates.

getID

public int getID();

Retrieves the IMENotifyMessage messege identifier.

Return Value:

Returns the message identifier. This may be one of the following:

CLOSE_STATUS_WINDOW	CLOSE_CANDIDATE	UNKNOWN
OPEN_STATUS_WINDOW	OPEN_CANDIDATE
CHANGE_CANDIDATE

toString

public String toString();

Translates the IMENotifyMessage object to text form.

Return Value:

Returns a description of the IMENotifyMessage. For example, if the IMENotifyMessage is a CLOSE_CANDIDATE message, the text "IMENotifyMessage, CLOSE_CANDIDATE" is returned.

Fields

CHANGE_CANDIDATE

An IME message used to change the IME Candidate window.

CLOSE_CANDIDATE

An IME message used to close the Candidate window associated with an IME.

CLOSE_STATUS_WINDOW

An IME message used to close an IME Status window.

OPEN_CANDIDATE

An IME message used to open a Candidate window associated with an IME.

OPEN_STATUS_WINDOW

An IME message used to open a Status window associated with the IME.

UNKNOWN

An unknown IME message.