com.sencha.gxt.fx.client.animation.CancelAnimationEvent Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of gxt Show documentation

There is a newer version: 3.1.1

package com.sencha.gxt.fx.client.animation;

import com.google.gwt.event.shared.EventHandler;
import com.google.gwt.event.shared.GwtEvent;
import com.google.gwt.event.shared.HandlerRegistration;
import com.sencha.gxt.fx.client.animation.CancelAnimationEvent.CancelAnimationHandler;

/**
 * Represent the cancelled animation event.
 */
public class CancelAnimationEvent extends GwtEvent {

  /**
   * Handler type.
   */
  private static Type TYPE;

  /**
   * Gets the type associated with this event.
   * 
   * @return returns the handler type
   */
  public static Type getType() {
    if (TYPE == null) {
      TYPE = new Type();
    }
    return TYPE;
  }

  public CancelAnimationEvent() {
  }

  @SuppressWarnings({"rawtypes", "unchecked"})
  @Override
  public Type getAssociatedType() {
    return (Type) TYPE;
  }

  @Override
  protected void dispatch(CancelAnimationHandler handler) {
    handler.onCancelAnimation(this);
  }
  
  /**
   * Handler for {@link CancelAnimationEvent} events.
   */
  public interface CancelAnimationHandler extends EventHandler {

    /**
     * Called when the animation is cancelled.
     * 
     * @param event the {@link CancelAnimationEvent} that was fired
     */
    void onCancelAnimation(CancelAnimationEvent event);

  }
  
  /**
   * A widget that implements this interface is a public source of
   * {@link CancelAnimationEvent} events.
   */
  public interface HasCancelAnimationHandlers {

    /**
     * Adds a {@link CancelAnimationHandler} handler for
     * {@link CancelAnimationEvent} events.
     * 
     * @param handler the handler
     * @return the registration for the event
     */
    public HandlerRegistration addCancelAnimationHandler(CancelAnimationHandler handler);

  }

}