NAME

HTML::SearchPage::Param - Container for parameter fields used by HTML::SearchPage

SYNOPSIS

Please refer to HTML::SearchPage::Tutorial for a tutorial on using HTML::SearchPage & HTML::SearchPage::Param.

DESCRIPTION

This module represents parameter fields as used by HTML::SearchPage for building web-based search pages.

USAGE

Please refer to HTML::SearchPage::Tutorial for a tutorial on using HTML::SearchPage & HTML::SearchPage::Param.

QUICK REFERENCE

This module is only a container for information associated with a parameter field. All the parameters listed below have a get/set method.

Group 1 - Parameters required by the constructor

The following parameters are required by the constructor.

Parameter   Description                   Format
---------   -----------                   ------
sql_column  name of SQL column            scalar
            that this field acts on
form_name   name of parameter to be used  scalar
            in the HTML form
param_type  type of parameter             (i)
param_list  list of parameters            arrayref
            (required only for
             drop-down and
             scrolling-list)
Notes:
(i) Parameter type can be one of:
    - text:<length>         : Text field, <length> characters long
    - drop_down             : Drop-down list from which a single parameter
                              can be selected
    - scrolling_list:<size> : Drop-down list from which multiple parameters
                              can be selected

Group 2 - Optional parameters

The following parameters are optional.

Parameter         Description                       Format       Default
---------         -----------                       ------       -------
auto_all          whether to include an "all:All"   0|1          0
                  on the top of param list
auto_null         whether to include an "null:NULL" 0|1          0
                  on the top of param list
case_sensitive    whether the field is
                  case-sensitive                    0|1          0
disabled          whether field is disabled         0|1          0
label             name to display for the           scalar       'Unknown field'
                  field in the HTML form
numerical         numerical field                   0|1          0
operator_default  the default operator to display   scalar       undef
operator_display  whether the operator is           0|1          0
                  displayed or not
operator_list     list of operators allowed         arrayref     "=:equals to"
param_default     the default parameter to display  scalar       undef

Group 3 - Internal methods

The following parameters are set automatically but they can be get/set after object instantiation.

Parameter  Description                  Format
---------  -----------                  ------
rank       display rank of param field  scalar

AUTHOR

Payan Canaran <pcanaran@cpan.org>

BUGS

VERSION

Version 0.05

ACKNOWLEDGEMENTS

COPYRIGHT & LICENSE

Copyright (c) 2005-2007 Cold Spring Harbor Laboratory

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself. See DISCLAIMER.txt for disclaimers of warranty.