001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.apache.wicket.markup.html.navigation.paging;
018
019import org.apache.wicket.util.io.IClusterable;
020
021/**
022 * This interface is used by the PagingNavigator components to get the label of the pages there are
023 * for a IPageable component. By default this is only the page number.
024 * 
025 * @author jcompagner
026 */
027public interface IPagingLabelProvider extends IClusterable
028{
029        /**
030         * @param page
031         *            The page number for which the label must be generated.
032         * @return The string to be displayed for this page number
033         */
034        String getPageLabel(long page);
035}