Java Doc for WikiPageInfo.java in  » Wiki-Engine » JAMWiki » org » jamwiki » servlets » 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 » Wiki Engine » JAMWiki » org.jamwiki.servlets 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   org.jamwiki.servlets.WikiPageInfo

WikiPageInfo
public class WikiPageInfo (Code)
The WikiPageInfo class provides an object containing common data used for generating wiki page display.


Field Summary
final protected static  StringJSP_TOPIC
    

Constructor Summary
protected  WikiPageInfo()
    

Method Summary
public  booleangetAdmin()
     If a page is a part of the admin tool then this method will return true.
public  StringgetContentJsp()
     Retrieve the name of the JSP page that will be used to display the results of this page request.
public  StringgetMetaDescription()
     Return a description for the current page that can be used in an HTML meta tag.
public  StringgetNamespace()
     Return the namespace of the topic displayed by the current page.
public  WikiMessagegetPageTitle()
     Return the title for the current page.
public  StringgetPagename()
     Return the name of the page, i.e.
public  StringgetPrintTarget()
     If printable pages should open in a new window then this method will return the HTML target "_blank", otherwise this method returns an empty String.
public  StringgetRSSTitle()
     Return the base title used with RSS feeds.
public  StringgetRedirectName()
     If the topic currently being displayed is the result of a redirect from another topic, return the name of the topic that is being redirected from.
public  booleangetSpecial()
     Return a flag indicating whether or not the current page is a "Special:" page, as opposed to a standard topic.
public  LinkedHashMapgetTabMenu()
     Return a LinkedHashMap containing the topic and text for all links that should appear for the tab menu.
public  StringgetTopicName()
     Return the name of the topic being displayed by the current page.
public  LinkedHashMapgetUserMenu()
     Return a LinkedHashMap containing the topic and text for all links that should appear for the user menu.
public  booleanisUserPage()
    
protected  voidreset()
     Reset all parameters of the current WikiPageInfo object to default values.
public  voidsetAdmin(boolean admin)
     Set a flag indicating whether or not the page being displayed is a part of the admin tool.
public  voidsetContentJsp(String contentJsp)
     Set the JSP page that will display the results of this page request.
public  voidsetPageTitle(WikiMessage pageTitle)
     Set the title for the current page.
public  voidsetRedirectName(String redirectName)
     If the topic currently being displayed is the result of a redirect from another topic, set the name of the topic that is being redirected from.
public  voidsetSpecial(boolean special)
     Set a flag indicating whether or not the current page is a "Special:" page, as opposed to a standard topic.
public  voidsetTabMenu(LinkedHashMap tabMenu)
     Set a LinkedHashMap containing the topic and text for all links that should appear for the tab menu.
public  voidsetTopicName(String topicName)
     Set the name of the topic being displayed by the current page.
public  voidsetUserMenu(LinkedHashMap userMenu)
     Set a LinkedHashMap containing the topic and text for all links that should appear for the user menu.

Field Detail
JSP_TOPIC
final protected static String JSP_TOPIC(Code)




Constructor Detail
WikiPageInfo
protected WikiPageInfo()(Code)




Method Detail
getAdmin
public boolean getAdmin()(Code)
If a page is a part of the admin tool then this method will return true. true if a page is part of the admin tool,false otherwise.



getContentJsp
public String getContentJsp()(Code)
Retrieve the name of the JSP page that will be used to display the results of this page request. The name of the JSP page that will be used to display theresults of the page request.



getMetaDescription
public String getMetaDescription()(Code)
Return a description for the current page that can be used in an HTML meta tag. A description for the current page that can be used in an HTMLmeta tag.



getNamespace
public String getNamespace()(Code)
Return the namespace of the topic displayed by the current page. The namespace is the part of topic name, up to the colon. For regular articles the namespace is an empty string. The namespace cannot be set directly, only the topic name can be set. The wiki namespace of this page, or an empty string for pagesin the main namespace.
See Also:   WikiPageInfo.getPagename
See Also:   WikiPageInfo.getTopicName



