Java Doc for HtmlPageBase.java in  » J2EE » Sofia » com » salmonllc » html » 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 » Sofia » com.salmonllc.html 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   com.salmonllc.html.HtmlPageBase

All known Subclasses:   com.salmonllc.html.HtmlPage,  com.salmonllc.html.HtmlFrameset,
HtmlPageBase
abstract public class HtmlPageBase implements Serializable(Code)
This abstract class is the base class for the HTMLPage and HTMLFrameset classes


Field Summary
final public static  StringAPPLICATION_ALIAS_SESSION_KEY
    
final public static  intBROWSER_DREAMWEAVER
    
final public static  intBROWSER_MICROSOFT
    
final public static  intBROWSER_NETSCAPE
    
final public static  intBROWSER_OS_MAC
    
final public static  intBROWSER_OS_OTHER
    
final public static  intBROWSER_OS_WINDOWS
    
final public static  StringLANGUAGE_SESSION_KEY
    
protected  String_subPageNameValue
    
protected  boolean_useDisabledAttribute
    
final protected static  booleandebug
    


Method Summary
public  voidapplySkin(Skin skin, boolean doSetTheme)
     Applies the skin to the page.
public  voidclearDefaultSkin(boolean forAllApps)
    
public  voidclearLanguagePreferences()
    
public  voidclearPageFromSession()
     This method will remove all instances the current page from the session.
public  voidclearPageFromSession(String pageName)
     This method will remove all instances of a page from the session.
public static  voiddisplayError(String error, Exception e, PrintWriter p)
     Called By the framework if a call to the page results in an error.
abstract public  voidgenerateHTML(PrintWriter p)
    
public  StringgetApplicationName()
     This method gets the name of the application that the page is part of.
public  intgetBrowserOS()
     This method Returns the Operating System the browser is running in.
public  floatgetBrowserSubVersion()
     This method was created in VisualAge.
public  intgetBrowserType()
     This method Returns the Browser Type: BROWSER_NETSCAPE or BROWSER_MICROSOFT.
public  intgetBrowserVersion()
     This method was created in VisualAge.
public  StringgetContentType()
     This method was created in VisualAge.
public  HttpServletRequestgetCurrentRequest()
     This method gets the current HttpServletRequest for the page.
public  HttpServletResponsegetCurrentResponse()
     This method gets the current HttpServletResponse for the page.
public  booleangetDisableRedirect()
     This method was created in VisualAge.
public  booleangetForwardPerformed()
    
public  booleangetGenerateFullHTML()
     This method sets whether or not the page will generate full html.
public  booleangetHistoryFixUp()
     This method gets whether or not the pages history fixup mechanism is enabled.
public  LanguagePreferencesgetLanguagePreferences()
    
public  StringgetOrigApplicationName()
     This method returns the original name of the application if application alaising is used.
public  StringgetPageName()
     This method gets the name of the page.
public  PropsgetPageProperties()
     This method gets the current Properties Object (com.salmonllc.properties.props) associated with this page.
public  PortletInfogetPortletInfo()
    
public  StringgetServerURL()
     This method gets the current url for the server that the page is running on.
public  StringgetServletBaseURL()
     This method gets the base url for servlets in this environment from the server name up to but not including the servlet name.
public  StringgetServletPath()
     This method gets the path for the servlet that ran the page.
public  HttpSessiongetSession()
     This method gets the current HttpSession used by this page.
public  SkingetSkin()
     Gets the skin for this page.
public  StringgetSubPageName()
     If the user went to a subpage, this method will return the name of it.
public  booleangetUseDisabledAttribute()
    
abstract public  voidinitialize()
     This method should be overridden in subclasses of the page class.
public  booleanisRequestFromPortlet()
    
public  booleanisSessionExpired()
     This method will indicate whether the session for the current page request is expired.
public  voidloadProperties()
     Called By the framework when the page is created to load properties from property files.
abstract public  voidprocessParms(boolean iFrameSubmit)
     This method will process the parms from a post for every component in the page.
public  voidresetApplicationAlias()
     This method will set an alias for the current application for the current user session.
