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_action'   => 'process.cgi',

    #new code auto-detects form types (radio not yet supported)
    #'form_elements' => [ qw( textfield1 textfield2 checkbox1 radio1 select1 ) ],
    'form_elements' => [ qw( textfield1 textfield2 checkbox1 radio1 select1 ) ],

    #deprecated style still works for now
    #'form_text'     => [ qw( textfield1 textfield2 ) ],
    #'form_checkbox' => [ qw( checkbox1 ) ],
    #'form_radio'    => [ qw( radio1 ) ],
    #'form_select'   => [ qw( select1 ) ],

    'layer_callback' => sub {
      my $layer = shift;
      my $html = qq!<INPUT TYPE="hidden" NAME="layer" VALUE="$layer">!;
      $html .= $other_stuff;
      $html;
    },
  );

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

DESCRIPTION

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

This \s-1HTML\s0 generated by this module uses JavaScript, but nevertheless attempts to be as cross-browser as possible. The 0.05 release drops Navigator 4 compatibility and has been tested under Mozilla Firefox 1.0.6, \s-1MSIE\s0 6.0, Konqueror 3.3.2, and Opera 8.0.2 (2006 note: still working under newer browsers such as \s-1IE7\s0, Firefox 2.0, etc.).

FORMS

My understanding is that forms cannot span <\s-1DIV\s0>s elements. The generated \s-1HTML\s0 will have a </FORM> tag before the layers and will generate <\s-1FORM\s0> and </FORM> tags for each layer. To facilitate <\s-1SUBMIT\s0> 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 \s-1KEY\s0, \s-1VALUE\s0, \s-1KEY\s0, \s-1VALUE\s0...

Options are passed as name/value pairs: options - Hash reference of layers and labels for the <\s-1SELECT\s0>. See

          Tie::IxHash to control ordering.
          In \s-1HTML:\s0 <\s-1OPTION\s0 VALUE=\*(L"$layer\*(R">$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_elements - (optional) Array reference of form fields to copy from the

                form_name form.  Field type is autodetected; currently
                text, hidden, checkbox, and select fields are
                supported.  Radio fields are not yet supported.

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.

form_radio - (optional) Array reference of radio form fields to copy from the

             form_name form.

form_select - (optional) Array reference of select form fields to copy from

             the form_name form.

fixup_callback - (optional) subroutine reference, returns supplimentary

                 JavaScript for the function described above under \s-1FORMS\s0.

size - (optional) size of the <\s-1SELECT\s0>, default 1. unique_key - (optional) prepended to all JavaScript function/variable/object

             names to avoid namespace collisions.

html_beween - (optional) \s-1HTML\s0 between the <\s-1SELECT\s0> and the layers. under_position - (optional) specifies the positioning of any \s-1HTML\s0 appearing after the widget. static, the default, positions subsequent \s-1HTML\s0 underneath the current layer (or immediately under the select box if no layer has yet been selected), reflowing when layers are changed. absolute calculates the size of the largest layer and keeps the subsequent \s-1HTML\s0 in a single position underneath it. Note that absolute works by positioning subsequent \s-1HTML\s0 in a <\s-1DIV\s0>, so you should probably close it yourself with a </DIV> before your </HTML> end tag. absolute is a bit experimental and might have some quirks with truncating the end of the page under \s-1IE\s0; you might have better results by just making all your layers the exact same size at the moment.

html

Returns \s-1HTML\s0 for the widget.

AUTHOR

Ivan Kohler <[email protected]>

COPYRIGHT

Copyright (c) 2002-2005 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.

BUGS

JavaScript

All the different form_* options are unnecessary, could use .type to auto-sense

Could give you a function or something for copying variables out of the layered forms.

RELATED TO HTML::Widgets::SelectLayers…

perl. Tie::IxHash, http://www.xs4all.nl/~ppk/js/dom.html, http://javascript.about.com/library/scripts/blsafeonload.htm