NAME

HTML::DOM::Collection::Elements - A subclass of HTML::DOM::Collection for form elements

SYNOPSIS

  use HTML::DOM;
  $doc = HTML::DOM->new;
  $doc->write('
      <form>
          <input name=r type=radio value=1>
          <input name=r type=radio value=2>
      </form>
  ');
  $doc->close;
  
  $elements = $doc->forms->[0]->elements;
  # returns an HTML::DOM::Collection::Elements object
    
  $elements->[0]; # first radio button
  $elements->item(0); # same

  $elements->{r}; # an array of buttons named 'r'
  $elements->namedItem('r'); # same
  () = $elements->namedItem('r'); # list, not array
  
  $elements->length; # same as scalar @$elements

DESCRIPTION

This implements the HTMLCollection interface as described in the W3C's DOM standard, except that the namedItem method (and the corresponding hash dereference) will return a list of form elements if there are several with the same name. This is actually in violation of the DOM standard, but it is in accordance with the way most web browsers work (at least Safari and Firefox).

CONSTRUCTOR

Normally you would simply call the HTML::DOM::Element::Form manpage's elements method (as in the SYNOPSIS). But if you wall to call the constructor anyway, here is the syntax:

  $elements = HTML::DOM::Collection::Elements->new($nodelist)

$nodelist should be a node list (the HTML::DOM::NodeList manpage) object.

METHODS

$elements->length

Returns the number of items in the collection.

$elements->item($index)

Returns item number $index, numbered from 0. Note that you call also use $elements->[$index] for short.

$elements->namedItem($name)

Returns the item named $name, is there is only one. If there is more than one, it returns a node list object in scalar context, or a list in list context. You can also write $collection->{$name}.

SEE ALSO

the HTML::DOM manpage

the HTML::DOM::Collection manpage

the HTML::DOM::Element::Form manpage

the HTML::DOM::NodeList manpage (manpage not written yet)

the HTML::DOM::NodeList::Magic manpage (manpage not written yet)