getPageTitle
public WikiMessage getPageTitle()(Code)
Return the title for the current page. The title for the current page.



getPagename
public String getPagename()(Code)
Return the name of the page, i.e. the name of the topic displayed by the current page, without the namespace. Name of the page.



getPrintTarget
public String getPrintTarget()(Code)
If printable pages should open in a new window then this method will return the HTML target "_blank", otherwise this method returns an empty String. The HTML target "_blank" if printable pages should open in anew window, otherwise an empty String.



getRSSTitle
public String getRSSTitle()(Code)
Return the base title used with RSS feeds. The base title used with RSS feeds.



getRedirectName
public String getRedirectName()(Code)
If the topic currently being displayed is the result of a redirect from another topic, return the name of the topic that is being redirected from. The name of the topic being redirected from, ornull if the current page is not the result of a redirect.



getSpecial
public boolean getSpecial()(Code)
Return a flag indicating whether or not the current page is a "Special:" page, as opposed to a standard topic. true if the current page is a "Special:" page,false otherwise.



getTabMenu
public LinkedHashMap getTabMenu()(Code)
Return a LinkedHashMap containing the topic and text for all links that should appear for the tab menu. A LinkedHashMap containing the topic and text for all linksthat should appear for the tab menu.



getTopicName
public String getTopicName()(Code)
Return the name of the topic being displayed by the current page. The name of the topic being displayed by the current page.



getUserMenu
public LinkedHashMap getUserMenu()(Code)
Return a LinkedHashMap containing the topic and text for all links that should appear for the user menu. A LinkedHashMap containing the topic and text for all linksthat should appear for the user menu.



isUserPage
public boolean isUserPage()(Code)
If the page currently being viewed is a user page or a user comments page return true true if the page currently being viewed is auser page, otherwise false.



reset
protected void reset()(Code)
Reset all parameters of the current WikiPageInfo object to default values.



setAdmin
public void setAdmin(boolean admin)(Code)
Set a flag indicating whether or not the page being displayed is a part of the admin tool.
Parameters:
  admin - true if a page is part of the admin tool,false otherwise.



setContentJsp
public void setContentJsp(String contentJsp)(Code)
Set the JSP page that will display the results of this page request. If no value is specified then the default is to display the request using the topic display JSP.
Parameters:
  contentJsp - The JSP page that should be used to display theresults of the page request.



setPageTitle
public void setPageTitle(WikiMessage pageTitle)(Code)
Set the title for the current page.
Parameters:
  pageTitle - A WikiMessage object that contains atranslatable page title value.



setRedirectName
public void setRedirectName(String redirectName)(Code)
If the topic currently being displayed is the result of a redirect from another topic, set the name of the topic that is being redirected from.
Parameters:
  redirectName - The name of the topic being redirected from, ornull if the current page is not the result of a redirect.



setSpecial
public void setSpecial(boolean special)(Code)
Set a flag indicating whether or not the current page is a "Special:" page, as opposed to a standard topic.
Parameters:
  special - Set to true if the current page is a"Special:" page, false otherwise.



setTabMenu
public void setTabMenu(LinkedHashMap tabMenu)(Code)
Set a LinkedHashMap containing the topic and text for all links that should appear for the tab menu.
Parameters:
  tabMenu - A LinkedHashMap containing the topic and text for alllinks that should appear for the tab menu.



setTopicName
public void setTopicName(String topicName)(Code)
Set the name of the topic being displayed by the current page.
Parameters:
  topicName - The name of the topic being displayed by the currentpage.



setUserMenu
public void setUserMenu(LinkedHashMap userMenu)(Code)
Set a LinkedHashMap containing the topic and text for all links that should appear for the user menu.
Parameters:
  userMenu - A LinkedHashMap containing the topic and text for alllinks that should appear for the user menu.



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.