org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/views/uml2sd/handlers/provider/ISDAdvancedPagingProvider.java

   1 /**********************************************************************
   2  * Copyright (c) 2005, 2013 IBM Corporation, Ericsson
   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  *
   8  * Contributors:
   9  *     IBM - Initial API and implementation
  10  *     Bernd Hufmann - Updated for TMF
  11  **********************************************************************/
  12
  13 package org.eclipse.linuxtools.tmf.ui.views.uml2sd.handlers.provider;
  14
  15 /**
  16  * Interface for providing an extended find provider.
  17  *
  18  * An advanced paging provider is able to compute number of pages, and to display the number of items it treats on each
  19  * page and for total counts.<br>
  20  * An item can be a message, a node or anything meaningful from loader standpoint.<br>
  21  * Items are only here for information to the user.
  22  *
  23  * @version 1.0
  24  * @author sveyrier
  25  */
  26 public interface ISDAdvancedPagingProvider extends ISDPagingProvider {
  27
  28     /**
  29      * Returns the current page.
  30      *
  31      * @return the current page the loader is dealing with. <b>Note</b> that first page has the 0 index (indexes are from
  32      *         0 to pagesCount()-1).
  33      */
  34     int currentPage();
  35
  36     /**
  37      * Returns the number of pages.
  38      *
  39      * @return number of pages the loader is dealing with
  40      */
  41     int pagesCount();
  42
  43     /**
  44      * Instructs a load of the &lt;pageNumber_&gt;<i>th</i> page.<br>
  45      * <b>Note</b> that first page has the index 0 (indexes are from 0 to pagesCount()-1).
  46      *
  47      * @param pageNumber index of the page to load
  48      */
  49     void pageNumberChanged(int pageNumber);
  50
  51 }