NAME

Rose::HTML::Form::Field::TextArea - Object representation of a multi-line text field in an HTML form.

SYNOPSIS

$field =
  Rose::HTML::Form::Field::TextArea->new(
    label => 'Comments', 
    name  => 'comments',
    rows  => 2,
    cols  => 50);

$comments = $field->internal_value;

print $field->html;

...

DESCRIPTION

Rose::HTML::Form::Field::TextArea is an object representation of a multi-line text field in an HTML form.

This class inherits from, and follows the conventions of, Rose::HTML::Form::Field. Inherited methods that are not overridden will not be documented a second time here. See the Rose::HTML::Form::Field documentation for more information.

HTML ATTRIBUTES

Valid attributes:

accesskey
class
cols
dir
disabled
id
lang
name
onblur
onchange
onclick
ondblclick
onfocus
onkeydown
onkeypress
onkeyup
onmousedown
onmousemove
onmouseout
onmouseover
onmouseup
onselect
readonly
rows
style
tabindex
title
value
xml:lang

Required attributes (default values in parentheses):

cols (50)
rows (6)

Boolean attributes:

checked
disabled
readonly

CONSTRUCTOR

new PARAMS

Constructs a new Rose::HTML::Form::Field::TextArea object based on PARAMS, where PARAMS are name/value pairs. Any object method is a valid parameter name.

OBJECT METHODS

contents [TEXT]

Get or set the contents of the text area. If a TEXT argument is present, it is passed to input_value() and the return value of that method call is then returned. Otherwise, output_value() is called with no arguments.

maxlength [INT]

Get or set the maximum length of the input value. Note that this is not an HTML attribute; this limit is enforced by the validate method, not by the web browser.

size [COLSxROWS]

Get or set the number of columns and rows (cols and rows) in the text area in the form of a string "COLSxROWS". For example, "40x3" means 40 columns and 3 rows. If the size argument is not in the correct format, a fatal error will occur.

value [TEXT]

Simply calls input_value, passing all arguments.

AUTHOR

John C. Siracusa (siracusa@gmail.com)

LICENSE

Copyright (c) 2010 by John C. Siracusa. All rights reserved. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.