com.extjs.gxt.ui.client.data.Loader Maven / Gradle / Ivy

Go to download

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

Rich Internet Application Framework for GWT

There is a newer version: 2.3.1-gwt22

/*
 * Sencha GXT 2.3.1a - Sencha for GWT
 * Copyright(c) 2007-2013, Sencha, Inc.
 * [email protected]
 * 
 * http://www.sencha.com/products/gxt/license/
 */
 package com.extjs.gxt.ui.client.data;

import com.extjs.gxt.ui.client.event.BaseEvent;
import com.extjs.gxt.ui.client.event.EventType;
import com.extjs.gxt.ui.client.event.LoadListener;
import com.extjs.gxt.ui.client.event.Observable;

/**
 * Interface for objects that can load remote data.
 * 
 * 
 * Events:
 * 
 * BeforeLoad : LoadEvent(loader, config)

 * Fires before a load operation. Listeners can cancel the action by
 * calling {@link BaseEvent#setCancelled(boolean)}.
 * 
 * loader : this
 * config : the load config
 * 
 * 
 * 
 * Load : LoadEvent(loader, config, result)

 * Fires after a load operation.
 * 
 * loader : this
 * config : the load config
 * result : the load result
 * 
 * 
 * 
 * LoadException : LoadEvent(loader, config, result)

 * Fires when an exception occurs during a load operation.
 * 
 * loader : this
 * config : the load config
 * exception : the load exception
 * 
 * 
 * 
 * 
 * @param  the data type being returned by the loader
 * 
 * @see ListLoader
 * @see TreeLoader
 */
public interface Loader extends Observable {

  /**
   * Fires before a request is made for data.
   */
  public static final EventType BeforeLoad = new EventType();

  /**
   * Fires when new data has been loaded.
   */
  public static final EventType Load = new EventType();

  /**
   * Fires if an exception occurs while retrieving data.
   */
  public static final EventType LoadException = new EventType();

  /**
   * Adds a load listener.
   * 
   * @param listener the listener to add
   */
  public void addLoadListener(LoadListener listener);

  /**
   * 
   * Loads the data using the current configuration.
   * 
   * @return true if the load was requested
   */
  public boolean load();

  /**
   * Loads the data using the given load configuration.
   * 
   * @param loadConfig the load config
   * @return true if the load was requested
   */
  public boolean load(Object loadConfig);

  /**
   * Removes a load listener.
   * 
   * @param listener the listener to remove
   */
  public void removeLoadListener(LoadListener listener);

}