View Javadoc

1   /***
2    * Copyright (C) 2006 Philipp Mpalampanis
3    *
4    * License: MPL 1.1/GPL 2.0/LGPL 2.1
5    *
6    * The contents of this file are subject to the Mozilla Public License Version
7    * 1.1 (the "License"); you may not use this file except in compliance with
8    * the License. You may obtain a copy of the License at
9    * http://www.mozilla.org/MPL/
10   *
11   * Software distributed under the License is distributed on an "AS IS" basis,
12   * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
13   * for the specific language governing rights and limitations under the
14   * License.
15   *
16   * Alternatively, the contents of this file may be used under the terms of
17   * either the GNU General Public License Version 2 or later (the "GPL"), or
18   * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
19   * in which case the provisions of the GPL or the LGPL are applicable instead
20   * of those above. If you wish to allow use of your version of this file only
21   * under the terms of either the GPL or the LGPL, and not to allow others to
22   * use your version of this file under the terms of the MPL, indicate your
23   * decision by deleting the provisions above and replace them with the notice
24   * and other provisions required by the GPL or the LGPL. If you do not delete
25   * the provisions above, a recipient may use your version of this file under
26   * the terms of any one of the MPL, the GPL or the LGPL.
27   */
28  package net.sf.echobinding.table;
29  
30  import java.util.List;
31  
32  import net.sf.echobinding.binding.BindingContext;
33  
34  /***
35   *
36   */
37  public interface DetailsHandler {
38  
39  	/***
40  	 * Handles the details for a bound collection. Enables a
41  	 * master-detail-relationship between tables. The BoundTableCollectionCellRenderer
42  	 * renders each bound collection (to-many associations) as a clickable
43  	 * button that the user can click to see the details of this collection.
44  	 * 
45  	 * The onToManyContext is the binding context you may have provided for the
46  	 * property adapter which points to the collection. Use this binding context
47  	 * to show the collections details in another (Detail) table.
48  	 * 
49  	 * 
50  	 * @param adapterId
51  	 *            The adpater id of the selected column
52  	 * @param list
53  	 *            The elements of the collection as a list
54  	 * @param oneToManyContext
55  	 *            The binding context for the collection. Can be null, if not
56  	 *            specified in the cofiguration.
57  	 */
58  	void handleDetails(String adapterId, List list,
59  			BindingContext oneToManyContext);
60  
61  }