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

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