echopointng.table.PageableTableModel Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ibis-echo2 Show documentation
Echo2 bundled with Echo2_Extras, Echo2_FileTransfer and echopointing and various improvements/bugfixes
There is a newer version: 2.0.4
/* 
 * This file is part of the Echo2 Table Extension (hereinafter "ETE").
 * Copyright (C) 2002-2005 NextApp, Inc.
 *
 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
 *
 * The contents of this file are subject to the Mozilla Public License Version
 * 1.1 (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.mozilla.org/MPL/
 *
 * Software distributed under the License is distributed on an "AS IS" basis,
 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
 * for the specific language governing rights and limitations under the
 * License.
 *
 * Alternatively, the contents of this file may be used under the terms of
 * either the GNU General Public License Version 2 or later (the "GPL"), or
 * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
 * in which case the provisions of the GPL or the LGPL are applicable instead
 * of those above. If you wish to allow use of your version of this file only
 * under the terms of either the GPL or the LGPL, and not to allow others to
 * use your version of this file under the terms of the MPL, indicate your
 * decision by deleting the provisions above and replace them with the notice
 * and other provisions required by the GPL or the LGPL. If you do not delete
 * the provisions above, a recipient may use your version of this file under
 * the terms of any one of the MPL, the GPL or the LGPL.
 */
package echopointng.table;

import nextapp.echo2.app.table.TableModel;

/**
 * An interface for paging through rows of data in a TableModel.
 * The idea behind a PageableTableModel is that the number of
 * rows reports by it is simple a page worth and that there may be more rows
 * waiting in the wings.
 * 
 * @author Jason Dalton
 */
public interface PageableTableModel extends TableModel {

	/**
	 * Returns the currently displayed page in the range
	 * (page >= 0 && page < getTotalPages())
	 * 
	 * 
	 * @return the currently displayed page
	 */
	public int getCurrentPage();

	/**
	 * Returns the number of viewable rows per each displayed page
	 * 
	 * @return the number of viewable rows per each displayed page
	 */
	public int getRowsPerPage();

	/**
	 * Returns the total number of pages this model contains based on total rows /
	 * rows per page. Note it will always be a number greater than or equal to 1
	 * since a underlying row count less than the rows per page, still
	 * constitutes a at least one page from a UI perspective. Also
	 * TableModel wih zero rows is still considered to have 1
	 * page from a UI perspective.
	 * 
	 * @return the total number of pages for the underlying row count.
	 */
	public int getTotalPages();

	/**
	 * Returns the total number of rows in the underlying
	 * TableModel
	 * 
	 * @return the total number of rows in the underlying TableModel
	 */
	public int getTotalRows();

	/**
	 * Sets the current page this model should reflect. Implementations that
	 * sublcass DefaultTableModel should call
	 * fireTableDataChanged() to indicate that the table structure has changed
	 * and hence a redraw is necessary.
	 * 
	 * @param page
	 *            the page to display. This should in the range
	 *            (page >= 0 && page < getTotalPages())
	 * 
	 * @throws IllegalArgumentException
	 *             if the page is not in the range
	 *             (page >= 0 && page < getTotalPages())
	 */
	public void setCurrentPage(int page);

	/**
	 * Sets the number of viewable rows per each displayed page. Implementations
	 * that sublcass DefaultTableModel should call
	 * fireTableDataChanged() to indicate that the table structure has changed
	 * and hence a redraw is necessary.
	 * 
	 * @param rows
	 *            the number of rows to display
	 */
	public void setRowsPerPage(int rows);

	/**
	 * This converts the unpaged model row index into the equivalent paged view
	 * row index. When the underlying TableModel is being paged, you can use
	 * this method to map from the unpaged Model set of row indexes into the
	 * paged View row indexes.
	 * 
	 * @param modelRowIndex -
	 *            a row index in terms of the unpaged model that you want to
	 *            convert to a paged view row index
	 * @return a paged view row index
	 */
	public int toPagedViewRowIndex(int modelRowIndex);

	/**
	 * This converts the paged view row index into the equivalent unpaged model
	 * row index. When the underlying TableModel is being paged, you can use
	 * this method to map from the paged View set of row indexes into the
	 * underlying unpaged TableModel row indexes.
	 * 
	 * @param viewRowIndex -
	 *            a row index in terms of the page view that you want to convert
	 *            to a unpaged model row index
	 * @return a unpaged model row index
	 */
	public int toUnpagedModelRowIndex(int viewRowIndex);
}