public  voidsetApplicationAlias(String applicationAlias)
     This method will set an alias for the current application for the current user session.
public  voidsetApplicationName(String name)
    
public  voidsetContentType(String contentType)
    
public  voidsetCurrentRequest(ActionRequest r)
     Called By the framework to on each request to set the HttpServletRequest.
public  voidsetCurrentRequest(HttpServletRequest r)
     Called By the framework to on each request to set the HttpServletRequest.
public  voidsetCurrentResponse(HttpServletResponse r)
     Called By the framework to on each request to set the servlet response.
public  voidsetCurrentResponse(ActionResponse res, ActionRequest req)
     Called By the framework to on each request to set the servlet response.
public  voidsetDefaultSkin(Skin skin, boolean forAllApps)
     Sets the Default Skin for all pages.
public  voidsetDisableRedirect(boolean bRedirect)
     This method sets whether or not the page will do a redirect for each submit.
public  voidsetForwardPerformed(boolean forwardPerformed)
    
public  voidsetGenerateFullHTML(boolean gen)
     This method sets whether or not the page will generate full html.
public  voidsetHistoryFixUp(boolean ok)
     This method enables or disables the pages history fixup mechanism.
public  voidsetLanguagePrefrence(LanguagePreferences pref)
    
public  voidsetOrigApplicationName(String name)
     Called By the framework to on each request to set the Application Name.
public  voidsetPageName(String name)
     Called By the framework to on each request to set the page name.
public  voidsetPortletInfo(PortletInfo info)
    
public  voidsetServerURL(String url)
     Called By the framework to on each request to set the Server's URL.
public  voidsetServletBaseURL(String url)
     Called By the framework to on each request to set the Base URL for the servlet.
public  voidsetSession(HttpSession s)
     Called By the framework to on each request to set the HttpSession.
public  voidsetSessionExpired(boolean exp)
     Called By the framework to on each request to set whether the session is expired.
public  voidsetSkin(Skin skin)
    
public  voidsetSubPageName(String name)
     Called By the framework to on each request to set the name of the subpage selected.
public  voidsetUpLanguagePreferences()
     This method sets up the language prefrences for the page.
public  voidsetUseDisabledAttribute(boolean useDisabledAttribute)
    

Field Detail
APPLICATION_ALIAS_SESSION_KEY
final public static String APPLICATION_ALIAS_SESSION_KEY(Code)



BROWSER_DREAMWEAVER
final public static int BROWSER_DREAMWEAVER(Code)



BROWSER_MICROSOFT
final public static int BROWSER_MICROSOFT(Code)



BROWSER_NETSCAPE
final public static int BROWSER_NETSCAPE(Code)



BROWSER_OS_MAC
final public static int BROWSER_OS_MAC(Code)



BROWSER_OS_OTHER
final public static int BROWSER_OS_OTHER(Code)



BROWSER_OS_WINDOWS
final public static int BROWSER_OS_WINDOWS(Code)



LANGUAGE_SESSION_KEY
final public static String LANGUAGE_SESSION_KEY(Code)



_subPageNameValue
protected String _subPageNameValue(Code)



_useDisabledAttribute
protected boolean _useDisabledAttribute(Code)



debug
final protected static boolean debug(Code)





Method Detail
applySkin
public void applySkin(Skin skin, boolean doSetTheme)(Code)
Applies the skin to the page. This method is called from the framework and should not be called directly. Instead use setSkin(Skin sk)



clearDefaultSkin
public void clearDefaultSkin(boolean forAllApps)(Code)
Removes a default skin set by calling the setDefaultSkinMethod
Parameters:
  forAllApps - true if you want to clear the skin for all applications on the server, false if only for the app the component is in.



clearLanguagePreferences
public void clearLanguagePreferences()(Code)
This method removes the current language preferneces so it will be reloaded on the next page hit



clearPageFromSession
public void clearPageFromSession()(Code)
This method will remove all instances the current page from the session. Future calls to the page will create and initialize a new page each time.



clearPageFromSession
public void clearPageFromSession(String pageName)(Code)
This method will remove all instances of a page from the session. Future calls to the page will create and initialize a new page each time.



