Java Doc for SequenceHelper.java in  » Web-Framework » aranea-mvc-1.1.1 » org » araneaframework » uilib » list » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » Web Framework » aranea mvc 1.1.1 » org.araneaframework.uilib.list 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   org.araneaframework.uilib.list.SequenceHelper

SequenceHelper
public class SequenceHelper implements Serializable(Code)
This class incapsulates all the information and behavior connected with the moving through the list pages. That is it translates the moves through the pages and other user activities (like expanding the list) to the exact indexes in of list item range that is to be asked from the database. In addition it provides the renderer with enough information to show the list "sequence", e.g. the breaking of list into pages and blocks.
author:
   Jevgeni Kabanov

Inner Class :public class ViewModel implements Serializable

Field Summary
final public static  longDEFAULT_ITEMS_ON_PAGE
     Default value of how many items of the list will be displayed on one page.
final public static  longDEFAULT_PAGES_ON_BLOCK
     Default value of how many pages combine into one block for quick navigation.
final public static  booleanDEFAULT_PRESERVE_STARTING_ROW
     Whether to preserve the list starting row when switching to showing full list and back.
final public static  longFULL_ITEMS_ON_PAGE
     Default value of how many items of the list will be displayed on one page.
protected  ConfigurationContextconfiguration
    

Constructor Summary
public  SequenceHelper(ConfigurationContext configuration)
     Creates the class, setting all parameters to defaults.

Method Summary
public  booleancheckChanged()
     Returns whether the basic configuration that specifies which items are shown has changed since last call to this SequenceHelper 's SequenceHelper.checkChanged method.
protected  voidfireChange()
    
protected  booleangetAllItemsShown()
    
protected  longgetBlockFirstPage()
     Gets the first page of the current block.
protected  longgetBlockLastPage()
     Gets the last page of the current block.
public  longgetCurrentPageFirstItemIndex()
     Gets first item to be displayed on the current page.
public  longgetCurrentPageLastItemIndex()
     Gets last item to be displayed on the current page.
public  longgetItemsOnPage()
     Returns how many items will be displayed on one page.
protected  longgetPageCount()
     Gets how many pages are there in the list.
public  ViewModelgetViewModel()
     Returns view model.
public  voidgoToFirstPage()
     Alters indexes to change page to the first one.
public  voidgoToLastPage()
     Alters indexes to change page to the last one.
public  voidgoToNextBlock()
     Alters indexes to change block to the next one.
public  voidgoToNextPage()
     Alters indexes to change page to the next one.
public  voidgoToPage(long page)
     Alters indexes to change page.
public  voidgoToPreviousBlock()
     Alters indexes to change block to the previous one.
public  voidgoToPreviousPage()
     Alters indexes to change page to the pervious one.
protected  voidsetAllItemsShown(boolean allItemsShown)
    
public  voidsetCurrentPage(long currentPage)
     Sets the page which will be displayed.
public  voidsetItemsOnPage(long itemsOnPage)
     Sets how many items will be displayed on one page.
public  voidsetPagesOnBlock(long pagesOnBlock)
     Sets size of the block.
public  voidsetTotalItemCount(long totalItemCount)
     Sets how many items are there in the list.
public  voidshowDefaultPages()
     Collapses the list, showing only the current page.
public  voidshowFullPages()
     Expands the list showing all items.
public  voidvalidateSequence()
    

Field Detail
DEFAULT_ITEMS_ON_PAGE
final public static long DEFAULT_ITEMS_ON_PAGE(Code)
Default value of how many items of the list will be displayed on one page.



DEFAULT_PAGES_ON_BLOCK
final public static long DEFAULT_PAGES_ON_BLOCK(Code)
Default value of how many pages combine into one block for quick navigation.



DEFAULT_PRESERVE_STARTING_ROW
final public static boolean DEFAULT_PRESERVE_STARTING_ROW(Code)
Whether to preserve the list starting row when switching to showing full list and back.



FULL_ITEMS_ON_PAGE
final public static long FULL_ITEMS_ON_PAGE(Code)
Default value of how many items of the list will be displayed on one page.



configuration
protected ConfigurationContext configuration(Code)




Constructor Detail
SequenceHelper
public SequenceHelper(ConfigurationContext configuration)(Code)
Creates the class, setting all parameters to defaults.




Method Detail
checkChanged
public boolean checkChanged()(Code)
Returns whether the basic configuration that specifies which items are shown has changed since last call to this SequenceHelper 's SequenceHelper.checkChanged method.
since:
   1.1



fireChange
protected void fireChange()(Code)

since:
   1.1



getAllItemsShown
protected boolean getAllItemsShown()(Code)

since:
   1.1



getBlockFirstPage
protected long getBlockFirstPage()(Code)
Gets the first page of the current block. Page index is 0-based. index of the page.



getBlockLastPage
protected long getBlockLastPage()(Code)
Gets the last page of the current block. Page index is 0-based. index of the page.



getCurrentPageFirstItemIndex
public long getCurrentPageFirstItemIndex()(Code)
Gets first item to be displayed on the current page. index of the first element from the list to be displayed.



getCurrentPageLastItemIndex
public long getCurrentPageLastItemIndex()(Code)
Gets last item to be displayed on the current page. index of the last element from the list to be displayed.



getItemsOnPage
public long getItemsOnPage()(Code)
Returns how many items will be displayed on one page.



getPageCount
protected long getPageCount()(Code)
Gets how many pages are there in the list. number of pages.



getViewModel
public ViewModel getViewModel()(Code)
Returns view model. view model.



goToFirstPage
public void goToFirstPage()(Code)
Alters indexes to change page to the first one. Page index is 0-based.



goToLastPage
public void goToLastPage()(Code)
Alters indexes to change page to the last one.



goToNextBlock
public void goToNextBlock()(Code)
Alters indexes to change block to the next one.



goToNextPage
public void goToNextPage()(Code)
Alters indexes to change page to the next one.



goToPage
public void goToPage(long page)(Code)
Alters indexes to change page.
Parameters:
  page - 0-based index of the page to shift to.



goToPreviousBlock
public void goToPreviousBlock()(Code)
Alters indexes to change block to the previous one.



goToPreviousPage
public void goToPreviousPage()(Code)
Alters indexes to change page to the pervious one.



setAllItemsShown
protected void setAllItemsShown(boolean allItemsShown)(Code)



setCurrentPage
public void setCurrentPage(long currentPage)(Code)
Sets the page which will be displayed. Page index is 0-based.
Parameters:
  currentPage - index of the page.



setItemsOnPage
public void setItemsOnPage(long itemsOnPage)(Code)
Sets how many items will be displayed on one page.



setPagesOnBlock
public void setPagesOnBlock(long pagesOnBlock)(Code)
Sets size of the block.
Parameters:
  pagesOnBlock - number of pages combined into one block.



setTotalItemCount
public void setTotalItemCount(long totalItemCount)(Code)
Sets how many items are there in the list.
Parameters:
  totalItemCount - size of the list.



showDefaultPages
public void showDefaultPages()(Code)
Collapses the list, showing only the current page.



showFullPages
public void showFullPages()(Code)
Expands the list showing all items.



validateSequence
public void validateSequence()(Code)



Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.