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 * Components that implement this interface will be pageable, they should return the pagecount so
023 * that an object/component knows how many pages it can use for the setCurrentPage method.
024 * 
025 * The PageableListView is one example that is Pageable. But also a Form could be pageable so that
026 * you can scroll to sets of records that you display in that form with any navigator you want.
027 * 
028 * @author jcompagner
029 */
030public interface IPageable extends IClusterable
031{
032        /**
033         * @return The current page that is or will be rendered (page number is zero-based)
034         */
035        long getCurrentPage();
036
037        /**
038         * Sets the a page that should be rendered (page number is zero-based)
039         * 
040         * @param page
041         *            The page that should be rendered.
042         */
043        void setCurrentPage(long page);
044
045        /**
046         * Gets the total number of pages this pageable object has.
047         * 
048         * @return The total number of pages this pageable object has
049         */
050        long getPageCount();
051}