HTMLObject::FrameSet(3)

NAME
HTMLObject::FrameSet - Perl extension for HTMLObject.

SYNOPSIS
  use HTMLObject::FrameSet;
  my $frameSet = HTMLObject::FrameSet->new();

  my $innerFrameset = $frameSet->createFrame(src => 'tester2.cgi',
                                   noresize => '', frameborder => 'no',
                                   scrolling => 'auto');
  $innerFrameset .= $frameSet->createFrame(src => 'tester2.cgi');

  # test the new onbeforeunload support.
  $frameSet->onbeforeunload("return 'You are about to leave via onbeforeunload!'");

  $frameSet->outerFrameset(rows => "*,*", content => $innerFrameset);

  $frameSet->display();  # display the frameset document.

DESCRIPTION
The HTMLObject::Frameset Object builds upon the HTMLObject::Normal object to provide the user with a quick and easy way to create Dynamic FrameSets. See the documentation.html file for more info.

By deriving from HTMLObject::Normal, you can now specify javascript to be output in the <head> or <frameset> tag so you have more flexibility when creating framesets. All the same rules apply as when using the HTMLObject::Normal module directly, in regards to the javascript error handler, etc.

Exported FUNCTIONS
  scalar new()
    Creates a new instance of the HTMLObject::Frameset document type.

  void reset()
    Resets the HTMLObject::Frameset document back to the defaults.

  void display(debug => 0)
    This function generates the Frameset Document displaying any cookies,
    This function prints the generated document to standard out which is
    then hopefully being sent to a web server to process.
    If debug = 1, then we just return the string with any necessary
    processing done to it, otherwise we print it out and return it
    untouched.

  void displayError(title => '', message => '', debug => 0)
    Creates a HTML document that displays the user specified error
    message along with the error message generated by the program. The
    user specified title is used also. The program is exited after the
    document is displayed. Uses display() to generate the actual document.

  void outerFrameset(rows => '', cols => '', frameborder => 'yes|no',
                     bordercolor => '', border => '', content => '',
                     class => '', id => '', style => '', title => '')
    This function creates the <frameset>$content</frameset> tags with the
    specified rows and cols. Modifies $frameSet.

    You can specify javascript related attributes to be output for this
    top level frameset by using the interfaces exported by the
    HTMLObject::Normal object, before calling this method.  This way you
    can have onload, onunload, onbeforeunload attributes generated.

  scalar innerFrameset(rows => '', cols => '', frameborder => 'yes|no',
                       bordercolor => '', border => '', content => '',
                       class => '', id => '', style => '', title => '')
    This function creates the string with <frameset>$content</frameset>
    with the specified rows and cols and then returns it to be used as
    the arguments for outerFrameset().

  scalar createFrame(src => '', name => '', marginwidth => '',
                     marginheight => '', scrolling => 'yes|no|auto',
                     noresize => '', bordercolor => '',
                     frameborder => 'yes|no', border => '',
                     class => '', id => '', style => '', title => '')
    This function returns the string of text that would be necessary to
    have the specified frame displayed within the current <frameset>
    context.  If noresize is defined then it is included in the output
    else it is left out. The value does not matter as it is a tag and not
    a name=value item in the <frame> tag.

  scalar createNoframe(content) (scalar value)
    This function returns the string of text that defines a
    <noframes>$content</noframes> sequence that would go within the
    current <frameset> context.

  bool setHTMLInfo(version, dtd, xhtml)
    requires:
    optional: version, dtd, xhtml - 0 or 1
    returns: 0=error, 1=ok
    summary: Validates version and dtd and sets the htmlVersion and
             htmlDTD variables.  If dtd not defined it defaults to
             "frameset".  If version not defined it defaults to "4.01"
             as long as xhtml = 0, but if xhtml = 1 then version
             defaults to "1.0".
             Possible values for version:
               4.0
               4.01
             Possible values for XHTML versions:
               1.0
             Possible values for dtd:
               frameset

AUTHOR
James A. Pattie, htmlobject@pcxperience.com

SEE ALSO
perl(1), HTMLObject::Base(3), HTMLObject::Normal(3), HTMLObject::ReadCookie(3), HTMLObject::Form(3).