NAME

Rose::HTML::Form::Field::Option - Object representation of the "option" HTML tag.

SYNOPSIS

$field =
  Rose::HTML::Form::Field::Option->new(
    value => 'apple',
    label => 'Apple');

$field->selected(1);

print $field->html;

...

DESCRIPTION

Rose::HTML::Form::Field::Option is an object representation of a single option in a pop-up menu or select box 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:

accept
accesskey
alt
checked
class
dir
disabled
id
ismap
label
lang
maxlength
name
onblur
onchange
onclick
ondblclick
onfocus
onkeydown
onkeypress
onkeyup
onmousedown
onmousemove
onmouseout
onmouseover
onmouseup
onselect
readonly
selected
size
src
style
tabindex
title
type
usemap
value
xml:lang

Required attributes:

value

Boolean attributes:

checked
disabled
ismap
readonly
selected

CONSTRUCTOR

new PARAMS

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

OBJECT METHODS

short_label [TEXT]

Get or set the value of the "label" HTML attribute. When present, user agents are supposed to use this value instead of the contents of the option tag as the label for the option. Example:

$field =
  Rose::HTML::Form::Field::Option->new(
    value => 'apple',
    label => 'Shiny Apple');

print $field->html;

# The HTML:
#
#   <option value="apple">Shiny Apple</option>
#
# Label shown in web browser: "Shiny Apple"

$field->short_label("Apple");
print $field->html;

# The HTML:
#
#   <option label="Apple" value="apple">Shiny Apple</option>
#
# Label shown in web browser: "Apple"

(Hey, don't look at me, I didn't write the HTML specs...)

AUTHOR

John C. Siracusa (siracusa@mindspring.com)