Java Doc for URL.java in  » J2EE » webwork-2.2.6 » com » opensymphony » webwork » components » 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 » webwork 2.2.6 » com.opensymphony.webwork.components 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   com.opensymphony.webwork.components.Component
      com.opensymphony.webwork.components.URL

URL
public class URL extends Component (Code)

This tag is used to create a URL.

You can use the "param" tag inside the body to provide additional request parameters.

NOTE:

When includeParams is 'all' or 'get', the parameter defined in param tag will take precedence and will not be overriden if they exists in the parameter submitted. For example, in Example 3 below, if there is a id parameter in the url where the page this tag is included like http://://editUser.action?id=3333&name=John the generated url will be http://:/context>/editUser.action?id=22&name=John cause the parameter defined in the param tag will take precedence.

  • action (String) - (value or action choose either one, if both exist value takes precedence) action's name (alias)
  • value (String) - (value or action choose either one, if both exist value takes precedence) the url itself
  • scheme (String) - http scheme (http, https) default to the scheme this request is in
  • namespace - action's namespace
  • method (String) - action's method, default to execute()
  • encode (Boolean) - url encode the generated url. Default is true
  • includeParams (String) - The includeParams attribute may have the value 'none', 'get' or 'all'. Default is 'get'. none - include no parameters in the URL get - include only GET parameters in the URL (default) all - include both GET and POST parameters in the URL
  • includeContext (Boolean) - determine wheather to include the web app context path. Default is true.

Examples

 
 <-- Example 1 -->
 <ww:url value="editGadget.action">
 <ww:param name="id" value="%{selected}" />
 </ww:url>
 <-- Example 2 -->
 <ww:url action="editGadget">
 <ww:param name="id" value="%{selected}" />
 </ww:url>
 <-- Example 3-->
 <ww:url includeParams="get"  >
 <:param name="id" value="%{'22'}" />
 </ww:url>
 
 

author:
   Rickard Öberg (rickard@dreambean.com)
author:
   Patrick Lightbody
author:
   Ian Roughley
author:
   Rene Gielen
author:
   Rainer Hermanns
author:
   tm_jee
version:
   $Revision: 2930 $
since:
   2.2
See Also:   Param


Field Summary
final public static  StringALL
    
final public static  StringGET
    
final public static  StringNONE
     The includeParams attribute may have the value 'none', 'get' or 'all'.
protected  Stringaction
    
protected  Stringanchor
    
protected  booleanencode
    
protected  booleanescapeAmp
    
protected  booleanincludeContext
    
protected  StringincludeParams
    
protected  Stringmethod
    
protected  Stringnamespace
    
protected  StringportletMode
    
protected  StringportletUrlType
    
protected  Stringscheme
    
protected  Stringvalue
    
protected  StringwindowState
    

Constructor Summary
public  URL(OgnlValueStack stack, HttpServletRequest req, HttpServletResponse res)
    

Method Summary
public  booleanend(Writer writer, String body)
    
protected  voidmergeRequestParameters(String value, Map parameters, Map contextParameters)
     Merge request parameters into current parameters.
public  voidsetAction(String action)
    
public  voidsetAnchor(String anchor)
    
public  voidsetEncode(boolean encode)
    
public  voidsetEscapeAmp(boolean escapeAmp)
     Whether to escape ampersand (&) to (&) or not, default to true.
public  voidsetIncludeContext(boolean includeContext)
    
public  voidsetIncludeParams(String includeParams)
     The includeParams attribute may have the value 'none', 'get' or 'all'.
public  voidsetMethod(String method)
    
public  voidsetNamespace(String namespace)
    
public  voidsetPortletMode(String portletMode)
    
public  voidsetPortletUrlType(String portletUrlType)
    
public  voidsetScheme(String scheme)
    
public  voidsetValue(String value)
    
public  voidsetWindowState(String windowState)
    
public  booleanstart(Writer writer)
    

Field Detail
ALL
final public static String ALL(Code)



GET
final public static String GET(Code)



NONE
final public static String NONE(Code)
The includeParams attribute may have the value 'none', 'get' or 'all'. It is used when the url tag is used with or without a value attribute. Its value is looked up on the ValueStack If no includeParams is specified then 'get' is used. none - include no parameters in the URL get - include only GET parameters in the URL (default) all - include both GET and POST parameters in the URL



action
protected String action(Code)



anchor
protected String anchor(Code)



encode
protected boolean encode(Code)



escapeAmp
protected boolean escapeAmp(Code)



