TPTP 4.1.0 Platform Project
Public API Specification

org.eclipse.hyades.uml2sd.ui.actions.provider
Interface ISDAdvancedPagingProvider

All Superinterfaces:
ISDPagingProvider
All Known Implementing Classes:
TraceInteractions

public interface ISDAdvancedPagingProvider
extends ISDPagingProvider

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.
An item can be a message, a node or anything meaningful from loader standpoint.
Items are only here for information to the user.


Method Summary
 int currentPage()
           
 java.lang.String itemsText()
          Deprecated.  
 int itemsTotalCount()
          Deprecated.  
 int maxItemsByPageCount()
          Deprecated.  
 java.lang.String noItemsText()
          Deprecated.  
 java.lang.String oneItemText()
          Deprecated.  
 void pageNumberChanged(int pageNumber_)
          Instructs a load of the <pageNumber_>th page.
Note that first page has the index 0 (indexes are from 0 to pagesCount()-1).
 int pagesCount()
           
 void pageSettingsChanged(int maxItemsByPage_, int pageNumber_)
          Deprecated.  
 
Methods inherited from interface org.eclipse.hyades.uml2sd.ui.actions.provider.ISDPagingProvider
hasNextPage, hasPrevPage, nextPage, prevPage
 

Method Detail

maxItemsByPageCount

public int maxItemsByPageCount()
Deprecated.  

Returns:
number of items in a page

itemsTotalCount

public int itemsTotalCount()
Deprecated.  

Returns:
the total number of items the loader is dealing with (on all pages)

noItemsText

public java.lang.String noItemsText()
Deprecated.  

Returns:
text to be shown when maxItemsByPageCount() or itemsTotalCount() return 0

oneItemText

public java.lang.String oneItemText()
Deprecated.  

Returns:
text to be shown when maxItemsByPageCount() or itemsTotalCount() return 1

itemsText

public java.lang.String itemsText()
Deprecated.  

Returns:
text to be shown when maxItemsByPageCount() or itemsTotalCount() return 2 or more

currentPage

public int currentPage()
Returns:
the current page the loader is dealing with Note that first page has the 0 index (indexes are from 0 to pagesCount()-1).

pagesCount

public int pagesCount()
Returns:
number of pages the loader is dealing with

pageSettingsChanged

public void pageSettingsChanged(int maxItemsByPage_,
                                int pageNumber_)
Deprecated.  

Updates the number of items in a page and instructs a load of <pageNumber_>th page.
Note that first page has the 0 index (indexes are from 0 to pagesCount()-1).

Parameters:
maxItemsByPage_ - index of the page to load
pageNumber_ - index of the page to load

pageNumberChanged

public void pageNumberChanged(int pageNumber_)
Instructs a load of the <pageNumber_>th page.
Note that first page has the index 0 (indexes are from 0 to pagesCount()-1).

Parameters:
pageNumber_ - index of the page to load

TPTP 4.1.0 Platform Project
Public API Specification