Java Doc for HistoryNav.java in  » J2EE » Jaffa » org » jaffa » presentation » portlet » 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 » J2EE » Jaffa » org.jaffa.presentation.portlet 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   org.jaffa.presentation.portlet.HistoryNav

HistoryNav
public class HistoryNav (Code)
This is a helper class for marshalling the HistoryNavList into XML and vice versa.
author:
   GautamJ


Field Summary
final public static  StringHISTORY_NAV_PARAMETER
     Constant to denote the 'historyNav' parameter.


Method Summary
public static  voidaddFormKeyToHistoryNav(HttpServletRequest request, FormKey fk)
     This will add the input FormKey to the historyNav.
public static  Listdecode(String historyNavXml)
     This will unmarshal the input XML into a List of FormKey objects.
Parameters:
  historyNavXml - The XML representation of the historyNavList.
public static  Stringencode(List historyNavList)
     This will marhsal the input List into XML.
public static  ListinitializeHistoryNav(HttpServletRequest request)
     This will initialze a List with the 'jaffa_home' link and set the 'historyNav' attribute on the input request stream with the new List.
public static  ListinitializeHistoryNav(HttpServletRequest request, String finalUrl)
     This will initialze a List with the 'jaffa_home' link and set the 'historyNav' attribute on the input request stream with the new List. It will also add a link for the finalUrl, the title for which should be passed in as the value for the paramter "desktopName" or "title", within the finalUrl.
Parameters:
  request - The request stream
Parameters:
  finalUrl - The final Url encoded in UTF-8 format.
throws:
  UnsupportedEncodingException - if the UTF-8 format is not supported.
public static  ListobtainHistoryNav(HttpServletRequest request)
     This will search the request stream for the attribute 'historyNav'.

Field Detail
HISTORY_NAV_PARAMETER
final public static String HISTORY_NAV_PARAMETER(Code)
Constant to denote the 'historyNav' parameter.





Method Detail
addFormKeyToHistoryNav
public static void addFormKeyToHistoryNav(HttpServletRequest request, FormKey fk)(Code)
This will add the input FormKey to the historyNav. If the historyNav didn't exist, then one will be initialized. If the input FormKey already existed on the historyNav, then all subsequent FormKeys will be removed from the list. Also, all the subsequent components will be closed.
Parameters:
  request - The request stream.
Parameters:
  fk - The FormKey to add.



decode
public static List decode(String historyNavXml)(Code)
This will unmarshal the input XML into a List of FormKey objects.
Parameters:
  historyNavXml - The XML representation of the historyNavList. The List of FormKey objects.



encode
public static String encode(List historyNavList)(Code)
This will marhsal the input List into XML. The List is assumed to contain FormKey objects.
Parameters:
  historyNavList - The List of FormKey objects. The XML representation of the historyNavList.



initializeHistoryNav
public static List initializeHistoryNav(HttpServletRequest request)(Code)
This will initialze a List with the 'jaffa_home' link and set the 'historyNav' attribute on the input request stream with the new List.
Parameters:
  request - The request stream the newly initialized List.



initializeHistoryNav
public static List initializeHistoryNav(HttpServletRequest request, String finalUrl) throws UnsupportedEncodingException(Code)
This will initialze a List with the 'jaffa_home' link and set the 'historyNav' attribute on the input request stream with the new List. It will also add a link for the finalUrl, the title for which should be passed in as the value for the paramter "desktopName" or "title", within the finalUrl.
Parameters:
  request - The request stream
Parameters:
  finalUrl - The final Url encoded in UTF-8 format.
throws:
  UnsupportedEncodingException - if the UTF-8 format is not supported. should never happen. the newly initialized List.



obtainHistoryNav
public static List obtainHistoryNav(HttpServletRequest request)(Code)
This will search the request stream for the attribute 'historyNav'. If not found, it'll search for the parameter 'historyNav'. This parameter is expected to be in XML format and will be decoded into a List
Parameters:
  request - The request stream. The List containing the links for the HistoryNav.



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.