com.sencha.gxt.fx.client.animation.BeforeAnimateEvent 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

/**
 * Sencha GXT 3.0.1 - Sencha for GWT
 * Copyright(c) 2007-2012, Sencha, Inc.
 * [email protected]
 *
 * http://www.sencha.com/products/gxt/license/
 */
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.core.shared.event.CancellableEvent;
import com.sencha.gxt.fx.client.animation.BeforeAnimateEvent.BeforeAnimateHandler;

/**
 * Represent the before animate event.
 */
public class BeforeAnimateEvent extends GwtEvent implements CancellableEvent {

  /**
   * 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;
  }

  private boolean cancelled;

  public BeforeAnimateEvent() {
  }

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

  @Override
  public boolean isCancelled() {
    return cancelled;
  }

  @Override
  public void setCancelled(boolean cancelled) {
    this.cancelled = cancelled;
  }

  @Override
  protected void dispatch(BeforeAnimateHandler handler) {
    handler.onBeforeAnimate(this);
  }
  
  /**
   * Handler for {@link BeforeAnimateEvent} events.
   */
  public interface BeforeAnimateHandler extends EventHandler {

    /**
     * Called before the animation is started. Listeners can cancel the action by
     * calling {@link BeforeAnimateEvent#setCancelled(boolean)}.
     * 
     * @param event the {@link BeforeAnimateEvent} that was fired
     */
    void onBeforeAnimate(BeforeAnimateEvent event);

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

    /**
     * Adds a {@link BeforeAnimateHandler} handler for {@link BeforeAnimateEvent}
     * events.
     * 
     * @param handler the handler
     * @return the registration for the event
     */
    public HandlerRegistration addBeforeAnimateHandler(BeforeAnimateHandler handler);

  }

}