Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
ITableModelSource |
|
| 1.0;1 |
1 | // Copyright 2004, 2005 The Apache Software Foundation | |
2 | // | |
3 | // Licensed under the Apache License, Version 2.0 (the "License"); | |
4 | // you may not use this file except in compliance with the License. | |
5 | // You may obtain a copy of the License at | |
6 | // | |
7 | // http://www.apache.org/licenses/LICENSE-2.0 | |
8 | // | |
9 | // Unless required by applicable law or agreed to in writing, software | |
10 | // distributed under the License is distributed on an "AS IS" BASIS, | |
11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | |
12 | // See the License for the specific language governing permissions and | |
13 | // limitations under the License. | |
14 | ||
15 | package org.apache.tapestry.contrib.table.model; | |
16 | ||
17 | import org.apache.tapestry.IComponent; | |
18 | ||
19 | /** | |
20 | * A Tapestry component that provides the current table model. This interface is | |
21 | * used for obtaining the table model source by components wrapped by it, as | |
22 | * well as by external renderers, such as those provided by the column | |
23 | * implementations | |
24 | * | |
25 | * @author mindbridge | |
26 | */ | |
27 | public interface ITableModelSource extends IComponent | |
28 | { | |
29 | ||
30 | String TABLE_MODEL_SOURCE_ATTRIBUTE = "org.apache.tapestry.contrib.table.model.ITableModelSource"; | |
31 | ||
32 | /** | |
33 | * Returns the table model currently used. | |
34 | * | |
35 | * @return ITableModel the current table model | |
36 | */ | |
37 | ITableModel getTableModel(); | |
38 | ||
39 | /** | |
40 | * Notifies the model source that the model state has changed, and that it | |
41 | * should consider saving it. | |
42 | * <p> | |
43 | * This method was added to allow using the table within a Block when the | |
44 | * pageBeginRender() listener of the implementation will not be called and | |
45 | * automatic state storage will therefore be hard to implement. | |
46 | */ | |
47 | void fireObservedStateChange(); | |
48 | ||
49 | /** | |
50 | * Stores the provided table action. | |
51 | * | |
52 | * @param action | |
53 | * The action to store. | |
54 | */ | |
55 | void storeTableAction(ITableAction action); | |
56 | ||
57 | } |