html
Tag frame


Render an HTML frame element

Renders an HTML <frame> element with processing for the src attribute that is identical to that performed by the <html:link> tag for the href attribute. URL rewriting will be applied automatically, to maintain session state in the absence of cookies.

The base URL for this frame correspond to the href attribute passed.

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 property attribute to select a SourceBean List that contains one or more elements with the name and value attributes. These elements will be used to create the query string.

To specify a single parameter, use the paramId attribute to define the name of the request parameter to be submitted. To specify the corresponding value, specify the paramName attribute - The named property on service context (optionally scoped by the value of the paramScope attribute) must identify a value that can be converted to a String.

If you prefer to specify a SourceBean list that contains all of the request parameters to be added to the hyperlink, specify only the name attribute - The named service context data (optionally scoped by the value of the scope attribute) must identify a SourceBean list containing the parameters.

As the SourceBean list is processed, every element is assumed to be formed by the name and value attributes; these respective values are used as query parameters to be appended to the hyperlink. The value associated with each SourceBean must be either a String or an object whose toString() method will be called.

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 the href is calculated based on the alias and aliasRelated parameters. 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.



Tag Information
Tag Classit.eng.spago.taglib.html.FrameTag
TagExtraInfo ClassNone
Body ContentJSP
Display NameNone

Attributes
NameRequiredRequest-timeTypeDescription
aliasfalsetruejava.lang.StringName of the alias to be used instead of the href attribute.
aliasRelatedfalsetruejava.lang.StringString to be appended to the alias attribute if present.
bundlefalsetruejava.lang.StringThe 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
anchorfalsetruejava.lang.String

Optional anchor tag ("#xxx") to be added to the generated hyperlink. Specify this value without any "#" character.

frameborderfalsetruejava.lang.String

Should a frame border be generated around this frame (1) or not (0)?

frameNamefalsetruejava.lang.String

Value for the name attribute of the rendered <frame> element.

hreffalsetruejava.lang.String

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 href attribute, or the alias attribute.

longdescfalsetruejava.lang.String

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.

marginheightfalsetruejava.lang.Integer

The amount of space (in pixels) to be left between the frame's contents and its top and bottom margins.

marginwidthfalsetruejava.lang.Integer

The amount of space (in pixels) to be left between the frame's contents and its left and right margins.

noresizefalsetrueboolean

Should users be disallowed from resizing the frame? (true, false).

paramIdfalsetruejava.lang.String

The name of the request parameter that will be dynamically added to the generated hyperlink. The corresponding value is defined by the paramName, optionally scoped by the paramScope attribute

paramNamefalsetruejava.lang.String

The name of the service context data that is a String containing the value for the request parameter named by paramId. The service context data is constrained to the bean scope specified by the paramScope property, if it is specified.

paramScopefalsetruejava.lang.String

The scope within which to search for the bean specified by the paramName attribute. If not specified, all scopes are searched.

propertyfalsetruejava.lang.String

The name of a SourceBean list, containing the query parameters to be added to the hyperlink. The list must be formed of SourceBean with a name and value attributes.

scopefalsetruejava.lang.String

The scope within which to search for the data specified by the property attribute. If not specified, all scopes are searched.

scrollingfalsetruejava.lang.String

Should scroll bars be created unconditionally (yes), never (no), or only when needed (auto)?

stylefalsetruejava.lang.String

CSS styles to be applied to this element.

styleClassfalsetruejava.lang.StringCSS stylesheet class to be applied to this HTML element (renders a "class" attribute).
styleIdfalsetruejava.lang.StringIdentifier to be assigned to this HTML element (renders an "id" attribute).
titlefalsetruejava.lang.String

The advisory title for this element.

titleKeyfalsetruejava.lang.String

The message resources key for the advisory title for this element.

transactionfalsetrueboolean

If set to true, any current transaction control token will be included in the generated hyperlink.


Variables
No Variables Defined.


Output Generated by Tag Library Documentation Generator. Java, JSP, and JavaServer Pages are trademarks or registered trademarks of Sun Microsystems, Inc. in the US and other countries. Copyright 2002-4 Sun Microsystems, Inc. 4150 Network Circle Santa Clara, CA 95054, U.S.A. All Rights Reserved.