Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
TableColumnModelSource |
|
| 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.components; | |
16 | ||
17 | import org.apache.tapestry.IComponent; | |
18 | import org.apache.tapestry.contrib.table.model.IAdvancedTableColumnSource; | |
19 | import org.apache.tapestry.contrib.table.model.ITableColumnModel; | |
20 | ||
21 | /** | |
22 | * Service used to generate a | |
23 | * {@link org.apache.tapestry.contrib.table.model.ITableColumnModel}from a | |
24 | * string description. | |
25 | * | |
26 | * @author Howard M. Lewis Ship | |
27 | * @since 4.0 | |
28 | */ | |
29 | public interface TableColumnModelSource | |
30 | { | |
31 | ||
32 | /** | |
33 | * Generate a table column model out of the description string provided. | |
34 | * Entries in the description string are separated by commas. Each column | |
35 | * entry is of the format name, name:expression, or | |
36 | * name:displayName:expression. An entry prefixed with ! represents a | |
37 | * non-sortable column. If the whole description string is prefixed with *, | |
38 | * it represents columns to be included in a Form. | |
39 | * | |
40 | * @param strDesc | |
41 | * the description of the column model to be generated | |
42 | * @param objComponent | |
43 | * the component ordering the generation | |
44 | * @param objColumnSettingsContainer | |
45 | * the component containing the column settings | |
46 | * @return a table column model based on the provided parameters | |
47 | */ | |
48 | ITableColumnModel generateTableColumnModel( | |
49 | IAdvancedTableColumnSource objColumnSource, String strDesc, | |
50 | IComponent objComponent, IComponent objColumnSettingsContainer); | |
51 | } |