/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.wicket.extensions.markup.html.repeater.data.table.export;
import org.apache.wicket.extensions.markup.html.repeater.data.table.IColumn;
import org.apache.wicket.model.IModel;
/**
* An {@link IColumn} that can be exported. {@link IExportableColumn}s provide methods for retrieving the data
* displayed by this column in a row. This data is used by {@link IDataExporter}s to export data.
*
* @author Jesse Long
* @param <T>
* The type of each row in the table.
* @param <S>
* The type of the sort property of the table.
* @see IDataExporter
* @see ExportToolbar
*/
public interface IExportableColumn<T, S> extends IColumn<T, S>
{
/**
* Returns an {@link IModel} of the data displayed by this column for the {@code rowModel} provided.
*
* @param rowModel
* An {@link IModel} of the row data.
* @return an {@link IModel} of the data displayed by this column for the {@code rowModel} provided.
*/
IModel<?> getDataModel(IModel<T> rowModel);
/**
* Returns a model of the column header. The content of this model is used as a heading for the column
* when it is exported.
*
* @return a model of the column header.
*/
IModel<String> getDisplayModel();
}