FileDocCategorySizeDatePackage
InputMethodEvent.javaAPI DocAndroid 1.5 API5265Wed May 06 22:41:54 BST 2009java.awt.event

InputMethodEvent

public class InputMethodEvent extends AWTEvent
This class is not supported in Android 1.0. It is merely provided to maintain interface compatibility with desktop Java implementations.
since
Android 1.0

Fields Summary
private static final long
serialVersionUID
public static final int
INPUT_METHOD_FIRST
public static final int
INPUT_METHOD_TEXT_CHANGED
public static final int
CARET_POSITION_CHANGED
public static final int
INPUT_METHOD_LAST
private AttributedCharacterIterator
text
private TextHitInfo
visiblePosition
private TextHitInfo
caret
private int
committedCharacterCount
private long
when
Constructors Summary
public InputMethodEvent(Component src, int id, TextHitInfo caret, TextHitInfo visiblePos)


        
                              
                              
        this(src, id, null, 0, caret, visiblePos);
    
public InputMethodEvent(Component src, int id, AttributedCharacterIterator text, int commitedCharCount, TextHitInfo caret, TextHitInfo visiblePos)

        this(src, id, 0l, text, commitedCharCount, caret, visiblePos);
    
public InputMethodEvent(Component src, int id, long when, AttributedCharacterIterator text, int committedCharacterCount, TextHitInfo caret, TextHitInfo visiblePos)

        super(src, id);

        if ((id < INPUT_METHOD_FIRST) || (id > INPUT_METHOD_LAST)) {
            // awt.18E=Wrong event id
            throw new IllegalArgumentException(Messages.getString("awt.18E")); //$NON-NLS-1$
        }
        if ((id == CARET_POSITION_CHANGED) && (text != null)) {
            // awt.18F=Text must be null for CARET_POSITION_CHANGED
            throw new IllegalArgumentException(Messages.getString("awt.18F")); //$NON-NLS-1$
        }
        if ((text != null) &&
                ((committedCharacterCount < 0) ||
                 (committedCharacterCount > 
                        (text.getEndIndex() - text.getBeginIndex())))) {
            // awt.190=Wrong committedCharacterCount
            throw new IllegalArgumentException(Messages.getString("awt.190")); //$NON-NLS-1$
        }

        this.when = when;
        this.text = text;
        this.caret = caret;
        this.visiblePosition = visiblePos;
        this.committedCharacterCount = committedCharacterCount;
    
Methods Summary
public voidconsume()

        super.consume();
    
public java.awt.font.TextHitInfogetCaret()

        return caret;
    
public intgetCommittedCharacterCount()

        return committedCharacterCount;
    
public java.text.AttributedCharacterIteratorgetText()

        return text;
    
public java.awt.font.TextHitInfogetVisiblePosition()

        return visiblePosition;
    
public longgetWhen()

        return when;
    
public booleanisConsumed()

        return super.isConsumed();
    
public java.lang.StringparamString()

        /* The format is based on 1.5 release behavior 
         * which can be revealed by the following code:
         * 
         * InputMethodEvent e = new InputMethodEvent(new Component(){},
         *          InputMethodEvent.INPUT_METHOD_TEXT_CHANGED,
         *          TextHitInfo.leading(1), TextHitInfo.trailing(2));
         * System.out.println(e);
         */
        String typeString = null;

        switch (id) {
        case INPUT_METHOD_TEXT_CHANGED:
            typeString = "INPUT_METHOD_TEXT_CHANGED"; //$NON-NLS-1$
            break;
        case CARET_POSITION_CHANGED:
            typeString = "CARET_POSITION_CHANGED"; //$NON-NLS-1$
            break;
        default:
            typeString = "unknown type"; //$NON-NLS-1$
        }

        return typeString + ",text=" + text +  //$NON-NLS-1$
                ",commitedCharCount=" + committedCharacterCount + //$NON-NLS-1$
                ",caret=" + caret + ",visiblePosition=" + visiblePosition; //$NON-NLS-1$ //$NON-NLS-2$