com.sencha.gxt.data.shared.event.StoreRemoveEvent 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.1.0 - Sencha for GWT
 * Copyright(c) 2007-2014, Sencha, Inc.
 * [email protected]
 *
 * http://www.sencha.com/products/gxt/license/
 */
package com.sencha.gxt.data.shared.event;

import com.google.gwt.event.shared.EventHandler;
import com.google.gwt.event.shared.GwtEvent;
import com.google.gwt.event.shared.HandlerRegistration;
import com.google.gwt.event.shared.HasHandlers;
import com.sencha.gxt.data.shared.event.StoreRemoveEvent.StoreRemoveHandler;

/**
 * Indicates that an element that was visible has been removed from the Store.
 * Note that non-visible elements do not get events, as most display widgets are
 * not concerned with data which has been filtered out.
 * 
 * @param  the model type
 */
public class StoreRemoveEvent extends StoreEvent> {

  /**
   * A class that implements this interface is a public source of
   * {@link StoreRemoveEvent}.
   * 
   * @param  the type of data contained in the store
   */
  public interface HasStoreRemoveHandler extends HasHandlers {

    /**
     * Adds a {@link StoreRemoveEvent} handler.
     * 
     * @param handler the handler
     * @return the registration for the event
     */
    HandlerRegistration addStoreRemoveHandler(StoreRemoveHandler handler);
  }

  /**
   * Handler interface for {@link StoreRemoveEvent}.
   * 
   * @param  the type of data contained in the store
   */
  public interface StoreRemoveHandler extends EventHandler {

    /**
     * Called when {@link StoreRemoveEvent} is fired.
     * 
     * @param event the {@link StoreRemoveEvent} that was fired
     */
    void onRemove(StoreRemoveEvent event);
  }

  private static GwtEvent.Type> TYPE;

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

  private final int index;

  private final M item;

  /**
   * Creates a new store remove event.
   * 
   * @param index the remove index
   * @param item the item that was removed
   */
  public StoreRemoveEvent(int index, M item) {
    this.index = index;
    this.item = item;
  }

  @SuppressWarnings({"rawtypes", "unchecked"})
  @Override
  public GwtEvent.Type> getAssociatedType() {
    return (GwtEvent.Type) getType();
  }

  /**
   * Returns the index of the removed item.
   * 
   * @return the index of the removed item
   */
  public int getIndex() {
    return index;
  }

  /**
   * Returns the removed item.
   * 
   * @return the removed item
   */
  public M getItem() {
    return item;
  }

  @Override
  protected void dispatch(StoreRemoveHandler handler) {
    handler.onRemove(this);
  }
}