includeContext
protected boolean includeContext(Code)



includeParams
protected String includeParams(Code)



method
protected String method(Code)



namespace
protected String namespace(Code)



portletMode
protected String portletMode(Code)



portletUrlType
protected String portletUrlType(Code)



scheme
protected String scheme(Code)



value
protected String value(Code)



windowState
protected String windowState(Code)




Constructor Detail
URL
public URL(OgnlValueStack stack, HttpServletRequest req, HttpServletResponse res)(Code)




Method Detail
end
public boolean end(Writer writer, String body)(Code)



mergeRequestParameters
protected void mergeRequestParameters(String value, Map parameters, Map contextParameters)(Code)
Merge request parameters into current parameters. If a parameter is already present, than the request parameter in the current request and value atrribute will not override its value. The priority is as follows:-
  • parameter from the current request (least priority)
  • parameter form the value attribute (more priority)
  • parameter from the param tag (most priority)

Parameters:
  value - the value attribute (url to be generated by this component)
Parameters:
  parameters - component parameters
Parameters:
  contextParameters - request parameters



setAction
public void setAction(String action)(Code)
The action generate url for, if not using value



setAnchor
public void setAnchor(String anchor)(Code)
The anchor for this URL



setEncode
public void setEncode(boolean encode)(Code)
whether to encode parameters



setEscapeAmp
public void setEscapeAmp(boolean escapeAmp)(Code)
Whether to escape ampersand (&) to (&) or not, default to true.



setIncludeContext
public void setIncludeContext(boolean includeContext)(Code)
whether actual context should be included in url



setIncludeParams
public void setIncludeParams(String includeParams)(Code)
The includeParams attribute may have the value 'none', 'get' or 'all'.



setMethod
public void setMethod(String method)(Code)
The method of action to use



setNamespace
public void setNamespace(String namespace)(Code)
The namespace to use



setPortletMode
public void setPortletMode(String portletMode)(Code)
The resulting portlet mode



setPortletUrlType
public void setPortletUrlType(String portletUrlType)(Code)
Specifies if this should be a portlet render or action url



setScheme
public void setScheme(String scheme)(Code)
Set scheme attribute



setValue
public void setValue(String value)(Code)
The target value to use, if not using action



setWindowState
public void setWindowState(String windowState)(Code)
The resulting portlet window state



start
public boolean start(Writer writer)(Code)



Fields inherited from com.opensymphony.webwork.components.Component
final public static String COMPONENT_STACK(Code)(Java Doc)
protected String id(Code)(Java Doc)
protected Map parameters(Code)(Java Doc)
protected OgnlValueStack stack(Code)(Java Doc)

Methods inherited from com.opensymphony.webwork.components.Component
public void addAllParameters(Map params)(Code)(Java Doc)
public void addParameter(String key, Object value)(Code)(Java Doc)
public boolean altSyntax()(Code)(Java Doc)
public void copyParams(Map params)(Code)(Java Doc)
protected String determineActionURL(String action, String namespace, String method, HttpServletRequest req, HttpServletResponse res, Map parameters, String scheme, boolean includeContext, boolean encodeResult, boolean escapeXml)(Code)(Java Doc)
protected String determineNamespace(String namespace, OgnlValueStack stack, HttpServletRequest req)(Code)(Java Doc)
public boolean end(Writer writer, String body)(Code)(Java Doc)
protected boolean end(Writer writer, String body, boolean popComponentStack)(Code)(Java Doc)
protected WebWorkException fieldError(String field, String errorMsg, Exception e)(Code)(Java Doc)
protected Component findAncestor(Class clazz)(Code)(Java Doc)
protected String findString(String expr)(Code)(Java Doc)
protected String findString(String expr, String field, String errorMsg)(Code)(Java Doc)
protected Object findValue(String expr)(Code)(Java Doc)
protected Object findValue(String expr, String field, String errorMsg)(Code)(Java Doc)
protected Object findValue(String expr, Class toType)(Code)(Java Doc)
public Stack getComponentStack()(Code)(Java Doc)
public String getId()(Code)(Java Doc)
public Map getParameters()(Code)(Java Doc)
public OgnlValueStack getStack()(Code)(Java Doc)
protected void popComponentStack()(Code)(Java Doc)
public void setId(String id)(Code)(Java Doc)
public boolean start(Writer writer)(Code)(Java Doc)
protected String toString(Throwable t)(Code)(Java Doc)
public boolean usesBody()(Code)(Java Doc)

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.