[deliverable/tracecompass.git] / org.eclipse.linuxtools.tmf.ui / src / org / eclipse / linuxtools / tmf / ui / views / uml2sd / handlers / provider / ISDAdvancedPagingProvider.java

/**********************************************************************
 * Copyright (c) 2005, 2006, 2011 IBM Corporation and others.
 * All rights reserved.   This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 * $Id: ISDAdvancedPagingProvider.java,v 1.2 2006/09/20 20:56:26 ewchan Exp $
 * 
 * Contributors: 
 * IBM - Initial API and implementation
 * Bernd Hufmann - Updated for TMF
 **********************************************************************/
package org.eclipse.linuxtools.tmf.ui.views.uml2sd.handlers.provider;

/**
 * An advanced paging provider is able to compute number of pages, and to display the number of items it treats on each
 * page and for total counts.<br>
 * An item can be a message, a node or anything meaningful from loader standpoint.<br>
 * Items are only here for information to the user.
 */
public interface ISDAdvancedPagingProvider extends ISDPagingProvider {

    /**
     * @return the current page the loader is dealing with <b>Note<b> that first page has the 0 index (indexes are from
     *         0 to pagesCount()-1).
     */
    public int currentPage();

    /**
     * @return number of pages the loader is dealing with
     */
    public int pagesCount();

    /**
     * Instructs a load of the &lt;pageNumber_&gt;<i>th</i> page.<br>
     * <b>Note<b> that first page has the index 0 (indexes are from 0 to pagesCount()-1).
     * 
     * @param pageNumber_ index of the page to load
     */
    public void pageNumberChanged(int pageNumber_);

}
Commit	Line	Data
73005152 BH	1	/**********************************************************************
	2	* Copyright (c) 2005, 2006, 2011 IBM Corporation and others.
	3	* All rights reserved. This program and the accompanying materials
	4	* are made available under the terms of the Eclipse Public License v1.0
	5	* which accompanies this distribution, and is available at
	6	* http://www.eclipse.org/legal/epl-v10.html
	7	* $Id: ISDAdvancedPagingProvider.java,v 1.2 2006/09/20 20:56:26 ewchan Exp $
	8	*
	9	* Contributors:
	10	* IBM - Initial API and implementation
	11	* Bernd Hufmann - Updated for TMF
	12	**********************************************************************/
	13	package org.eclipse.linuxtools.tmf.ui.views.uml2sd.handlers.provider;
	14
	15	/**
	16	* An advanced paging provider is able to compute number of pages, and to display the number of items it treats on each
	17	* page and for total counts.<br>
	18	* An item can be a message, a node or anything meaningful from loader standpoint.<br>
	19	* Items are only here for information to the user.
	20	*/
	21	public interface ISDAdvancedPagingProvider extends ISDPagingProvider {
	22
	23	/**
	24	* @return the current page the loader is dealing with <b>Note<b> that first page has the 0 index (indexes are from
	25	* 0 to pagesCount()-1).
	26	*/
	27	public int currentPage();
	28
	29	/**
	30	* @return number of pages the loader is dealing with
	31	*/
	32	public int pagesCount();
	33
	34	/**
	35	* Instructs a load of the <pageNumber_><i>th</i> page.<br>
	36	* <b>Note<b> that first page has the index 0 (indexes are from 0 to pagesCount()-1).
	37	*
	38	* @param pageNumber_ index of the page to load
	39	*/
	40	public void pageNumberChanged(int pageNumber_);
	41
	42	}