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