| <!-- | |
| This file is generated during the build by processing Component class annotations. | |
| Please do not edit it directly. | |
| --> | |
| <html> | |
| <head> | |
| <title>url</title> | |
| </head> | |
| <body> | |
| <h1>Tag Name: url</h1> | |
| <h2>Description</h2> | |
| <p> | |
| <!-- START SNIPPET: tagdescription --> | |
| This tag is used to create a URL | |
| <!-- END SNIPPET: tagdescription --> | |
| </p> | |
| <h2>Attributes</h2> | |
| <!-- START SNIPPET: tagattributes --> | |
| <table width="100%"> | |
| <tr> | |
| <th align="left" valign="top"><h4>Name</h4></th> | |
| <th align="left" valign="top"><h4>Required</h4></th> | |
| <th align="left" valign="top"><h4>Default</h4></th> | |
| <th align="left" valign="top"><h4>Evaluated</h4></th> | |
| <th align="left" valign="top"><h4>Type</h4></th> | |
| <th align="left" valign="top"><h4>Description</h4></th> | |
| </tr> | |
| <tr> | |
| <td align="left" valign="top">action</td> | |
| <td align="left" valign="top">false</td> | |
| <td align="left" valign="top"></td> | |
| <td align="left" valign="top">false</td> | |
| <td align="left" valign="top">String</td> | |
| <td align="left" valign="top">The action to generate the URL for, if not using value</td> | |
| </tr> | |
| <tr> | |
| <td align="left" valign="top">anchor</td> | |
| <td align="left" valign="top">false</td> | |
| <td align="left" valign="top"></td> | |
| <td align="left" valign="top">false</td> | |
| <td align="left" valign="top">String</td> | |
| <td align="left" valign="top">The anchor for this URL</td> | |
| </tr> | |
| <tr> | |
| <td align="left" valign="top">encode</td> | |
| <td align="left" valign="top">false</td> | |
| <td align="left" valign="top">true</td> | |
| <td align="left" valign="top">false</td> | |
| <td align="left" valign="top">Boolean</td> | |
| <td align="left" valign="top">Whether to encode parameters</td> | |
| </tr> | |
| <tr> | |
| <td align="left" valign="top">escapeAmp</td> | |
| <td align="left" valign="top">false</td> | |
| <td align="left" valign="top">true</td> | |
| <td align="left" valign="top">false</td> | |
| <td align="left" valign="top">Boolean</td> | |
| <td align="left" valign="top">Specifies whether to escape ampersand (&) to (&amp;) or not</td> | |
| </tr> | |
| <tr> | |
| <td align="left" valign="top">forceAddSchemeHostAndPort</td> | |
| <td align="left" valign="top">false</td> | |
| <td align="left" valign="top">false</td> | |
| <td align="left" valign="top">false</td> | |
| <td align="left" valign="top">Boolean</td> | |
| <td align="left" valign="top">Specifies whether to force the addition of scheme, host and port or not</td> | |
| </tr> | |
| <tr> | |
| <td align="left" valign="top">id</td> | |
| <td align="left" valign="top">false</td> | |
| <td align="left" valign="top"></td> | |
| <td align="left" valign="top">false</td> | |
| <td align="left" valign="top">String</td> | |
| <td align="left" valign="top">id for referencing element. For UI and form tags it will be used as HTML id attribute</td> | |
| </tr> | |
| <tr> | |
| <td align="left" valign="top">includeContext</td> | |
| <td align="left" valign="top">false</td> | |
| <td align="left" valign="top">true</td> | |
| <td align="left" valign="top">false</td> | |
| <td align="left" valign="top">Boolean</td> | |
| <td align="left" valign="top">Whether actual context should be included in URL</td> | |
| </tr> | |
| <tr> | |
| <td align="left" valign="top">includeParams</td> | |
| <td align="left" valign="top">false</td> | |
| <td align="left" valign="top">get</td> | |
| <td align="left" valign="top">false</td> | |
| <td align="left" valign="top">String</td> | |
| <td align="left" valign="top">The includeParams attribute may have the value 'none', 'get' or 'all'</td> | |
| </tr> | |
| <tr> | |
| <td align="left" valign="top">method</td> | |
| <td align="left" valign="top">false</td> | |
| <td align="left" valign="top"></td> | |
| <td align="left" valign="top">false</td> | |
| <td align="left" valign="top">String</td> | |
| <td align="left" valign="top">The method of action to use</td> | |
| </tr> | |
| <tr> | |
| <td align="left" valign="top">namespace</td> | |
| <td align="left" valign="top">false</td> | |
| <td align="left" valign="top"></td> | |
| <td align="left" valign="top">false</td> | |
| <td align="left" valign="top">String</td> | |
| <td align="left" valign="top">The namespace to use</td> | |
| </tr> | |
| <tr> | |
| <td align="left" valign="top">portletMode</td> | |
| <td align="left" valign="top">false</td> | |
| <td align="left" valign="top"></td> | |
| <td align="left" valign="top">false</td> | |
| <td align="left" valign="top">String</td> | |
| <td align="left" valign="top">The resulting portlet mode</td> | |
| </tr> | |
| <tr> | |
| <td align="left" valign="top">portletUrlType</td> | |
| <td align="left" valign="top">false</td> | |
| <td align="left" valign="top"></td> | |
| <td align="left" valign="top">false</td> | |
| <td align="left" valign="top">String</td> | |
| <td align="left" valign="top">Specifies if this should be a portlet render or action URL. Default is "render". To create an action URL, use "action".</td> | |
| </tr> | |
| <tr> | |
| <td align="left" valign="top">scheme</td> | |
| <td align="left" valign="top">false</td> | |
| <td align="left" valign="top"></td> | |
| <td align="left" valign="top">false</td> | |
| <td align="left" valign="top">String</td> | |
| <td align="left" valign="top">Set scheme attribute</td> | |
| </tr> | |
| <tr> | |
| <td align="left" valign="top">value</td> | |
| <td align="left" valign="top">false</td> | |
| <td align="left" valign="top"></td> | |
| <td align="left" valign="top">false</td> | |
| <td align="left" valign="top">String</td> | |
| <td align="left" valign="top">The target value to use, if not using action</td> | |
| </tr> | |
| <tr> | |
| <td align="left" valign="top">windowState</td> | |
| <td align="left" valign="top">false</td> | |
| <td align="left" valign="top"></td> | |
| <td align="left" valign="top">false</td> | |
| <td align="left" valign="top">String</td> | |
| <td align="left" valign="top">The resulting portlet window state</td> | |
| </tr> | |
| </table> | |
| <!-- END SNIPPET: tagattributes --> | |
| </body> | |
| </html> | |