1   // Copyright 2007, 2008 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.tapestry5.grid;
   16   
   17   import org.apache.tapestry5.beaneditor.BeanModel;
   18   
   19   /**
   20    * A provider of model data to the sub-components of the {@link org.apache.tapestry5.corelib.components.Grid} component.
   21    * The primary implementor of this component is the Grid component itself. This is effectively a way to package three
   22    * values as a single parameter to components such as {@link org.apache.tapestry5.corelib.components.GridColumns} and
   23    * {@link org.apache.tapestry5.corelib.components.GridRows}.
   24    */
   25   public interface GridModel
   26   {
   27       /**
   28        * Returns the data model, which defines the columns (in terms of properties of the row type), and provides access
   29        * to actual values for a given row instance.
   30        */
   31       BeanModel getDataModel();
   32   
   33       /**
   34        * Returns the source for the data to be presented in the Grid.
   35        */
   36       GridDataSource getDataSource();
   37   
   38       /**
   39        * Returns the object used to track sorting behavior of the Grid.
   40        */
   41       GridSortModel getSortModel();
   42   }