April 5, 2000 - Forcing Frames | WebReference

April 5, 2000 - Forcing Frames

Yehuda Shiran April 5, 2000
Forcing Frames
Tips: April 2000

Yehuda Shiran, Ph.D.
Doc JavaScript

If your Web site is based on frames, and you don't want the user to be able to load an inner page in a full window, you can rebuild the frame-setting document when the user attempts to load such a page. First, take a look at the following HTML document:

<HTML>
<HEAD>
<TITLE>Canvas</TITLE>
</HEAD>
<FRAMESET COLS="200, *">
   <FRAME SRC="frame1.html" NAME="leftcolumn">
   <FRAMESET ROWS="100, *">
      <FRAME SRC="frame2.html"  NAME="toprow">
      <FRAME SRC="frame3.html" NAME="bottomrow">
   </FRAMESET>
</FRAMESET>
</HTML>

This document is named canvas.html. The upper and left frames are used for navigation purposes, while the main frame displays the actual content of the site. canvas.html initially loads frame3.html as the content page, but other documents can be loaded in that frame as well. Let's assume the user loads a document named frame4.html in the main frame. Everything looks great. We now have a frame-setting document named canvas.html, and three child frames named frame1.html, frame2.html, and frame4.html.

But what happens if the user attempts to load frame4.html in a separate window? We need to force the frames. First, we'll add a simple script to the HEAD portion of each one of the inner documents (frame1.html, frame2.html, frame3.html, and frame4.html).

<SCRIPT LANGUAGE="JavaScript">
<!--
if (top.location.href.indexOf("canvas.html") == -1)
  top.location.href = "canvas.html?pageURL&frameNum";
// -->
</SCRIPT>

frameNum needs to be replaced with the index of the target frame. Use 0 (the first frame) for frame1.html, 1 (the second frame) for frame2.html, and 2 (the third frame) for frame3.html and frame4.html. For example, in frame4.html the script would be:

<SCRIPT LANGUAGE="JavaScript">
<!--
if (top.location.href.indexOf("canvas.html") == -1)
  top.location.href = "canvas.html?frame4.html&2";
// -->
</SCRIPT>

Now let's see the new version of canvas.html:

<HTML>
<HEAD>
<TITLE>Canvas</TITLE>
<SCRIPT LANGUAGE="JavaScript">
<!--
var ar0 = "frame1.html";
var ar1 = "frame2.html";
var ar2 = "frame3.html";
var str = location.search;
var pos = str.indexOf("&");
if (pos != -1) {
  var num = str.substring(pos + 1, str.length);
  window["ar" + num] = str.substring(1, pos);
}
// -->
</SCRIPT>
</HEAD>
<SCRIPT LANGUAGE="JavaScript">
<!--
document.write(
'<FRAMESET COLS="200, *">',
  '<FRAME SRC="', ar0, '" NAME="leftcolumn">',
  '<FRAMESET ROWS="100, *">',
    '<FRAME SRC="', ar1, '" NAME="toprow">',
    '<FRAME SRC="', ar2, '" NAME="bottomrow">',
  '</FRAMESET>',
'</FRAMESET>'
);
// -->
</SCRIPT>
</HTML>

We start by assigning the three default frames, frame1.html, frame2.html, and frame3.html to three variables, ar0, ar1, and ar3, respectively:

var ar0 = "frame1.html";
var ar1 = "frame2.html";
var ar2 = "frame3.html";

These three files are the the basis of the the frame set. Any subsequent change will be on top of these three initial frames. Then, we extract the location.search string:

var str = location.search;

This string begins after the question mark at the URL. In the example above, we added a string to the canvas.html URL:

  top.location.href = "canvas.html?frame4.html&2";

The string location.search will be equal to frame4.html&2 in this case. In order to find the frame number at the end of this string, we use the String's indexOf() method to get the &'s position:

var pos = str.indexOf("&");

And we take the substring starting just after the &, and ending at the end of the URL:

  var num = str.substring(pos + 1, str.length);

Now that we know both the frame number and the file name, we can assign the file to the frame:

  window["ar" + num] = str.substring(1, pos);

Learn more about frames in Column 36, JavaScript and Frames, Part I .