The base URL for this frame is calculated based on which of the following attributes you specify (you must specify exactly one of them):
Normally, the hyperlink you specify with one of the attributes described in the previous paragraph will be left unchanged (other than URL rewriting if necessary). However, there are two ways you can append one or more dynamically defined query parameters to the hyperlink -- specify a single parameter with the paramId attribute (and its associated attributes to select the value), or specify the name (and optional property) attributes to select a java.util.Map bean that contains one or more parameter ids and corresponding values.
Additionally, you can request that the current transaction control token, if any, be included in the generated hyperlink by setting the transaction attribute to true. You can also request that an anchor ("#xxx") be added to the end of the URL that is created by any of the above mechanisms, by using the anchor attribute.
| Attributes |
| bundle |
The servlet context attributes key for the MessageResources instance to use. If not specified, defaults to the application resources configured for our action servlet. - Since:
- Struts 1.2.5
|
| |
| Required:
false |
| Request-time:
false |
Type:
java.lang.String |
|
| action |
Logical name of a global Action that contains the actual content-relative URI of the destination of this transfer. This hyperlink may be dynamically modified by the inclusion of query parameters, as described in the tag description. You must specify exactly one of the action attribute, the forward attribute, the href attribute, or the page attribute. Additionally, you can specify a module prefix for linking to other modules. |
| |
| Required:
false |
| Request-time:
false |
Type:
java.lang.String |
|
| module |
Prefix name of a Module that contains the action mapping for the Action that is specified by the action attribute. You must specify an action attribute for this to have an effect. Note: Use "" to map to the default module. |
| |
| Required:
false |
| Request-time:
false |
Type:
java.lang.String |
|
| anchor |
Optional anchor tag ("#xxx") to be added to the generated hyperlink. Specify this value without any "#" character. |
| |
| Required:
false |
| Request-time:
false |
Type:
java.lang.String |
|
| forward |
Logical name of a global ActionForward that contains the actual content-relative URI of the destination of this transfer. This hyperlink may be dynamically modified by the inclusion of query parameters, as described in the tag description. You must specify exactly one of the action attribute, the forward attribute, the href attribute, or the page attribute. |
| |
| Required:
false |
| Request-time:
false |
Type:
java.lang.String |
|
| frameborder |
Should a frame border be generated around this frame (1) or not (0)? |
| |
| Required:
false |
| Request-time:
false |
Type:
java.lang.String |
|
| frameName |
Value for the name attribute of the rendered <frame> element. |
| |
| Required:
false |
| Request-time:
false |
Type:
java.lang.String |
|
| href |
The URL to which this hyperlink will transfer control if activated. This hyperlink may be dynamically modified by the inclusion of query parameters, as described in the tag description. You must specify exactly one of the action attribute, the forward attribute, the href attribute, or the page attribute. |
| |
| Required:
false |
| Request-time:
false |
Type:
java.lang.String |
|
| longdesc |
URI of a long description of the frame. This description should supplement the short description provided by the title attribute, and may be particularly useful for non-visual user agents. |
| |
| Required:
false |
| Request-time:
false |
Type:
java.lang.String |
|
| marginheight |
The amount of space (in pixels) to be left between the frame's contents and its top and bottom margins. |
| |
| Required:
false |
| Request-time:
false |
Type:
java.lang.String |
|
| marginwidth |
The amount of space (in pixels) to be left between the frame's contents and its left and right margins. |
| |
| Required:
false |
| Request-time:
false |
Type:
java.lang.String |
|
| name |
The name of a JSP bean that contains a Map representing the query parameters (if property is not specified), or a JSP bean whose property getter is called to return a Map (if property is specified). |
| |
| Required:
false |
| Request-time:
false |
Type:
java.lang.String |
|
| noresize |
Should users be disallowed from resizing the frame? (true, false). |
| |
| Required:
false |
| Request-time:
false |
Type:
java.lang.String |
|
| page |
The module-relative path (beginning with a "/" character) to which this hyperlink will transfer control if activated. This hyperlink may be dynamically modified by the inclusion of query parameters, as described in the tag description. You must specify exactly one of the action attribute, the forward attribute, the href attribute, or the page attribute. |
| |
| Required:
false |
| Request-time:
false |
Type:
java.lang.String |
|
| paramId |
The name of the request parameter that will be dynamically added to the generated hyperlink. The corresponding value is defined by the paramName and (optional) paramProperty attributes, optionally scoped by the paramScope attribute |
| |
| Required:
false |
| Request-time:
false |
Type:
java.lang.String |
|
| paramName |
The name of a JSP bean that is a String containing the value for the request parameter named by paramId (if paramProperty is not specified), or a JSP bean whose property getter is called to return a String (if paramProperty is specified). The JSP bean is constrained to the bean scope specified by the paramScope property, if it is specified. |
| |
| Required:
false |
| Request-time:
false |
Type:
java.lang.String |
|
| paramProperty |
The name of a property of the bean specified by the paramName attribute, whose return value must be a String containing the value of the request parameter (named by the paramId attribute) that will be dynamically added to this hyperlink. |
| |
| Required:
false |
| Request-time:
false |
Type:
java.lang.String |
|
| paramScope |
The scope within which to search for the bean specified by the paramName attribute. If not specified, all scopes are searched. |
| |
| Required:
false |
| Request-time:
false |
Type:
java.lang.String |
|
| property |
The name of a property of the bean specified by the name attribute, whose return value must be a java.util.Map containing the query parameters to be added to the hyperlink. You must specify the name attribute if you specify this attribute. |
| |
| Required:
false |
| Request-time:
false |
Type:
java.lang.String |
|
| scope |
The scope within which to search for the bean specified by the name attribute. If not specified, all scopes are searched. |
| |
| Required:
false |
| Request-time:
false |
Type:
java.lang.String |
|
| scrolling |
Should scroll bars be created unconditionally (yes), never (no), or only when needed (auto)? |
| |
| Required:
false |
| Request-time:
false |
Type:
java.lang.String |
|
| style |
CSS styles to be applied to this element. |
| |
| Required:
false |
| Request-time:
false |
Type:
java.lang.String |
|
| styleClass |
| CSS stylesheet class to be applied to this HTML element (renders a "class" attribute). |
| |
| Required:
false |
| Request-time:
false |
Type:
java.lang.String |
|
| styleId |
| Identifier to be assigned to this HTML element (renders an "id" attribute). |
| |
| Required:
false |
| Request-time:
false |
Type:
java.lang.String |
|
| title |
The advisory title for this element. |
| |
| Required:
false |
| Request-time:
false |
Type:
java.lang.String |
|
| titleKey |
The message resources key for the advisory title for this element. |
| |
| Required:
false |
| Request-time:
false |
Type:
java.lang.String |
|
| transaction |
If set to true, any current transaction control token will be included in the generated hyperlink, so that it will pass an isTokenValid() test in the receiving Action. |
| |
| Required:
false |
| Request-time:
false |
Type:
java.lang.String |
|