Question

I cannot seem to find any documentation of what events fire and when in GXT.

The API docs have lists of all the events that could fire (in Events). And it describes how to handle events that you catch. But I’m interested in the opposite side, which events are fired when I take a certain action.

I can set some listeners for various different components, or I can use addListener with a specific event code to catch individual events. That’s spotty, and I seem to be using trial-and-error to guess what I might want to catch.

Is there a way to log all the events that are firing? Or catch all of them so I could look at them in a debugger?

Or is there some documentation I am missing that has the information? Something along the lines of “when you click on a widget, a ButtonEvent is fired. Events.x is fired on the hover, Events.y on the click.”

Answer 1

I ended up using brute force: Created a Map of EventType and name, then attach a Listener for each type of event that the component could receive. Then I just set a breakpoint inside the Listener, and I could see what events were received when anything happened.

If it hadn’t been throwaway code, I would have cleaned it up into a utility class, not used an anonymous Listener class, etc.

    final Map<EventType, String> eventTypeNames = new HashMap<EventType, String>();
    eventTypeNames.put(Events.BeforeExpand, "BeforeExpand");
    eventTypeNames.put(Events.Expand, "Expand");
    ...
    eventTypeNames.put(Events.BeforeStateSave, "BeforeStateSave");
    eventTypeNames.put(Events.StateSave, "StateSave");

    for (EventType eventType : Arrays.asList(
            Events.BeforeExpand,
            Events.Expand,
            ...
            Events.BeforeStateSave,
            Events.StateSave
    )) {
        this.addListener(eventType, new Listener<BaseEvent>() {
            public void handleEvent(final BaseEvent be) {
                String type = eventTypeNames.get(be.getType());
                String ev = be.toString();
            }
        });
    }