001// Copyright 2004, 2005 The Apache Software Foundation
002//
003// Licensed under the Apache License, Version 2.0 (the "License");
004// you may not use this file except in compliance with the License.
005// You may obtain a copy of the License at
006//
007//     http://www.apache.org/licenses/LICENSE-2.0
008//
009// Unless required by applicable law or agreed to in writing, software
010// distributed under the License is distributed on an "AS IS" BASIS,
011// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
012// See the License for the specific language governing permissions and
013// limitations under the License.
014
015package org.apache.tapestry.contrib.table.components;
016
017import org.apache.tapestry.contrib.table.model.ITableModelSource;
018
019/**
020 * A modified version of the facade component in the Table family. 
021 * FormTable allows you to present a sortable and pagable table 
022 * within a form by using only this one component.
023 * 
024 *  [<a href="../../../../../../../ComponentReference/contrib.FormTable.html">Component Reference</a>]
025 * 
026 * @author mindbridge
027 *
028 */
029public abstract class FormTable extends Table implements ITableModelSource
030{
031    // parameters
032    public abstract Object getColumns();
033
034    /**
035     *  If the columns are defined via a String, make sure they use 
036     *  the form-specific column headers.
037     */
038    public Object getFormColumns()
039    {
040        Object objColumns = getColumns();
041        if (objColumns instanceof String)
042            objColumns = "*" + objColumns;
043        return objColumns;
044    }
045
046}