com.gwtplatform.mvp.client.proxy.AsyncCallStartEvent Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of gwtp-all Show documentation
The newest version!
/*
 * Copyright 2011 ArcBees Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
 * use this file except in compliance with the License. You may obtain a copy of
 * the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations under
 * the License.
 */

package com.gwtplatform.mvp.client.proxy;

import com.google.gwt.event.shared.GwtEvent;
import com.google.web.bindery.event.shared.EventBus;

/**
 * Event fired right before any asynchronous call to the server is performed by GWTP MVP.
 * Such asynchronous calls only occur when using code splitting. You can hook on this event
 * to display a "Loading..." message if desired.
 *
 * @see AsyncCallStartHandler
 * @see AsyncCallSucceedEvent
 * @see AsyncCallFailEvent
 */
public class AsyncCallStartEvent extends GwtEvent {
    private static final Type TYPE = new Type();

    AsyncCallStartEvent() {
    }

    /**
     * Fires a {@link AsyncCallStartEvent}
     * into a source that has access to an {@link com.google.web.bindery.event.shared.EventBus}.
     *
     * @param source The source that fires this event ({@link EventBus}).
     */
    public static void fire(EventBus source) {
        source.fireEvent(new AsyncCallStartEvent());
    }

    public static Type getType() {
        return TYPE;
    }

    @Override
    public Type getAssociatedType() {
        return getType();
    }

    @Override
    protected void dispatch(AsyncCallStartHandler handler) {
        handler.onAsyncCallStart(this);
    }
}