Bookshelf Home | Contents | Index | Search | PDF

Siebel Tools Reference > Physical UI Navigation and Templates > Page Templates >

HTML Frames

---

HTML frames are available to use in the application's container page and in View templates.

Frames are used in the container page of the application to provide independent updating and scrolling of each of the three navigation and control areas—toolbars, tab bar, and application menus/View picklist—as well as the content (View) area. This is illustrated in Figure 223.

Figure 223.  HTML Frame

In a View template, applets can be grouped into separate frames, although this is considered a non-standard practice except in cases where independent refresh or independent scrolling is a significant requirement.

Rather than using the HTML <frame> and <frameset> tags, the <swe:frame> and <swe:frameset> tags are used in the Siebel applications so that SWE is aware of the frame names, and can control refresh and the targeting of URLs. These two SWE tags are described as follows:

• <swe:frameset>

  Purpose: 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 the <swe:frame> tags described below.

  Usage: <swe:frameset htmlAttr="xxx"> ... </swe:frameset>

  Attributes:

  • htmlAttr. This attribute can be used to specify the attributes for the HTML <frameset> tag. For example, htmlAttr="rows='89,25,*'" will support a layout in which the frames that belong to the frameset will take up 89 pixels, 29 pixels, and the rest of the window respectively.
• <swe:frame>

  Purpose: 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 will retrieve the contents of the frame. This tag should be placed 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 supports the following values for this attribute.
    • Toolbar. In a container page template, specifies that the frame contains the tool bar.
    • 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 will not be refreshed after initially loading.
    • Applet. In a View template, specifies that the frame contains an applet.
    • Content. Supports multiple views on a page. The Content type frame defines the content area. It will contain a frame of type View that shows the main view. It can also contain one or more frames of type AltView to show alternate views, like the search center.
    • AltView. Used to designate subframes to show one or more alternate views in the content frame, such as the 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 specify a name for the frame. For other frame types, SWE will generate standard names for the frames.

      NOTE:  SWE supports nested framesets. In this case the <swe:frame> tag will contain a <swe:frameset> tag, and the Type attribute of the outer <swe:frame> tag is set to Page.

HTML Frames in Container Page Templates

A container page template is used to create the frame definition document for the application. Note the following implementation details of <swe:frame> and <swe:frameset> tags in container pages:

• You do not have to define the contents of a frame using the <swe:include> tag although it is recommended. The contents can be placed directly into the body of the <swe:frame> tag.
• The contents of the <swe:frame> have to be complete HTML documents, that is, they should contain the HTML document structure tags like <html>, <head>, <body>, and so on. This includes the view templates as well.
• The contents of the <swe:frame> tag when the type is View should contain only the <swe:current-view/> tag.

The following <swe:frameset> definition is from the standard container page, CCPageContainer.swt:

<swe:frameset htmlAttr="rows='60,21,25,*' border='0' frameborder='No'">

<swe:frame type="Page" htmlAttr="marginheight='0' marginwidth='0'noresize scrolling='No'">

<swe:include file="CCFrameBanner.swt"/>

</swe:frame>

<swe:frame type="Screenbar" htmlAttr="marginheight='0' marginwidth='0' noresize scrolling='No'">

<swe:include file="CCFrameScreenbar.swt"/>

</swe:frame>

<swe:frame type="Viewbar" htmlAttr="marginheight='0' marginwidth='0' noresize scrolling='No'">

<swe:include file="CCFrameViewbar.swt"/>

</swe:frame>

<swe:frame type="View" htmlAttr="marginheight='0' marginwidth='0' noresize scrolling='Auto'">

<swe:current-view/>

</swe:frame>

</swe:frameset>

Bookshelf Home | Contents | Index | Search | PDF