KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > tapestry > contrib > table > components > TableColumnModelSource


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