displayError
public static void displayError(String error, Exception e, PrintWriter p)(Code)
Called By the framework if a call to the page results in an error. This method should not be called directly.



generateHTML
abstract public void generateHTML(PrintWriter p) throws Exception(Code)
This method will generate the html for each component in the page



getApplicationName
public String getApplicationName()(Code)
This method gets the name of the application that the page is part of.



getBrowserOS
public int getBrowserOS()(Code)
This method Returns the Operating System the browser is running in. Valid return values are BROWSER_OS_MICROSOFT, BROWSER_OS_MAC or BROWSER_OS_OTHER;



getBrowserSubVersion
public float getBrowserSubVersion()(Code)
This method was created in VisualAge. int



getBrowserType
public int getBrowserType()(Code)
This method Returns the Browser Type: BROWSER_NETSCAPE or BROWSER_MICROSOFT.



getBrowserVersion
public int getBrowserVersion()(Code)
This method was created in VisualAge. int



getContentType
public String getContentType()(Code)
This method was created in VisualAge. java.lang.String



getCurrentRequest
public HttpServletRequest getCurrentRequest()(Code)
This method gets the current HttpServletRequest for the page.



getCurrentResponse
public HttpServletResponse getCurrentResponse()(Code)
This method gets the current HttpServletResponse for the page.



getDisableRedirect
public boolean getDisableRedirect()(Code)
This method was created in VisualAge. boolean



getForwardPerformed
public boolean getForwardPerformed()(Code)
This method is called by the framework and should not be called directly



getGenerateFullHTML
public boolean getGenerateFullHTML()(Code)
This method sets whether or not the page will generate full html. Setting the property to false will cause the page to only generate the html in the contained components and not any headers or footers.



getHistoryFixUp
public boolean getHistoryFixUp()(Code)
This method gets whether or not the pages history fixup mechanism is enabled.



getLanguagePreferences
public LanguagePreferences getLanguagePreferences()(Code)
This method returns the users language preference



getOrigApplicationName
public String getOrigApplicationName()(Code)
This method returns the original name of the application if application alaising is used. In that case getApplicationName will return the name of the alias and getOrigApplication name will get the "real" name of the application. If aliasing isn't used, they will both return the same value.



getPageName
public String getPageName()(Code)
This method gets the name of the page.



getPageProperties
public Props getPageProperties()(Code)
This method gets the current Properties Object (com.salmonllc.properties.props) associated with this page.



getPortletInfo
public PortletInfo getPortletInfo()(Code)



getServerURL
public String getServerURL()(Code)
This method gets the current url for the server that the page is running on.



getServletBaseURL
public String getServletBaseURL()(Code)
This method gets the base url for servlets in this environment from the server name up to but not including the servlet name.



getServletPath
public String getServletPath()(Code)
This method gets the path for the servlet that ran the page.



getSession
public HttpSession getSession()(Code)
This method gets the current HttpSession used by this page.



getSkin
public Skin getSkin()(Code)
Gets the skin for this page. If one isn't found, the system will look for a default one for the application or all applications on the session.



getSubPageName
public String getSubPageName()(Code)
If the user went to a subpage, this method will return the name of it.



getUseDisabledAttribute
public boolean getUseDisabledAttribute()(Code)
This method is used to indicate whether components on the page should use the Html disabled attribute for disabled form components



initialize
abstract public void initialize() throws Exception(Code)
This method should be overridden in subclasses of the page class. In the method, HTML components should be created and placed in the page, listeners registered and any other initialization tasks should be performed.



isRequestFromPortlet
public boolean isRequestFromPortlet()(Code)



isSessionExpired
public boolean isSessionExpired()(Code)
This method will indicate whether the session for the current page request is expired.



loadProperties
public void loadProperties()(Code)
Called By the framework when the page is created to load properties from property files. This method should not be called directly.



processParms
abstract public void processParms(boolean iFrameSubmit) throws Exception(Code)
This method will process the parms from a post for every component in the page.



