ChoiceRecorder.java

package abbot.editor.recorder;

import java.awt.*;
import java.awt.event.*;

import abbot.Log;
import abbot.script.*;

/**
 * Record basic semantic events you might find on an Choice component. <p>
 */
public class ChoiceRecorder extends ComponentRecorder {

    private Choice choice = null;
    /** If selection is null when finished, no step will be generated. */
    private String selection = null;
    private ItemListener listener = null;

    public ChoiceRecorder(Resolver resolver) {
        super(resolver);
    }

    protected void init(int recordingType) {
        super.init(recordingType);
        choice = null;
        selection = null;
        listener = null;
    }

    /** Also accept ItemEvents, since the ChoiceTester will not generate any
        explicit clicks to control the component. */
    protected boolean isClick(AWTEvent e) {
        if (e instanceof ItemEvent) {
            return true;
        }
        return super.isClick(e);
    }

    /** Track click -> select ->click, cancelable by ESC or by clicking away
        from the component.<p>
        NOTE: press->drag->release produces an identical set of events<br>
        OSX 1.3.1:<br>
        MOUSE_PRESSED<br>
        (ITEM_STATE_CHANGED)|MOUSE_RELEASED|KEY_RELEASED<br>
        The ItemEvent never makes it to the AWT listener.
    */
    protected boolean parseClick(AWTEvent event) {
        // Have to check here since we handle the ItemEvent artificially
        if (isFinished()) {
            Log.debug("already finished");
            return false;
        }

        if (choice == null) {
            // Parse immediate selections (programmatic/tester driven)
            if (event instanceof ItemEvent) {
                choice = (Choice)event.getSource();
                selection = ((ItemEvent)event).getItem().toString();
                Log.debug("selection=" + selection);
                setFinished(true);
            }
            else {
                choice = (Choice)event.getSource();
                listener = new ItemListener() {
                    public void itemStateChanged(ItemEvent ev) {
                        Log.debug("item event");
                        if (ev.getStateChange() == ItemEvent.SELECTED) {
                            selection = ev.getItem().toString();
                            Log.debug("selection=" + selection);
                            choice.removeItemListener(this);
                            setFinished(true);
                        }
                    }
                };
                choice.addItemListener(listener);
                setStatus("Waiting for selection");
            }
        }
        else if (event.getID() == KeyEvent.KEY_RELEASED
                 && (((KeyEvent)event).getKeyCode() == KeyEvent.VK_SPACE
                     || ((KeyEvent)event).getKeyCode() == KeyEvent.VK_ENTER)) {
            Log.debug("enter");
            setFinished(true);
        }
        else if (event.getID() == KeyEvent.KEY_RELEASED
                 && ((KeyEvent)event).getKeyCode() == KeyEvent.VK_ESCAPE) {
            Log.debug("cancel");
            selection = null;
            setFinished(true);
        }
        else {
            Log.debug("Event ignored");
        }

        if (isFinished() && choice != null) {
            choice.removeItemListener(listener);
            listener = null;
        }

        // Events are always consumed by the Choice
        return true;
    }

    protected Step createStep() {
        Step step = null;
        if (getRecordingType() == SE_CLICK) {
            if (selection != null) 
                step = createSelection(choice, selection);
        }
        else {
            step = super.createStep();
        }
        return step;
    }

    protected Step createSelection(Choice target, String selection) {
        ComponentReference cr = getResolver().addComponent(choice);
        return new Action(getResolver(), 
                          null, "actionSelectItem",
                          new String[] {
                              cr.getID(), selection
                          }, java.awt.Choice.class);
    }
}