HTML::Widgets::SelectLayers

Copyright (c) 2002 Ivan Kohler
All rights reserved.
This program is free software; you can redistribute it and/or modify it under
the same terms as Perl itself.

This module implements an HTML widget with multiple layers.  Only one layer
is visible at any given time, controlled by a <SELECT> box.  For an example
see below.

  perl Makefile.PL
  make
  make test
  make install

This HTML generated by this module uses JavaScript, but nevertheless attempts
to be as cross-browser as possible, testing for features via DOM support rather
than specific browsers or versions.  It has been tested under Mozilla
0.9.8->1.4, Netscape 4.77, IE 5.5, Konqueror 2.2.2->3.1.5, and Opera 5.0.

NAME

HTML::Widgets::SelectLayers - Perl extension for selectable HTML layers

SYNOPSIS

  use HTML::Widgets::SelectLayers;

  use Tie::IxHash;
  tie my %options, 'Tie::IxHash',
    'value'  => 'Select One',
    'value2' => 'Select Two',
  ;

  $widget = new HTML::Widgets::SelectLayers(
    'options'       => \%options,
    'form_name'     => 'dummy',
    'form_actoin'   => 'process.cgi',
    'form_text'     => [ qw( textfield1 textfield2 ) ],
    'form_checkbox' => [ qw( checkbox1 ) ],
    'layer_callback' => sub {
      my $layer = shift;
      my $html = qq!<INPUT TYPE="hidden" NAME="layer" VALUE="$layer">!;
      $html .= $other_stuff;
      $html;
    },
  );

  print '<FORM NAME=dummy>'.
        '<INPUT TYPE="text" NAME="textfield1">'.
        '<INPUT TYPE="text" NAME="textfield2">'.
        '<INPUT TYPE="checkbox" NAME="checkbox1" VALUE="Y">'.
        $widget->html;

DESCRIPTION

This module implements an HTML widget with multiple layers. Only one layer is visible at any given time, controlled by a <SELECT> box. For an example see http://www.420.am/selectlayers/

This HTML generated by this module uses JavaScript, but nevertheless attempts to be as cross-browser as possible, testing for features via DOM support rather than specific browsers or versions. It has been tested under Mozilla 0.9.8, Netscape 4.77, IE 5.5, Konqueror 2.2.2, and Opera 5.0.

FORMS

Not all browsers seem happy with forms that span layers. The generated HTML will have a </FORM> tag before the layers and will generate <FORM> and </FORM> tags for each layer. To facilitate <SUBMIT> buttons located within the layers, you can pass a form name and element names, and the relevant values will be copied to the layer's form. See the form_ options below.

METHODS

new KEY, VALUE, KEY, VALUE...

Options are passed as name/value pairs:

options - Hash reference of layers and labels for the <SELECT>. See the Tie::IxHash manpage to control ordering. In HTML: <OPTION VALUE=``$layer''>$label</OPTION>

layer_callback - subroutine reference to create each layer. The layer name is passed as an option in @_

selected_layer - (optional) initially selected layer

form_name - (optional) Form name to copy values from. If not supplied, no values will be copied.

form_action - Form action

form_text - (optional) Array reference of text (or hidden) form fields to copy from the form_name form.

form_checkbox - (optional) Array reference of checkbox form fields to copy from the form_name form.

fixup_callback - (optional) subroutine reference, returns supplimentary JavaScript for the function described above under FORMS.

#form_select

size - (optional) size of the <SELECT>, default 1.

unique_key - (optional) prepended to all JavaScript function/variable/object names to avoid namespace collisions.

html_beween - (optional) HTML between the <SELECT> and the layers.

html

Returns HTML for the widget.

AUTHOR

Ivan Kohler <ivan-selectlayers@420.am>

COPYRIGHT

BUGS

JavaScript