resetApplicationAlias
public void resetApplicationAlias()(Code)
This method will set an alias for the current application for the current user session. Every page created in this application after this method is called will have its application name initialized to the specified alias name instead of the application name. This will cause the application to use a different property file to load page and component properties.



setApplicationAlias
public void setApplicationAlias(String applicationAlias)(Code)
This method will set an alias for the current application for the current user session. Every page created in this application after this method is called will have its application name initialized to the specified alias name instead of the application name. This will cause the application to use a different property file to load page and component properties.



setApplicationName
public void setApplicationName(String name)(Code)



setContentType
public void setContentType(String contentType)(Code)
Sets the mime type that this page will return to the browser



setCurrentRequest
public void setCurrentRequest(ActionRequest r)(Code)
Called By the framework to on each request to set the HttpServletRequest. This method should not be called directly.



setCurrentRequest
public void setCurrentRequest(HttpServletRequest r)(Code)
Called By the framework to on each request to set the HttpServletRequest. This method should not be called directly.



setCurrentResponse
public void setCurrentResponse(HttpServletResponse r)(Code)
Called By the framework to on each request to set the servlet response. This method should not be called directly.



setCurrentResponse
public void setCurrentResponse(ActionResponse res, ActionRequest req)(Code)
Called By the framework to on each request to set the servlet response. This method should not be called directly.



setDefaultSkin
public void setDefaultSkin(Skin skin, boolean forAllApps)(Code)
Sets the Default Skin for all pages. To apply the skin to pages already created you should clear them from the session after making this call.
Parameters:
  skin - the Skin to set
Parameters:
  forAllApps - true if you want to set the skin for all applications on the server, false if only for the app the component is in.



setDisableRedirect
public void setDisableRedirect(boolean bRedirect)(Code)
This method sets whether or not the page will do a redirect for each submit. The redirect prevents browsers from displaying a page expired message when the user clicks the back button.
Parameters:
  bRedirect - boolean



setForwardPerformed
public void setForwardPerformed(boolean forwardPerformed)(Code)
This method is called by the framework and should not be called directly



setGenerateFullHTML
public void setGenerateFullHTML(boolean gen)(Code)
This method sets whether or not the page will generate full html. Setting the property to false will cause the page to only generate the html in the contained components and not any headers or footers.



setHistoryFixUp
public void setHistoryFixUp(boolean ok)(Code)
This method enables or disables the pages history fixup mechanism.



setLanguagePrefrence
public void setLanguagePrefrence(LanguagePreferences pref)(Code)
Use this to override the language preferences sent by the browser



setOrigApplicationName
public void setOrigApplicationName(String name)(Code)
Called By the framework to on each request to set the Application Name. This method should not be called directly.



setPageName
public void setPageName(String name)(Code)
Called By the framework to on each request to set the page name. This method should not be called directly.



setPortletInfo
public void setPortletInfo(PortletInfo info)(Code)

Parameters:
  iframework - method, do not call directly



setServerURL
public void setServerURL(String url)(Code)
Called By the framework to on each request to set the Server's URL. This method should not be called directly.



setServletBaseURL
public void setServletBaseURL(String url)(Code)
Called By the framework to on each request to set the Base URL for the servlet. This method should not be called directly.



setSession
public void setSession(HttpSession s)(Code)
Called By the framework to on each request to set the HttpSession. This method should not be called directly.



setSessionExpired
public void setSessionExpired(boolean exp)(Code)
Called By the framework to on each request to set whether the session is expired. This method should not be called directly.



setSkin
public void setSkin(Skin skin)(Code)
Sets the skin for this page and applies it
Parameters:
  skin -



setSubPageName
public void setSubPageName(String name)(Code)
Called By the framework to on each request to set the name of the subpage selected. This method should not be called directly.



setUpLanguagePreferences
public void setUpLanguagePreferences()(Code)
This method sets up the language prefrences for the page. This method should is called by the framework and should not be called directly



setUseDisabledAttribute
public void setUseDisabledAttribute(boolean useDisabledAttribute)(Code)
This method is used to indicate whether components on the page should use the Html disabled attribute for disabled form components



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.