1987 lines
51 KiB
Perl
1987 lines
51 KiB
Perl
package WebGUI::HTMLForm;
|
|
|
|
=head1 LEGAL
|
|
|
|
-------------------------------------------------------------------
|
|
WebGUI is Copyright 2001-2002 Plain Black LLC.
|
|
-------------------------------------------------------------------
|
|
Please read the legal notices (docs/legal.txt) and the license
|
|
(docs/license.txt) that came with this distribution before using
|
|
this software.
|
|
-------------------------------------------------------------------
|
|
http://www.plainblack.com info@plainblack.com
|
|
-------------------------------------------------------------------
|
|
|
|
=cut
|
|
|
|
use CGI::Util qw(rearrange);
|
|
use strict qw(vars refs);
|
|
use WebGUI::DateTime;
|
|
use WebGUI::Form;
|
|
use WebGUI::International;
|
|
use WebGUI::Session;
|
|
use WebGUI::SQL;
|
|
|
|
=head1 NAME
|
|
|
|
Package WebGUI::HTMLForm
|
|
|
|
=head1 SYNOPSIS
|
|
|
|
use WebGUI::HTMLForm;
|
|
$f = WebGUI::HTMLForm->new;
|
|
|
|
$f->checkbox("whichOne","Is red your favorite?","red");
|
|
$f->checkList("dayOfWeek",\%days,"Which day?");
|
|
$f->combo("fruit",\%fruit,"Choose a fruit or enter your own.");
|
|
$f->date("endDate","End Date",$endDate);
|
|
$f->email("emailAddress","Email Address");
|
|
$f->fieldType("dataType",\%supportedTypes,"Type of Field");
|
|
$f->file("image","Image to Upload");
|
|
$f->group("groupToPost","Who can post?");
|
|
$f->hidden("wid","55");
|
|
$f->HTMLArea("description","Description");
|
|
$f->integer("size","Size");
|
|
$f->interval("timeToLive","How long should this last?",12,"hours");
|
|
$f->password("identifier","Password");
|
|
$f->phone("cellPhone","Cell Phone");
|
|
$f->radio("whichOne","Is red your favorite?","red");
|
|
$f->radioList("dayOfWeek",\%days,"Which day?");
|
|
$f->raw("text");
|
|
$f->readOnly("34","Page ID");
|
|
$f->selectList("dayOfWeek",\%days,"Which day?");
|
|
$f->submit;
|
|
$f->template("templateId","Page Template");
|
|
$f->text("firstName", "First Name");
|
|
$f->textarea("emailMessage","Email Message");
|
|
$f->url("homepage","Home Page");
|
|
$f->yesNo("happy","Are you happy?");
|
|
$f->zipcode("workZip","Office Zip Code");
|
|
|
|
Alternatively each of these methods can also be called with the
|
|
tag element syntax like this:
|
|
|
|
$f->checkbox(
|
|
-name=>"whichOne",
|
|
-value=>"red",
|
|
-label=>"Is red your favorite?"
|
|
);
|
|
|
|
|
|
$f->print;
|
|
$f->printRowsOnly;
|
|
|
|
=head1 DESCRIPTION
|
|
|
|
Package that makes HTML forms typed data and significantly
|
|
reduces the code needed for properties pages in WebGUI.
|
|
|
|
=head1 METHODS
|
|
|
|
These methods are available from this class:
|
|
|
|
=cut
|
|
|
|
#-------------------------------------------------------------------
|
|
sub _fixQuotes {
|
|
my $value = shift;
|
|
$value =~ s/\"/\"\;/g;
|
|
return $value;
|
|
}
|
|
|
|
#-------------------------------------------------------------------
|
|
sub _subtext {
|
|
my $output;
|
|
if ($_[0] ne "") {
|
|
$output .= '<span class="formSubtext"> '.$_[0].'</span>';
|
|
}
|
|
return $output;
|
|
}
|
|
|
|
#-------------------------------------------------------------------
|
|
sub _tableFormRow {
|
|
unless ($_[0]->{_noTable}) {
|
|
return '<tr><td class="formDescription" valign="top">'.$_[1].'</td><td class="tableData">'.$_[2]."</td></tr>\n";
|
|
} else {
|
|
return $_[2];
|
|
}
|
|
}
|
|
|
|
#-------------------------------------------------------------------
|
|
sub _uiLevelChecksOut {
|
|
if ($_[0] <= $session{user}{uiLevel}) {
|
|
return 1;
|
|
} else {
|
|
return 0;
|
|
}
|
|
}
|
|
|
|
#-------------------------------------------------------------------
|
|
|
|
=head2 checkbox ( name [ label, checked, subtext, value, extras, uiLevel ] )
|
|
|
|
Adds a checkbox row to this form.
|
|
|
|
=item name
|
|
|
|
The name field for this form element.
|
|
|
|
=item label
|
|
|
|
The left column label for this form row.
|
|
|
|
=item checked
|
|
|
|
If you'd like this box to be defaultly checked, set this to "1".
|
|
|
|
=item subtext
|
|
|
|
Extra text to describe this form element or to provide special
|
|
instructions.
|
|
|
|
=item value
|
|
|
|
The default value for this form element. Defaults to "1".
|
|
|
|
=item extras
|
|
|
|
If you want to add anything special to this form element like
|
|
javascript actions, or stylesheet information, you'd add it in
|
|
here as follows:
|
|
|
|
'onChange="this.form.submit()"'
|
|
|
|
=item uiLevel
|
|
|
|
The UI level for this field. See the WebGUI developer's site for
|
|
details. Defaults to "0".
|
|
|
|
=cut
|
|
|
|
sub checkbox {
|
|
my ($output);
|
|
my ($self, @p) = @_;
|
|
my ($name, $label, $checked, $subtext, $value, $extras, $uiLevel) =
|
|
rearrange([name, label, checked, subtext, value, extras, uiLevel], @p);
|
|
if (_uiLevelChecksOut($uiLevel)) {
|
|
$output = WebGUI::Form::checkbox({
|
|
name=>$name,
|
|
value=>$value,
|
|
checked=>$checked,
|
|
extras=>$extras
|
|
});
|
|
$output .= _subtext($subtext);
|
|
$output = $self->_tableFormRow($label,$output);
|
|
} else {
|
|
if ($checked) {
|
|
$output = WebGUI::Form::hidden({
|
|
name=>$name,
|
|
value=>$value
|
|
});
|
|
}
|
|
}
|
|
$self->{_data} .= $output;
|
|
}
|
|
|
|
#-------------------------------------------------------------------
|
|
|
|
=head2 checkList ( name, options [ label, value, vertical, extras, subtext, uiLevel ] )
|
|
|
|
Adds a checkbox list row to this form.
|
|
|
|
=item name
|
|
|
|
The name field for this form element.
|
|
|
|
=item options
|
|
The list of options for this list. Should be passed as a
|
|
hash reference.
|
|
|
|
=item label
|
|
|
|
The left column label for this form row.
|
|
|
|
=item value
|
|
|
|
The default value(s) for this form element. This should be passed
|
|
as an array reference.
|
|
|
|
=item vertical
|
|
|
|
If set to "1" the radio button elements will be laid out
|
|
horizontally. Defaults to "0".
|
|
|
|
=item extras
|
|
|
|
If you want to add anything special to this form element like
|
|
javascript actions, or stylesheet information, you'd add it in
|
|
here as follows:
|
|
|
|
'onChange="this.form.submit()"'
|
|
|
|
=item subtext
|
|
|
|
Extra text to describe this form element or to provide special
|
|
instructions.
|
|
|
|
=item uiLevel
|
|
|
|
The UI level for this field. See the WebGUI developer's site for
|
|
details. Defaults to "0".
|
|
|
|
=cut
|
|
|
|
sub checkList {
|
|
my ($output);
|
|
my ($self, @p) = @_;
|
|
my ($name, $options, $label, $value, $vertical, $extras, $subtext, $uiLevel) =
|
|
rearrange([name, options, label, value, vertical, extras, subtext, uiLevel], @p);
|
|
if (_uiLevelChecksOut($uiLevel)) {
|
|
$output = WebGUI::Form::checkList({
|
|
name=>$name,
|
|
options=>$options,
|
|
value=>$value,
|
|
vertical=>$vertical,
|
|
extras=>$extras
|
|
});
|
|
$output .= _subtext($subtext);
|
|
$output = $self->_tableFormRow($label,$output);
|
|
} else {
|
|
$output = WebGUI::Form::hiddenList({
|
|
name=>$name,
|
|
options=>$options,
|
|
value=>$value
|
|
});
|
|
}
|
|
$self->{_data} .= $output;
|
|
}
|
|
|
|
#-------------------------------------------------------------------
|
|
|
|
=head2 combo ( name, options [ label, value, size, multiple, extras, subtext, uiLevel ] )
|
|
|
|
Adds a combination select list / text box row to this form. If the
|
|
text box is filled out it will have a value stored in "name"_new
|
|
where name is the first field passed into this method.
|
|
|
|
=item name
|
|
|
|
The name field for this form element.
|
|
|
|
=item options
|
|
The list of options for this select list. Should be passed as a
|
|
hash reference.
|
|
|
|
=item label
|
|
|
|
The left column label for this form row.
|
|
|
|
=item value
|
|
|
|
The default value(s) for this form element. This should be passed
|
|
as an array reference.
|
|
|
|
=item size
|
|
|
|
The number of characters tall this form element should be. Defaults
|
|
to "1".
|
|
|
|
=item multiple
|
|
|
|
A boolean value for whether this select list should allow multiple
|
|
selections. Defaults to "0".
|
|
|
|
=item extras
|
|
|
|
If you want to add anything special to this form element like
|
|
javascript actions, or stylesheet information, you'd add it in
|
|
here as follows:
|
|
|
|
'onChange="this.form.submit()"'
|
|
|
|
=item subtext
|
|
|
|
Extra text to describe this form element or to provide special
|
|
instructions.
|
|
|
|
=item uiLevel
|
|
|
|
The UI level for this field. See the WebGUI developer's site for
|
|
details. Defaults to "0".
|
|
|
|
=cut
|
|
|
|
sub combo {
|
|
my ($output);
|
|
my ($self, @p) = @_;
|
|
my ($name, $options, $label, $value, $size, $multiple, $extras, $subtext, $uiLevel) =
|
|
rearrange([name, options, label, value, size, multiple, extras, subtext, uiLevel], @p);
|
|
if (_uiLevelChecksOut($uiLevel)) {
|
|
$output = WebGUI::Form::combo({
|
|
name=>$name,
|
|
options=>$options,
|
|
value=>$value,
|
|
size=>$size,
|
|
multiple=>$multiple,
|
|
extras=>$extras
|
|
});
|
|
$output .= _subtext($subtext);
|
|
$output = $self->_tableFormRow($label,$output);
|
|
} else {
|
|
$output = WebGUI::Form::hiddenList({
|
|
name=>$name,
|
|
options=>$options,
|
|
value=>$value
|
|
});
|
|
}
|
|
$self->{_data} .= $output;
|
|
}
|
|
|
|
#-------------------------------------------------------------------
|
|
|
|
=head2 date ( name [ label, value, extras, subtext, size, noDate, uiLevel ] )
|
|
|
|
Adds a date row to this form.
|
|
|
|
=item name
|
|
|
|
The name field for this form element.
|
|
|
|
=item label
|
|
|
|
The left column label for this form row.
|
|
|
|
=item value
|
|
|
|
The default date. Pass as an epoch value. Defaults to today.
|
|
|
|
=item extras
|
|
|
|
If you want to add anything special to this form element like
|
|
javascript actions, or stylesheet information, you'd add it in
|
|
here as follows:
|
|
|
|
'onChange="this.form.submit()"'
|
|
|
|
=item subtext
|
|
|
|
Extra text to describe this form element or to provide special
|
|
instructions.
|
|
|
|
=item size
|
|
|
|
The number of characters wide this form element should be. There
|
|
should be no reason for anyone to specify this.
|
|
|
|
=item noDate
|
|
|
|
By default a date is placed in the "value" field. Set this to "1"
|
|
to turn off the default date.
|
|
|
|
=item uiLevel
|
|
|
|
The UI level for this field. See the WebGUI developer's site for
|
|
details. Defaults to "0".
|
|
|
|
=cut
|
|
|
|
sub date {
|
|
my ($output);
|
|
my ($self, @p) = @_;
|
|
my ($name, $label, $value, $extras, $subtext, $size, $noDate, $uiLevel) =
|
|
rearrange([name, label, value, extras, subtext, size, noDate, uiLevel], @p);
|
|
if (_uiLevelChecksOut($uiLevel)) {
|
|
$output = WebGUI::Form::date({
|
|
name=>$name,
|
|
value=>$value,
|
|
noDate=>$noDate,
|
|
size=>$size,
|
|
extras=>$extras
|
|
});
|
|
$output .= _subtext($subtext);
|
|
$output = $self->_tableFormRow($label,$output);
|
|
} else {
|
|
$output = WebGUI::Form::hidden({
|
|
name=>$name,
|
|
value=>epochToSet($value)
|
|
});
|
|
}
|
|
$self->{_data} .= $output;
|
|
}
|
|
|
|
|
|
|
|
#-------------------------------------------------------------------
|
|
|
|
=head2 email ( name [ label, value, maxlength, extras, subtext, size, uiLevel ] )
|
|
|
|
Adds an email address row to this form.
|
|
|
|
=item name
|
|
|
|
The name field for this form element.
|
|
|
|
=item label
|
|
|
|
The left column label for this form row.
|
|
|
|
=item value
|
|
|
|
The default value for this form element.
|
|
|
|
=item maxlength
|
|
|
|
The maximum number of characters to allow in this form element.
|
|
|
|
=item extras
|
|
|
|
If you want to add anything special to this form element like
|
|
javascript actions, or stylesheet information, you'd add it in
|
|
here as follows:
|
|
|
|
'onChange="this.form.submit()"'
|
|
|
|
=item subtext
|
|
|
|
Extra text to describe this form element or to provide special
|
|
instructions.
|
|
|
|
=item size
|
|
|
|
The number of characters wide this form element should be. There
|
|
should be no reason for anyone to specify this.
|
|
|
|
=item uiLevel
|
|
|
|
The UI level for this field. See the WebGUI developer's site for
|
|
details. Defaults to "0".
|
|
|
|
=cut
|
|
|
|
sub email {
|
|
my ($output);
|
|
my ($self, @p) = @_;
|
|
my ($name, $label, $value, $maxlength, $extras, $subtext, $size, $uiLevel) =
|
|
rearrange([name, label, value, maxlength, extras, subtext, size, uiLevel], @p);
|
|
if (_uiLevelChecksOut($uiLevel)) {
|
|
$output = WebGUI::Form::email({
|
|
name=>$name,
|
|
value=>$value,
|
|
maxlength=>$maxlength,
|
|
size=>$size,
|
|
extras=>$extras
|
|
});
|
|
$output .= _subtext($subtext);
|
|
$output = $self->_tableFormRow($label,$output);
|
|
} else {
|
|
$output = WebGUI::Form::hidden({
|
|
name=>$name,
|
|
value=>$value
|
|
});
|
|
}
|
|
$self->{_data} .= $output;
|
|
}
|
|
|
|
|
|
#-------------------------------------------------------------------
|
|
|
|
=head2 fieldType ( name, types [ label, value, size, multiple, extras, subtext, uiLevel ] )
|
|
|
|
Adds a field type select list field to this form. This is primarily
|
|
useful for building dynamic form builders.
|
|
|
|
=item name
|
|
|
|
The name field for this form element.
|
|
|
|
=item types
|
|
|
|
An array reference of field types to be displayed. The field names
|
|
are the names of the methods from this forms package. Note that not
|
|
all field types are supported.
|
|
|
|
=item label
|
|
|
|
The left column label for this form row.
|
|
|
|
=item value
|
|
|
|
The default value(s) for this form element. This should be passed
|
|
as an array reference.
|
|
|
|
=item size
|
|
|
|
The number of characters tall this form element should be. Defaults
|
|
to "1".
|
|
|
|
=item multiple
|
|
|
|
A boolean value for whether this select list should allow multiple
|
|
selections. Defaults to "0".
|
|
|
|
=item extras
|
|
|
|
If you want to add anything special to this form element like
|
|
javascript actions, or stylesheet information, you'd add it in
|
|
here as follows:
|
|
|
|
'onChange="this.form.submit()"'
|
|
|
|
=item subtext
|
|
|
|
Extra text to describe this form element or to provide special
|
|
instructions.
|
|
|
|
=item uiLevel
|
|
|
|
The UI level for this field. See the WebGUI developer's site for
|
|
details. Defaults to "0".
|
|
|
|
=cut
|
|
|
|
sub fieldType {
|
|
my ($output);
|
|
my ($self, @p) = @_;
|
|
my ($name, $types, $label, $value, $size, $multiple, $extras, $subtext, $uiLevel) =
|
|
rearrange([name, types, label, value, size, multiple, extras, subtext, uiLevel], @p);
|
|
if (_uiLevelChecksOut($uiLevel)) {
|
|
$output = WebGUI::Form::fieldTypes({
|
|
name=>$name,
|
|
types=>$types,
|
|
value=>$value,
|
|
multiple=>$multiple,
|
|
size=>$size,
|
|
extras=>$extras
|
|
});
|
|
$output .= _subtext($subtext);
|
|
$output = $self->_tableFormRow($label,$output);
|
|
} else {
|
|
$output = WebGUI::Form::hiddenList({
|
|
name=>$name,
|
|
types=>$types,
|
|
value=>$value
|
|
});
|
|
}
|
|
$self->{_data} .= $output;
|
|
}
|
|
|
|
#-------------------------------------------------------------------
|
|
|
|
=head2 file ( name [ label, subtext, extras, size, uiLevel ] )
|
|
|
|
Adds a file browse row to this form.
|
|
|
|
=item name
|
|
|
|
The name field for this form element.
|
|
|
|
=item label
|
|
|
|
The left column label for this form row.
|
|
|
|
=item subtext
|
|
|
|
Extra text to describe this form element or to provide special
|
|
instructions.
|
|
|
|
=item extras
|
|
|
|
If you want to add anything special to this form element like
|
|
javascript actions, or stylesheet information, you'd add it in
|
|
here as follows:
|
|
|
|
'onChange="this.form.submit()"'
|
|
|
|
=item size
|
|
|
|
The number of characters wide this form element should be. There
|
|
should be no reason for anyone to specify this.
|
|
|
|
=item uiLevel
|
|
|
|
The UI level for this field. See the WebGUI developer's site for
|
|
details. Defaults to "0".
|
|
|
|
=cut
|
|
|
|
sub file {
|
|
my ($output);
|
|
my ($self, @p) = @_;
|
|
my ($name, $label, $subtext, $extras, $size, $uiLevel) =
|
|
rearrange([name, label, subtext, extras, size, uiLevel], @p);
|
|
if (_uiLevelChecksOut($uiLevel)) {
|
|
$output = WebGUI::Form::file({
|
|
name=>$name,
|
|
size=>$size,
|
|
extras=>$extras
|
|
});
|
|
$output .= _subtext($subtext);
|
|
$output = $self->_tableFormRow($label,$output);
|
|
}
|
|
$self->{_data} .= $output;
|
|
}
|
|
|
|
#-------------------------------------------------------------------
|
|
|
|
=head2 group ( name [ label, value, size, multiple, extras, subtext, uiLevel ] )
|
|
|
|
Adds a group pull-down to this form. A group pull down
|
|
provides a select list that provides name value pairs for all the
|
|
groups in the WebGUI system.
|
|
|
|
=item name
|
|
|
|
The name field for this form element.
|
|
|
|
=item label
|
|
|
|
The left column label for this form row.
|
|
|
|
=item value
|
|
|
|
The default value(s) for this form element. This should be passed
|
|
as an array reference. Defaults to "7" (Everyone).
|
|
|
|
=item size
|
|
|
|
How many rows should be displayed at once?
|
|
|
|
=item multiple
|
|
|
|
Set to "1" if multiple groups should be selectable.
|
|
|
|
=item extras
|
|
|
|
If you want to add anything special to this form element like
|
|
javascript actions, or stylesheet information, you'd add it in
|
|
here as follows:
|
|
|
|
'onChange="this.form.submit()"'
|
|
|
|
=item subtext
|
|
|
|
Extra text to describe this form element or to provide special
|
|
instructions.
|
|
|
|
=item uiLevel
|
|
|
|
The UI level for this field. See the WebGUI developer's site for
|
|
details. Defaults to "0".
|
|
|
|
=cut
|
|
|
|
sub group {
|
|
my ($output);
|
|
my ($self, @p) = @_;
|
|
my ($name, $label, $value, $size, $multiple, $extras, $subtext, $uiLevel) =
|
|
rearrange([name, label, value, size, multiple, extras, subtext, uiLevel], @p);
|
|
if (_uiLevelChecksOut($uiLevel)) {
|
|
$output = WebGUI::Form::group({
|
|
name=>$name,
|
|
size=>$size,
|
|
value=>$value,
|
|
multiple=>$multiple,
|
|
extras=>$extras
|
|
});
|
|
$output .= _subtext($subtext);
|
|
$output = $self->_tableFormRow($label,$output);
|
|
} else {
|
|
my $hashRef = WebGUI::SQL->quickHashRef("select groupId,groupName from groups");
|
|
$output = WebGUI::Form::hiddenList({
|
|
name=>$name,
|
|
options=>$hashRef,
|
|
value=>$value
|
|
});
|
|
}
|
|
$self->{_data} .= $output;
|
|
}
|
|
|
|
#-------------------------------------------------------------------
|
|
|
|
=head2 hidden ( name [ value ] )
|
|
|
|
Adds a hidden row to this form.
|
|
|
|
=item name
|
|
|
|
The name field for this form element.
|
|
|
|
=item value
|
|
|
|
The default value for this form element.
|
|
|
|
=cut
|
|
|
|
sub hidden {
|
|
my ($self, @p) = @_;
|
|
my ($name, $value) = rearrange([name, value], @p);
|
|
$self->{_data} .= WebGUI::Form::hidden({
|
|
name=>$name,
|
|
value=>$value
|
|
});
|
|
}
|
|
|
|
#-------------------------------------------------------------------
|
|
|
|
=head2 HTMLArea ( name [ label, value, subtext, extras, wrap, rows, columns, uiLevel ] )
|
|
|
|
Adds an HTML area row to this form. An HTML area is different than
|
|
a standard text area in that it provides rich edit functionality
|
|
and some special error trapping for HTML and other special
|
|
characters.
|
|
|
|
=item name
|
|
|
|
The name field for this form element.
|
|
|
|
=item label
|
|
|
|
The left column label for this form row.
|
|
|
|
=item value
|
|
|
|
The default value for this form element.
|
|
|
|
=item subtext
|
|
|
|
Extra text to describe this form element or to provide special
|
|
instructions.
|
|
|
|
=item extras
|
|
|
|
If you want to add anything special to this form element like
|
|
javascript actions, or stylesheet information, you'd add it in
|
|
here as follows:
|
|
|
|
'onChange="this.form.submit()"'
|
|
|
|
=item wrap
|
|
|
|
The method for wrapping text in the text area. Defaults to
|
|
"virtual". There should be almost no reason to specify this.
|
|
|
|
=item rows
|
|
|
|
The number of characters tall this form element should be. There
|
|
should be no reason for anyone to specify this.
|
|
|
|
=item columns
|
|
|
|
The number of characters wide this form element should be. There
|
|
should be no reason for anyone to specify this.
|
|
|
|
=item uiLevel
|
|
|
|
The UI level for this field. See the WebGUI developer's site for
|
|
details. Defaults to "0".
|
|
|
|
=cut
|
|
|
|
sub HTMLArea {
|
|
my ($output);
|
|
my ($self, @p) = @_;
|
|
my ($name, $label, $value, $subtext, $extras, $wrap, $rows, $columns, $uiLevel) =
|
|
rearrange([name, label, value, subtext, extras, wrap, rows, columns, uiLevel], @p);
|
|
if (_uiLevelChecksOut($uiLevel)) {
|
|
$output = WebGUI::Form::HTMLArea({
|
|
name=>$name,
|
|
value=>$value,
|
|
wrap=>$wrap,
|
|
columns=>$columns,
|
|
rows=>$rows,
|
|
extras=>$extras
|
|
});
|
|
$output .= _subtext($subtext);
|
|
$output = $self->_tableFormRow($label,$output);
|
|
} else {
|
|
$output = WebGUI::Form::hidden({
|
|
name=>$name,
|
|
value=>$value
|
|
});
|
|
}
|
|
$self->{_data} .= $output;
|
|
}
|
|
|
|
#-------------------------------------------------------------------
|
|
|
|
=head2 integer ( name [ label, value, maxlength, extras, subtext, size, uiLevel ] )
|
|
|
|
Adds an integer row to this form.
|
|
|
|
=item name
|
|
|
|
The name field for this form element.
|
|
|
|
=item label
|
|
|
|
The left column label for this form row.
|
|
|
|
=item value
|
|
|
|
The default value for this form element.
|
|
|
|
=item maxlength
|
|
|
|
The maximum number of characters to allow in this form element.
|
|
Defaults to 11.
|
|
|
|
=item extras
|
|
|
|
If you want to add anything special to this form element like
|
|
javascript actions, or stylesheet information, you'd add it in
|
|
here as follows:
|
|
|
|
'onChange="this.form.submit()"'
|
|
|
|
=item subtext
|
|
|
|
Extra text to describe this form element or to provide special
|
|
instructions.
|
|
|
|
=item size
|
|
|
|
The number of characters wide this form element should be. There
|
|
should be no reason for anyone to specify this.
|
|
|
|
=item uiLevel
|
|
|
|
The UI level for this field. See the WebGUI developer's site for
|
|
details. Defaults to "0".
|
|
|
|
=cut
|
|
|
|
sub integer {
|
|
my ($output);
|
|
my ($self, @p) = @_;
|
|
my ($name, $label, $value, $maxlength, $extras, $subtext, $size, $uiLevel) =
|
|
rearrange([name, label, value, maxlength, extras, subtext, size, uiLevel], @p);
|
|
if (_uiLevelChecksOut($uiLevel)) {
|
|
$output = WebGUI::Form::integer({
|
|
name=>$name,
|
|
value=>$value,
|
|
maxlength=>$maxlength,
|
|
size=>$size,
|
|
extras=>$extras
|
|
});
|
|
$output .= _subtext($subtext);
|
|
$output = $self->_tableFormRow($label,$output);
|
|
} else {
|
|
$output = WebGUI::Form::hidden({
|
|
name=>$name,
|
|
value=>$value
|
|
});
|
|
}
|
|
$self->{_data} .= $output;
|
|
}
|
|
|
|
#-------------------------------------------------------------------
|
|
|
|
=head2 interval ( name [ label, intervalValue, unitsValue, extras, subtext, uiLevel ] )
|
|
|
|
Adds a time interval row to this form.
|
|
|
|
=item name
|
|
|
|
The the base name for this form element. This form element actually
|
|
returns two values under different names. They are name_interval and
|
|
name_units.
|
|
|
|
=item label
|
|
|
|
The left column label for this form row.
|
|
|
|
=item intervalValue
|
|
|
|
The default value for interval portion of this form element. Defaults
|
|
to '1'.
|
|
|
|
=item unitsValue
|
|
|
|
The default value for units portion of this form element. Defaults
|
|
to 'seconds'. Possible values are 'seconds', 'minutes', 'hours',
|
|
'days', 'weeks', 'months', and 'years'.
|
|
|
|
=item extras
|
|
|
|
If you want to add anything special to this form element like
|
|
javascript actions, or stylesheet information, you'd add it in
|
|
here as follows:
|
|
|
|
'onChange="this.form.submit()"'
|
|
|
|
=item subtext
|
|
|
|
Extra text to describe this form element or to provide special
|
|
instructions.
|
|
|
|
=item uiLevel
|
|
|
|
The UI level for this field. See the WebGUI developer's site for
|
|
details. Defaults to "0".
|
|
|
|
=cut
|
|
|
|
sub interval {
|
|
my ($output);
|
|
my ($self, @p) = @_;
|
|
my ($name, $label, $intervalValue, $unitsValue, $extras, $subtext, $uiLevel) =
|
|
rearrange([name, label, intervalValue, unitsValue, extras, subtext, uiLevel], @p);
|
|
if (_uiLevelChecksOut($uiLevel)) {
|
|
$output = WebGUI::Form::interval({
|
|
name=>$name,
|
|
intervalValue=>$intervalValue,
|
|
unitsValue=>$unitsValue,
|
|
extras=>$extras
|
|
});
|
|
$output .= _subtext($subtext);
|
|
$output = $self->_tableFormRow($label,$output);
|
|
} else {
|
|
$output = WebGUI::Form::hidden({
|
|
name=>$name.'_interval',
|
|
value=>$intervalValue
|
|
});
|
|
$output .= WebGUI::Form::hidden({
|
|
name=>$name.'_units',
|
|
value=>$unitsValue
|
|
});
|
|
}
|
|
$self->{_data} .= $output;
|
|
}
|
|
|
|
|
|
#-------------------------------------------------------------------
|
|
|
|
=head2 new ( [ noTable, action, method, extras, enctype, tableExtras ] )
|
|
|
|
Constructor.
|
|
|
|
=item noTable
|
|
|
|
If this is set to "1" then no table elements will be wrapped around
|
|
each form element. Defaults to "0".
|
|
|
|
=item action
|
|
|
|
The Action URL for the form information to be submitted to. This
|
|
defaults to the current page.
|
|
|
|
=item method
|
|
|
|
The form's submission method. This defaults to "POST" and probably
|
|
shouldn't be changed.
|
|
|
|
=item extras
|
|
|
|
If you want to add anything special to your form like javascript
|
|
actions, or stylesheet information, you'd add it in here as
|
|
follows:
|
|
|
|
'name="myForm" onChange="myForm.submit()"'
|
|
|
|
=item enctype
|
|
|
|
The ecapsulation type for this form. This defaults to
|
|
"multipart/form-data" and should probably never be changed.
|
|
|
|
=item tableExtras
|
|
|
|
If you want to add anything special to the form's table like
|
|
a name or stylesheet information, you'd add it in here as
|
|
follows:
|
|
|
|
'name="myForm" class="formTable"'
|
|
|
|
|
|
=cut
|
|
|
|
sub new {
|
|
my ($noTable, $header, $footer);
|
|
my ($self, @p) = @_;
|
|
my ($noTable, $action, $method, $extras, $enctype, $tableExtras) =
|
|
rearrange([noTable, action, method, extras, enctype, tableExtras], @p);
|
|
$noTable = $noTable || 0;
|
|
$header = "\n\n".WebGUI::Form::formHeader({
|
|
action=>$action,
|
|
extras=>$extras,
|
|
method=>$method,
|
|
enctype=>$enctype
|
|
});
|
|
$header .= "\n<table ".$tableExtras.'>' unless ($noTable);
|
|
$footer = "</table>\n" unless ($noTable);
|
|
$footer .= "</form>\n\n";
|
|
bless {_noTable => $noTable, _header => $header, _footer => $footer, _data => ''}, $self;
|
|
}
|
|
|
|
#-------------------------------------------------------------------
|
|
|
|
=head2 password ( name [ label, value, subtext, maxlength, extras, size, uiLevel ] )
|
|
|
|
Adds a password row to this form.
|
|
|
|
=item name
|
|
|
|
The name field for this form element.
|
|
|
|
=item label
|
|
|
|
The left column label for this form row.
|
|
|
|
=item value
|
|
|
|
The default value for this form element.
|
|
|
|
=item subtext
|
|
|
|
Extra text to describe this form element or to provide special
|
|
instructions.
|
|
|
|
=item maxlength
|
|
|
|
The maximum number of characters to allow in this form element.
|
|
Defaults to "35".
|
|
|
|
=item extras
|
|
|
|
If you want to add anything special to this form element like
|
|
javascript actions, or stylesheet information, you'd add it in
|
|
here as follows:
|
|
|
|
'onChange="this.form.submit()"'
|
|
|
|
=item size
|
|
|
|
The number of characters wide this form element should be. There
|
|
should be no reason for anyone to specify this. Defaults to "30"
|
|
unless overridden in the settings.
|
|
|
|
=item uiLevel
|
|
|
|
The UI level for this field. See the WebGUI developer's site for
|
|
details. Defaults to "0".
|
|
|
|
=cut
|
|
|
|
sub password {
|
|
my ($output);
|
|
my ($self, @p) = @_;
|
|
my ($name, $label, $value, $subtext, $maxlength, $extras, $size, $uiLevel) =
|
|
rearrange([name, label, value, subtext, maxlength, extras, size, uiLevel], @p);
|
|
if (_uiLevelChecksOut($uiLevel)) {
|
|
$output = WebGUI::Form::password({
|
|
name=>$name,
|
|
value=>$value,
|
|
size=>$size,
|
|
maxlength=>$maxlength,
|
|
extras=>$extras
|
|
});
|
|
$output .= _subtext($subtext);
|
|
$output = $self->_tableFormRow($label,$output);
|
|
} else {
|
|
$output = WebGUI::Form::hidden({
|
|
name=>$name,
|
|
value=>$value
|
|
});
|
|
}
|
|
$self->{_data} .= $output;
|
|
}
|
|
|
|
#-------------------------------------------------------------------
|
|
|
|
=head2 phone ( name [ label, value, maxlength, extras, subtext, size, uiLevel ] )
|
|
|
|
Adds a text row to this form.
|
|
|
|
=item name
|
|
|
|
The name field for this form element.
|
|
|
|
=item label
|
|
|
|
The left column label for this form row.
|
|
|
|
=item value
|
|
|
|
The default value for this form element.
|
|
|
|
=item maxlength
|
|
|
|
The maximum number of characters to allow in this form element.
|
|
|
|
=item extras
|
|
|
|
If you want to add anything special to this form element like
|
|
javascript actions, or stylesheet information, you'd add it in
|
|
here as follows:
|
|
|
|
'onChange="this.form.submit()"'
|
|
|
|
=item subtext
|
|
|
|
Extra text to describe this form element or to provide special
|
|
instructions.
|
|
|
|
=item size
|
|
|
|
The number of characters wide this form element should be. There
|
|
should be no reason for anyone to specify this.
|
|
|
|
=item uiLevel
|
|
|
|
The UI level for this field. See the WebGUI developer's site for
|
|
details. Defaults to "0".
|
|
|
|
=cut
|
|
|
|
sub phone {
|
|
my ($output);
|
|
my ($self, @p) = @_;
|
|
my ($name, $label, $value, $maxlength, $extras, $subtext, $size, $uiLevel) =
|
|
rearrange([name, label, value, maxlength, extras, subtext, size, uiLevel], @p);
|
|
if (_uiLevelChecksOut($uiLevel)) {
|
|
$output = WebGUI::Form::phone({
|
|
name=>$name,
|
|
value=>$value,
|
|
size=>$size,
|
|
maxlength=>$maxlength,
|
|
extras=>$extras
|
|
});
|
|
$output .= _subtext($subtext);
|
|
$output = $self->_tableFormRow($label,$output);
|
|
} else {
|
|
$output = WebGUI::Form::hidden({
|
|
name=>$name,
|
|
value=>$value
|
|
});
|
|
}
|
|
$self->{_data} .= $output;
|
|
}
|
|
|
|
#-------------------------------------------------------------------
|
|
|
|
=head2 print ( )
|
|
|
|
Returns the HTML for this form object.
|
|
|
|
=cut
|
|
|
|
sub print {
|
|
return $_[0]->{_header}.$_[0]->{_data}.$_[0]->{_footer};
|
|
}
|
|
|
|
#-------------------------------------------------------------------
|
|
|
|
=head2 printRowsOnly ( )
|
|
|
|
Returns the HTML for this form object except for the form header
|
|
and footer.
|
|
|
|
=cut
|
|
|
|
sub printRowsOnly {
|
|
return $_[0]->{_data};
|
|
}
|
|
|
|
#-------------------------------------------------------------------
|
|
|
|
=head2 radio ( name [ label, checked, value, subtext, extras, uiLevel ] )
|
|
|
|
Adds a radio button row to this form.
|
|
|
|
=item name
|
|
|
|
The name field for this form element.
|
|
|
|
=item label
|
|
|
|
The left column label for this form row.
|
|
|
|
=item checked
|
|
|
|
If you'd like this radio button to be defaultly checked, set this to "1".
|
|
|
|
=item value
|
|
|
|
The default value for this form element.
|
|
|
|
=item subtext
|
|
|
|
Extra text to describe this form element or to provide special
|
|
instructions.
|
|
|
|
=item extras
|
|
|
|
If you want to add anything special to this form element like
|
|
javascript actions, or stylesheet information, you'd add it in
|
|
here as follows:
|
|
|
|
'onChange="this.form.submit()"'
|
|
|
|
=item uiLevel
|
|
|
|
The UI level for this field. See the WebGUI developer's site for
|
|
details. Defaults to "0".
|
|
|
|
=cut
|
|
|
|
sub radio {
|
|
my ($output);
|
|
my ($self, @p) = @_;
|
|
my ($name, $label, $checked, $value, $subtext, $extras, $uiLevel) =
|
|
rearrange([name, label, checked, value, subtext, extras, uiLevel], @p);
|
|
if (_uiLevelChecksOut($uiLevel)) {
|
|
$output = WebGUI::Form::checkbox({
|
|
name=>$name,
|
|
value=>$value,
|
|
checked=>$checked,
|
|
extras=>$extras
|
|
});
|
|
$output .= _subtext($subtext);
|
|
$output = $self->_tableFormRow($label,$output);
|
|
} else {
|
|
if ($checked) {
|
|
$output = WebGUI::Form::hidden({
|
|
name=>$name,
|
|
value=>$value
|
|
});
|
|
}
|
|
}
|
|
$self->{_data} .= $output;
|
|
}
|
|
|
|
#-------------------------------------------------------------------
|
|
|
|
=head2 radioList ( name, options [ label, value, vertical, extras, subtext, uiLevel ] )
|
|
|
|
Adds a radio button list row to this form.
|
|
|
|
=item name
|
|
|
|
The name field for this form element.
|
|
|
|
=item options
|
|
|
|
The list of options for this list. Should be passed as a
|
|
hash reference.
|
|
|
|
=item label
|
|
|
|
The left column label for this form row.
|
|
|
|
=item value
|
|
|
|
The default value for this form element.
|
|
|
|
=item vertical
|
|
|
|
If set to "1" the radio button elements will be laid out
|
|
horizontally. Defaults to "0".
|
|
|
|
=item extras
|
|
|
|
If you want to add anything special to this form element like
|
|
javascript actions, or stylesheet information, you'd add it in
|
|
here as follows:
|
|
|
|
'onChange="this.form.submit()"'
|
|
|
|
=item subtext
|
|
|
|
Extra text to describe this form element or to provide special
|
|
instructions.
|
|
|
|
=item uiLevel
|
|
|
|
The UI level for this field. See the WebGUI developer's site for
|
|
details. Defaults to "0".
|
|
|
|
=cut
|
|
|
|
sub radioList {
|
|
my ($output);
|
|
my ($self, @p) = @_;
|
|
my ($name, $options, $label, $value, $vertical, $extras, $subtext, $uiLevel) =
|
|
rearrange([name, options, label, value, vertical, extras, subtext, uiLevel], @p);
|
|
if (_uiLevelChecksOut($uiLevel)) {
|
|
$output = WebGUI::Form::checkList({
|
|
name=>$name,
|
|
options=>$options,
|
|
value=>$value,
|
|
vertical=>$vertical,
|
|
extras=>$extras
|
|
});
|
|
$output .= _subtext($subtext);
|
|
$output = $self->_tableFormRow($label,$output);
|
|
} else {
|
|
$output = WebGUI::Form::hiddenList({
|
|
name=>$name,
|
|
options=>$options,
|
|
value=>[$value]
|
|
});
|
|
}
|
|
$self->{_data} .= $output;
|
|
}
|
|
|
|
#-------------------------------------------------------------------
|
|
|
|
=head2 raw ( value, uiLevel )
|
|
|
|
Adds raw data to the form. This is primarily useful with the
|
|
printRowsOnly method and if you generate your own form elements.
|
|
|
|
=item uiLevel
|
|
|
|
The UI level for this field. See the WebGUI developer's site for
|
|
details. Defaults to "0".
|
|
|
|
=cut
|
|
|
|
sub raw {
|
|
my ($output);
|
|
my ($self, @p) = @_;
|
|
my ($value, $uiLevel) = rearrange([value, uiLevel], @p);
|
|
if (_uiLevelChecksOut($uiLevel)) {
|
|
$self->{_data} .= $value;
|
|
}
|
|
$self->{_data} .= $output;
|
|
}
|
|
|
|
#-------------------------------------------------------------------
|
|
|
|
=head2 readOnly ( value [ label, subtext, uiLevel ] )
|
|
|
|
Adds a read only row to this form. This is mainly used for
|
|
displaying not editable properties, but it can also be used to
|
|
quickly insert custom form elements.
|
|
|
|
=item value
|
|
|
|
The read only value.
|
|
|
|
=item label
|
|
|
|
The left column label for this form row.
|
|
|
|
=item subtext
|
|
|
|
Extra text to describe this form element or to provide special
|
|
instructions.
|
|
|
|
=item uiLevel
|
|
|
|
The UI level for this field. See the WebGUI developer's site for
|
|
details. Defaults to "0".
|
|
|
|
=cut
|
|
|
|
sub readOnly {
|
|
my ($output);
|
|
my ($self, @p) = @_;
|
|
my ($value, $label, $subtext, $uiLevel) =
|
|
rearrange([value, label, subtext, uiLevel], @p);
|
|
if (_uiLevelChecksOut($uiLevel)) {
|
|
$output = $value;
|
|
$output .= _subtext($subtext);
|
|
$output = $self->_tableFormRow($label,$output);
|
|
}
|
|
$self->{_data} .= $output;
|
|
}
|
|
|
|
#-------------------------------------------------------------------
|
|
|
|
=head2 select
|
|
|
|
Use of this method is depricated. Use selectList instead.
|
|
|
|
=cut
|
|
|
|
sub select {
|
|
my $self = shift;
|
|
return $self->selectList(@_);
|
|
}
|
|
|
|
#-------------------------------------------------------------------
|
|
|
|
=head2 selectList ( name, options [ label, value, size, multiple, extras, subtext, uiLevel ] )
|
|
|
|
Adds a select list row to this form.
|
|
|
|
=item name
|
|
|
|
The name field for this form element.
|
|
|
|
=item options
|
|
The list of options for this select list. Should be passed as a
|
|
hash reference.
|
|
|
|
=item label
|
|
|
|
The left column label for this form row.
|
|
|
|
=item value
|
|
|
|
The default value(s) for this form element. This should be passed
|
|
as an array reference.
|
|
|
|
=item size
|
|
|
|
The number of characters tall this form element should be. Defaults
|
|
to "1".
|
|
|
|
=item multiple
|
|
|
|
A boolean value for whether this select list should allow multiple
|
|
selections. Defaults to "0".
|
|
|
|
=item extras
|
|
|
|
If you want to add anything special to this form element like
|
|
javascript actions, or stylesheet information, you'd add it in
|
|
here as follows:
|
|
|
|
'onChange="this.form.submit()"'
|
|
|
|
=item subtext
|
|
|
|
Extra text to describe this form element or to provide special
|
|
instructions.
|
|
|
|
=item uiLevel
|
|
|
|
The UI level for this field. See the WebGUI developer's site for
|
|
details. Defaults to "0".
|
|
|
|
=cut
|
|
|
|
sub selectList {
|
|
my ($output);
|
|
my ($self, @p) = @_;
|
|
my ($name, $options, $label, $value, $size, $multiple, $extras, $subtext, $uiLevel) =
|
|
rearrange([name, options, label, value, size, multiple, extras, subtext, uiLevel], @p);
|
|
if (_uiLevelChecksOut($uiLevel)) {
|
|
$output = WebGUI::Form::selectList({
|
|
name=>$name,
|
|
options=>$options,
|
|
value=>$value,
|
|
multiple=>$multiple,
|
|
size=>$size,
|
|
extras=>$extras
|
|
});
|
|
$output .= _subtext($subtext);
|
|
$output = $self->_tableFormRow($label,$output);
|
|
} else {
|
|
$output = WebGUI::Form::hiddenList({
|
|
name=>$name,
|
|
options=>$options,
|
|
value=>$value
|
|
});
|
|
}
|
|
$self->{_data} .= $output;
|
|
}
|
|
|
|
#-------------------------------------------------------------------
|
|
|
|
=head2 submit ( value [ label, extras, subtext ] )
|
|
|
|
Adds a submit button row to this form.
|
|
|
|
=item value
|
|
|
|
The button text for this submit button. Defaults to "save".
|
|
|
|
=item label
|
|
|
|
The left column label for this form row.
|
|
|
|
=item extras
|
|
|
|
If you want to add anything special to this form element like
|
|
javascript actions, or stylesheet information, you'd add it in
|
|
here as follows:
|
|
|
|
'onChange="this.form.submit()"'
|
|
|
|
=item subtext
|
|
|
|
Extra text to describe this form element or to provide special
|
|
instructions.
|
|
|
|
=cut
|
|
|
|
sub submit {
|
|
my ($output);
|
|
my ($self, @p) = @_;
|
|
my ($value, $label, $extras, $subtext) = rearrange([value, label, extras, subtext], @p);
|
|
$output = WebGUI::Form::submit({
|
|
value=>$value,
|
|
extras=>$extras
|
|
});
|
|
$output .= _subtext($subtext);
|
|
$output = $self->_tableFormRow($label,$output);
|
|
$self->{_data} .= $output;
|
|
}
|
|
|
|
#-------------------------------------------------------------------
|
|
|
|
=head2 template ( name [, value, label, namespace, return, extras, uiLevel ] )
|
|
|
|
=cut
|
|
|
|
sub template {
|
|
my ($output, $subtext);
|
|
my ($self, @p) = @_;
|
|
my ($name, $value, $label, $namespace, $afterEdit, $extras, $uiLevel) =
|
|
rearrange([name, value, label, namespace, afterEdit, extras, uiLevel], @p);
|
|
if (_uiLevelChecksOut($uiLevel)) {
|
|
if ($afterEdit) {
|
|
$subtext = '<a href="'.WebGUI::URL::page("op=editTemplate&tid=".$value."&namespace=".$namespace
|
|
."&afterEdit="
|
|
.WebGUI::URL::escape($afterEdit)).'">'.WebGUI::International::get(741).'</a> / ';
|
|
}
|
|
$subtext .= '<a href="'.WebGUI::URL::page("op=listTemplates&namespace=$namespace").'">'
|
|
.WebGUI::International::get(742).'</a>';
|
|
$output = WebGUI::Form::template({
|
|
name=>$name,
|
|
value=>$value,
|
|
namespace=>$namespace,
|
|
extras=>$extras
|
|
});
|
|
$output .= _subtext($subtext);
|
|
$output = $self->_tableFormRow($label,$output);
|
|
} else {
|
|
$output = WebGUI::Form::hidden({
|
|
name=>$name,
|
|
value=>$value
|
|
});
|
|
}
|
|
$self->{_data} .= $output;
|
|
}
|
|
|
|
#-------------------------------------------------------------------
|
|
|
|
=head2 text ( name [ label, value, maxlength, extras, subtext, size, uiLevel ] )
|
|
|
|
Adds a text row to this form.
|
|
|
|
=item name
|
|
|
|
The name field for this form element.
|
|
|
|
=item label
|
|
|
|
The left column label for this form row.
|
|
|
|
=item value
|
|
|
|
The default value for this form element.
|
|
|
|
=item maxlength
|
|
|
|
The maximum number of characters to allow in this form element.
|
|
|
|
=item extras
|
|
|
|
If you want to add anything special to this form element like
|
|
javascript actions, or stylesheet information, you'd add it in
|
|
here as follows:
|
|
|
|
'onChange="this.form.submit()"'
|
|
|
|
=item subtext
|
|
|
|
Extra text to describe this form element or to provide special
|
|
instructions.
|
|
|
|
=item size
|
|
|
|
The number of characters wide this form element should be. There
|
|
should be no reason for anyone to specify this.
|
|
|
|
=item uiLevel
|
|
|
|
The UI level for this field. See the WebGUI developer's site for
|
|
details. Defaults to "0".
|
|
|
|
=cut
|
|
|
|
sub text {
|
|
my ($output);
|
|
my ($self, @p) = @_;
|
|
my ($name, $label, $value, $maxlength, $extras, $subtext, $size, $uiLevel) =
|
|
rearrange([name, label, value, maxlength, extras, subtext, size, uiLevel], @p);
|
|
if (_uiLevelChecksOut($uiLevel)) {
|
|
$output = WebGUI::Form::text({
|
|
name=>$name,
|
|
value=>$value,
|
|
size=>$size,
|
|
maxlength=>$maxlength,
|
|
extras=>$extras
|
|
});
|
|
$output .= _subtext($subtext);
|
|
$output = $self->_tableFormRow($label,$output);
|
|
} else {
|
|
$output = WebGUI::Form::hidden({
|
|
name=>$name,
|
|
value=>$value
|
|
});
|
|
}
|
|
$self->{_data} .= $output;
|
|
}
|
|
|
|
#-------------------------------------------------------------------
|
|
|
|
=head2 textarea ( name [ label, value, subtext, extras, wrap, rows, columns, uiLevel ] )
|
|
|
|
Adds a text area row to this form.
|
|
|
|
=item name
|
|
|
|
The name field for this form element.
|
|
|
|
=item label
|
|
|
|
The left column label for this form row.
|
|
|
|
=item value
|
|
|
|
The default value for this form element.
|
|
|
|
=item subtext
|
|
|
|
Extra text to describe this form element or to provide special
|
|
instructions.
|
|
|
|
=item extras
|
|
|
|
If you want to add anything special to this form element like
|
|
javascript actions, or stylesheet information, you'd add it in
|
|
here as follows:
|
|
|
|
'onChange="this.form.submit()"'
|
|
|
|
=item wrap
|
|
|
|
The method for wrapping text in the text area. Defaults to
|
|
"virtual". There should be almost no reason to specify this.
|
|
|
|
=item rows
|
|
|
|
The number of characters tall this form element should be. There
|
|
should be no reason for anyone to specify this.
|
|
|
|
=item columns
|
|
|
|
The number of characters wide this form element should be. There
|
|
should be no reason for anyone to specify this.
|
|
|
|
=item uiLevel
|
|
|
|
The UI level for this field. See the WebGUI developer's site for
|
|
details. Defaults to "0".
|
|
|
|
=cut
|
|
|
|
sub textarea {
|
|
my ($output);
|
|
my ($self, @p) = @_;
|
|
my ($name, $label, $value, $subtext, $extras, $wrap, $rows, $columns, $uiLevel) =
|
|
rearrange([name, label, value, subtext, extras, wrap, rows, columns, uiLevel], @p);
|
|
if (_uiLevelChecksOut($uiLevel)) {
|
|
$output = WebGUI::Form::textarea({
|
|
name=>$name,
|
|
value=>$value,
|
|
wrap=>$wrap,
|
|
columns=>$columns,
|
|
rows=>$rows,
|
|
extras=>$extras
|
|
});
|
|
$output .= _subtext($subtext);
|
|
$output = $self->_tableFormRow($label,$output);
|
|
} else {
|
|
$output = WebGUI::Form::hidden({
|
|
name=>$name,
|
|
value=>$value
|
|
});
|
|
}
|
|
$self->{_data} .= $output;
|
|
}
|
|
|
|
#-------------------------------------------------------------------
|
|
|
|
=head2 url ( name [ label, value, maxlength, extras, subtext, size, uiLevel ] )
|
|
|
|
Adds a URL row to this form.
|
|
|
|
=item name
|
|
|
|
The name field for this form element.
|
|
|
|
=item label
|
|
|
|
The left column label for this form row.
|
|
|
|
=item value
|
|
|
|
The default value for this form element.
|
|
|
|
=item maxlength
|
|
|
|
The maximum number of characters to allow in this form element.
|
|
Defaults to 2048.
|
|
|
|
=item extras
|
|
|
|
If you want to add anything special to this form element like
|
|
javascript actions, or stylesheet information, you'd add it in
|
|
here as follows:
|
|
|
|
'onChange="this.form.submit()"'
|
|
|
|
=item subtext
|
|
|
|
Extra text to describe this form element or to provide special
|
|
instructions.
|
|
|
|
=item size
|
|
|
|
The number of characters wide this form element should be. There
|
|
should be no reason for anyone to specify this.
|
|
|
|
=item uiLevel
|
|
|
|
The UI level for this field. See the WebGUI developer's site for
|
|
details. Defaults to "0".
|
|
|
|
=cut
|
|
|
|
sub url {
|
|
my ($output);
|
|
my ($self, @p) = @_;
|
|
my ($name, $label, $value, $maxlength, $extras, $subtext, $size, $uiLevel) =
|
|
rearrange([name, label, value, maxlength, extras, subtext, size, uiLevel], @p);
|
|
if (_uiLevelChecksOut($uiLevel)) {
|
|
$output = WebGUI::Form::url({
|
|
name=>$name,
|
|
value=>$value,
|
|
size=>$size,
|
|
maxlength=>$maxlength,
|
|
extras=>$extras
|
|
});
|
|
$output .= _subtext($subtext);
|
|
$output = $self->_tableFormRow($label,$output);
|
|
} else {
|
|
$output = WebGUI::Form::hidden({
|
|
name=>$name,
|
|
value=>$value
|
|
});
|
|
}
|
|
$self->{_data} .= $output;
|
|
}
|
|
|
|
#-------------------------------------------------------------------
|
|
|
|
=head2 whatNext ( hashRef ] )
|
|
|
|
Adds a "What next?" select list to this form for use with chained
|
|
action forms in WebGUI.
|
|
|
|
=item options
|
|
|
|
A hash reference of the possible actions that could happen next.
|
|
|
|
=item value
|
|
|
|
The selected element in this list.
|
|
|
|
=item name
|
|
|
|
The name field for this form element. Defaults to "proceed".
|
|
|
|
=item label
|
|
|
|
The left column label for this form row.
|
|
|
|
=item subtext
|
|
|
|
Extra text to describe this form element or to provide special
|
|
instructions.
|
|
|
|
=item uiLevel
|
|
|
|
The UI level for this field. See the WebGUI developer's site for
|
|
details. Defaults to "1".
|
|
|
|
=cut
|
|
|
|
=item extras
|
|
|
|
If you want to add anything special to this form element like
|
|
javascript actions, or stylesheet information, you'd add it in
|
|
here as follows:
|
|
|
|
'onChange="this.form.submit()"'
|
|
|
|
=cut
|
|
|
|
sub whatNext {
|
|
my ($output);
|
|
my ($self, @p) = @_;
|
|
my ($options, $value, $name, $label, $subtext, $uiLevel, $extras) =
|
|
rearrange([options, value, name, label, subtext, uiLevel, extras], @p);
|
|
$uiLevel |= 1;
|
|
$label |= WebGUI::International::get(744);
|
|
if (_uiLevelChecksOut($uiLevel)) {
|
|
$output = WebGUI::Form::whatNext({
|
|
name=>$name,
|
|
options=>$options,
|
|
value=>$value,
|
|
extras=>$extras
|
|
});
|
|
$output .= _subtext($subtext);
|
|
$output = $self->_tableFormRow($label,$output);
|
|
} else {
|
|
$output = WebGUI::Form::hidden({
|
|
name=>$name,
|
|
value=>$value
|
|
});
|
|
}
|
|
$self->{_data} .= $output;
|
|
}
|
|
|
|
#-------------------------------------------------------------------
|
|
|
|
=head2 yesNo ( name [ label, value, extras, subtext, uiLevel ] )
|
|
|
|
Adds a yes/no radio menu to this form.
|
|
|
|
=item name
|
|
|
|
The name field for this form element.
|
|
|
|
=item label
|
|
|
|
The left column label for this form row.
|
|
|
|
=item value
|
|
|
|
The default value(s) for this form element. Valid values are "1"
|
|
and "0". Defaults to "1".
|
|
|
|
=item extras
|
|
|
|
If you want to add anything special to this form element like
|
|
javascript actions, or stylesheet information, you'd add it in
|
|
here as follows:
|
|
|
|
'onChange="this.form.submit()"'
|
|
|
|
=item subtext
|
|
|
|
Extra text to describe this form element or to provide special
|
|
instructions.
|
|
|
|
=item uiLevel
|
|
|
|
The UI level for this field. See the WebGUI developer's site for
|
|
details. Defaults to "0".
|
|
|
|
=cut
|
|
|
|
sub yesNo {
|
|
my ($output);
|
|
my ($self, @p) = @_;
|
|
my ($name, $label, $value, $extras, $subtext, $uiLevel) =
|
|
rearrange([name, label, value, extras, subtext, uiLevel], @p);
|
|
if (_uiLevelChecksOut($uiLevel)) {
|
|
$output = WebGUI::Form::yesNo({
|
|
name=>$name,
|
|
value=>$value,
|
|
extras=>$extras
|
|
});
|
|
$output .= _subtext($subtext);
|
|
$output = $self->_tableFormRow($label,$output);
|
|
} else {
|
|
$value = 0 unless ($value);
|
|
$output = WebGUI::Form::hidden({
|
|
name=>$name,
|
|
value=>$value
|
|
});
|
|
}
|
|
$self->{_data} .= $output;
|
|
}
|
|
|
|
#-------------------------------------------------------------------
|
|
|
|
=head2 zipcode ( name [ label, value, maxlength, extras, subtext, size, uiLevel ] )
|
|
|
|
Adds a zip code row to this form.
|
|
|
|
=item name
|
|
|
|
The name field for this form element.
|
|
|
|
=item label
|
|
|
|
The left column label for this form row.
|
|
|
|
=item value
|
|
|
|
The default value for this form element.
|
|
|
|
=item maxlength
|
|
|
|
The maximum number of characters to allow in this form element.
|
|
|
|
=item extras
|
|
|
|
If you want to add anything special to this form element like
|
|
javascript actions, or stylesheet information, you'd add it in
|
|
here as follows:
|
|
|
|
'onChange="this.form.submit()"'
|
|
|
|
=item subtext
|
|
|
|
Extra text to describe this form element or to provide special
|
|
instructions.
|
|
|
|
=item size
|
|
|
|
The number of characters wide this form element should be. There
|
|
should be no reason for anyone to specify this.
|
|
|
|
=item uiLevel
|
|
|
|
The UI level for this field. See the WebGUI developer's site for
|
|
details. Defaults to "0".
|
|
|
|
=cut
|
|
|
|
sub zipcode {
|
|
my ($output);
|
|
my ($self, @p) = @_;
|
|
my ($name, $label, $value, $maxlength, $extras, $subtext, $size, $uiLevel) =
|
|
rearrange([name, label, value, maxlength, extras, subtext, size, uiLevel], @p);
|
|
if (_uiLevelChecksOut($uiLevel)) {
|
|
$output = WebGUI::Form::zipcode({
|
|
name=>$name,
|
|
value=>$value,
|
|
size=>$size,
|
|
maxlength=>$maxlength,
|
|
extras=>$extras
|
|
});
|
|
$output .= _subtext($subtext);
|
|
$output = $self->_tableFormRow($label,$output);
|
|
} else {
|
|
$output = WebGUI::Form::hidden({
|
|
name=>$name,
|
|
value=>$value
|
|
});
|
|
}
|
|
$self->{_data} .= $output;
|
|
}
|
|
|
|
|
|
|
|
|
|
1;
|
|
|