|
Siebel Developer's Reference > Siebel Web Engine Tags >
swe:frame, swe:frameset
Rather than using the HTML frame and frameset tags, Siebel Business Applications use the swe:frameset (swe:frameset) and swe:frame (swe:frame) tags. This is so that SWE is aware of the frame names, and can control refresh and the targeting of URLs. SWE frames and framesets can be used in the following situations:
- Container page templates. A container page template is used to create the frame definition document for the application.
Note the following implementation details of the swe:frame and swe:frameset tags in container pages:
- The contents of a frame using the swe:include tag might not be defined, though it is recommended. The contents can be placed directly into the body of the swe:frame tag.
- The contents of the swe:frame
must be complete HTML documents, that is, they must contain the HTML document structure tags like the html, head, and body tags, and so on. This includes the view templates also.
- The contents of the swe:frame tag when the type is "View" must contain only the swe:current-view/ tag.
- View templates. Frames can be used in a View template to create a frame definition document to show the Applets in the View. SWE refreshes these frames only when one or more of the Applets contained in a frame has new data.
NOTE: You can use frames in a View template only if frames are also used in the container page and there is a separate frame in the container page for the View.
Note the following implementation details of frameset definitions in View templates:
- When placing Applets into frames, you need to make sure that at least one swe:applet tag within a frame is mapped to an Applet in the repository. Otherwise, empty frames occur.
- When a swe:frame block contains a swe:applet tag, its type attribute must be set to Applet.
swe:frameset
This tag is analogous to the HTML frameset tag and is used to define the set of frames contained in the document. This tag is rendered by SWE as an HTML frameset tag. The body of this tag can only contain swe:frame tags. Usage
<swe:frameset htmlAttr="xxx"> ... </swe:frameset>
Attribute
htmlAttr. This attribute can be used to specify the attributes for the HTML frameset tag. swe:frame
This tag is used to mark the beginning and end of the contents to be placed into a frame. SWE renders this tag as an HTML frame tag, with its src attribute set to a SWE URL that retrieves the contents of the frame. You must place this tag within the body of the swe:frameset tag. Usage
<swe:frame type="xxx" name="yyy"> .... </swe:frame>
Attributes
Type. The type attribute is used to indicate the nature of the contents of the frame. SWE uses this information to decide when to refresh this frame. SWE currently supports the following values for this attribute.
|
|
Screenbar |
In a container page template, specifies that the frame contains the primary tab bar. |
Viewbar |
In a container page template, specifies that the frame contains the application menus, Visibility picklist, and Search picklist. |
View |
In a container page template, specifies that the frame contains the current view, that is, the content area. |
Page |
In a container page template, specifies that the frame contains a Web page. These frames are not refreshed after initially loading. |
Applet |
In a View template, specifies that the frame contains an applet. |
Content |
Content frames are used to create framesets that contain the view frames. This frame is needed to support the display of multiple views in features such as Search Center. Usually, the Content frame contains a frameset that has one frame in it, which is the View frame. There are other Content frames that contain framesets that have two or more frames, the View frame and frames to show other alternate views like the Search View. |
AltView |
Used to designate subframes to show one or more alternate views in the content frame, such as Search Center, in addition to the one in the View frame. |
Name. This attribute can be used only when the type of the frame is Page. In this case you can use this attribute to optionally specify a name for the frame. For other frame types, SWE generates standard names for the frames. SWE supports nested framesets. In this case the swe:frame tag contains a swe:frameset tag, and the Type attribute of the outer swe:frame tag is set to Page.
|
