org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/views/uml2sd/handlers/provider/ISDPagingProvider.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  * Paging provider interface.
  18  *
  19  * Sequence Diagram loaders which implement this class provide the actions for sequence diagram page navigation.<br>
  20  *
  21  * Action provider are associated to a Sequence Diagram view by calling <code>SDView.setSDPagingProvider()</code>.<br>
  22  *
  23  * @version 1.0
  24  * @author sveyrier
  25  *
  26  */
  27 public interface ISDPagingProvider {
  28
  29     /**
  30      * Return true to enable the next page button in the coolBar, false otherwise
  31      *
  32      * @return true if a next page exists false otherwise
  33      */
  34     public boolean hasNextPage();
  35
  36     /**
  37      * Return true to enable the previous page button in the coolBar, false otherwise
  38      *
  39      * @return true if a previous page exists false otherwise
  40      */
  41     public boolean hasPrevPage();
  42
  43     /**
  44      * Called back when next page button is pressed in the coolBar
  45      */
  46     public void nextPage();
  47
  48     /**
  49      * Called back when previous page button is pressed in the coolBar
  50      */
  51     public void prevPage();
  52
  53     /**
  54      * Called back when first page button is pressed in the coolBar
  55      */
  56     public void firstPage();
  57
  58     /**
  59      * Called back when last page button is pressed in the coolBar
  60      */
  61     public void lastPage();
  62 }