2.1/samples/expenses/src/main/java/com/google/gwt/sample/expenses/client/place/ProxyListView.java

/*
 * Copyright 2010 Google 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.google.gwt.sample.expenses.client.place;

import com.google.gwt.requestfactory.shared.EntityProxy;
import com.google.gwt.user.client.ui.IsWidget;
import com.google.gwt.view.client.HasData;

/**
 * <p>
 * <span style="color:red">Experimental API: This class is still under rapid
 * development, and is very likely to be deleted. Use it at your own risk.
 * </span>
 * </p>
 * A view of a list of {@link EntityProxy}s, which declares which properties it
 * is able to display.
 * <p>
 * It is expected that such views will typically (eventually) be defined largely
 * in ui.xml files which declare the properties of interest, which is why the
 * view is a source of a property set rather than a receiver of one.
 * 
 * @param <P> the type of the records to display
 */
public interface ProxyListView<P extends EntityProxy> extends IsWidget {
  /**
   * Implemented by the owner of a RecordTableView.
   * 
   * @param <R> the type of the records to display
   */
  interface Delegate<R extends EntityProxy> {
    void createClicked();
  }

  HasData<P> asHasData();

  /**
   * @return the set of properties this view displays
   */
  String[] getPaths();

  /**
   * Sets the delegate.
   */
  void setDelegate(Delegate<P> delegate);
}