Rose::HTML::Form::Field::Option.3pm

Langue: en

Version: 2008-02-25 (mandriva - 01/05/08)

Section: 3 (Bibliothèques de fonctions)

Sommaire

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

hidden [BOOL]
Get or set a boolean value that indicates whether or not this radio button will be shown in its parent select box, pop-up menu, or option group. Setting it to true also sets selected to false.
hide
Calls hidden, passing a true value.
selected [BOOL]
Select or unselect the option by passing a boolean value. If BOOL is true, the option will be selected. If it's false, it will be unselected. Returns true if the option is selected, false otherwise.
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...)

show
Calls hidden, passing a false value.

AUTHOR

John C. Siracusa (siracusa@gmail.com) Copyright (c) 2008 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.