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.model;
016
017import java.io.Serializable;
018
019import org.apache.tapestry.IRender;
020import org.apache.tapestry.IRequestCycle;
021
022/**
023 * This interface provides a renderer to present the data in a table column.
024 * It is usually used by the {@link org.apache.tapestry.contrib.table.model.ITableColumn} 
025 * implementations via aggregation.
026 * 
027 * @see org.apache.tapestry.contrib.table.model.common.AbstractTableColumn
028 * @author mindbridge
029 * @since 2.3
030 */
031public interface ITableRendererSource extends Serializable
032{
033        /**
034         * Returns a renderer to present the data of the row in the given column. <p>
035         * This method can also be used to return a renderer to present the
036         * heading of the column. In such a case the row passed would be null.
037         * 
038         * @see org.apache.tapestry.contrib.table.model.ITableColumn#getValueRenderer(IRequestCycle, ITableModelSource, Object)
039         */
040        public IRender getRenderer(
041                IRequestCycle objCycle,
042                ITableModelSource objSource,
043                ITableColumn objColumn,
044                Object objRow);
045
046}