pre-wicket.1.2.5/wicket-extensions/src/main/java/wicket/extensions/markup/html/repeater/data/table/IColumn.java

/*
 * $Id$ $Revision$
 * $Date$
 * 
 * ==================================================================== Licensed
 * 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 wicket.extensions.markup.html.repeater.data.table;

import wicket.Component;
import wicket.extensions.markup.html.repeater.data.grid.ICellPopulator;

/**
 * An inteface that represents a column in the {@link DefaultDataTable}
 * 
 * @author Igor Vaynberg ( ivaynberg )
 */
public interface IColumn extends ICellPopulator
{
	/**
	 * Returns the component that will be used as the header for the column.
	 * 
	 * This component will be contained in <span> tags.
	 * 
	 * @param componentId
	 *            component id for the returned Component
	 * 
	 * @return component that will be used as the header for the column
	 */
	Component getHeader(String componentId);

	/**
	 * Returns the name of the property that this header sorts. If null is
	 * returned the header will be unsortable.
	 * 
	 * @return a string representing the sort property
	 */
	String getSortProperty();

	/**
	 * Returns true if this header should be a sortable header
	 * 
	 * @return true if header should be sortable
	 */
	boolean isSortable();
}