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.hivemind.ApplicationRuntimeException;
018import org.apache.tapestry.IRequestCycle;
019import org.apache.tapestry.contrib.table.model.ITableRowSource;
020
021/**
022 * The base implementation for a component that is wrapped by 
023 * the TableRows component. Provides a utility method for getting 
024 * a pointer to TableRows. 
025 * 
026 * @author mindbridge
027 */
028public abstract class AbstractTableRowComponent extends AbstractTableViewComponent
029{
030    public ITableRowSource getTableRowSource()
031    {
032        IRequestCycle objCycle = getPage().getRequestCycle();
033
034        Object objSourceObj = objCycle.getAttribute(ITableRowSource.TABLE_ROW_SOURCE_ATTRIBUTE);
035        ITableRowSource objSource = (ITableRowSource) objSourceObj;
036
037        if (objSource == null)
038            throw new ApplicationRuntimeException(
039                "The component "
040                    + getId()
041                    + " must be contained within an ITableRowSource component, such as TableRows",
042                this,
043                null,
044                null);
045
046        return objSource;
047    }
048
049}