Class: Watir::ElementCollection

Inherits:

Object

• Object
• Watir::ElementCollection

Includes:

Enumerable

Defined in:

lib/watir-webdriver/element_collection.rb

Overview

Base class for element collections.

Direct Known Subclasses

AnchorCollection, AppletCollection, AreaCollection, AudioCollection, BRCollection, BaseCollection, BodyCollection, ButtonCollection, CanvasCollection, DListCollection, DataCollection, DataListCollection, DetailsCollection, DialogCollection, DirectoryCollection, DivCollection, EmbedCollection, FieldSetCollection, FontCollection, FormCollection, FrameSetCollection, HRCollection, HTMLElementCollection, HeadCollection, HeadingCollection, HtmlCollection, IFrameCollection, ImageCollection, InputCollection, KeygenCollection, LICollection, LabelCollection, LegendCollection, MapCollection, MarqueeCollection, MediaCollection, MenuCollection, MenuItemCollection, MetaCollection, MeterCollection, ModCollection, OListCollection, ObjectCollection, OptGroupCollection, OptionCollection, OutputCollection, ParagraphCollection, ParamCollection, PreCollection, ProgressCollection, QuoteCollection, ScriptCollection, SelectCollection, SourceCollection, SpanCollection, StyleCollection, TableCaptionCollection, TableCellCollection, TableColCollection, TableCollection, TableDataCellCollection, TableHeaderCellCollection, TableRowCollection, TableSectionCollection, TemplateCollection, TextAreaCollection, TimeCollection, TitleCollection, TrackCollection, UListCollection, UnknownCollection, VideoCollection

Instance Method Summary

• #[](idx) ⇒ Watir::Element

  Get the element at the given index.

• #each {|element| ... } ⇒ Object

  Yields each element in collection.

• #first ⇒ Watir::Element

  First element of this collection.

• #initialize(parent, selector) ⇒ ElementCollection constructor

  A new instance of ElementCollection.

• #last ⇒ Watir::Element

  Last element of the collection.

• #length ⇒ Fixnum (also: #size)

  Returns number of elements in collection.

• #to_a ⇒ Array<Watir::Element>

  This collection as an Array.

Constructor Details

#initialize(parent, selector) ⇒ ElementCollection

Returns a new instance of ElementCollection.

# File 'lib/watir-webdriver/element_collection.rb', line 11

def initialize(parent, selector)
  @parent   = parent
  @selector = selector
end

Instance Method Details

#[](idx) ⇒ Watir::Element

Get the element at the given index. Note that this is 0-indexed and not compatible with older Watir implementations.

Also note that because of Watir’s lazy loading, this will return an Element instance even if the index is out of bounds.

Parameters:

• idx (Fixnum) —

  Index of wanted element, 0-indexed

Returns:

• (Watir::Element) —

  Returns an instance of a Watir::Element subclass

# File 'lib/watir-webdriver/element_collection.rb', line 54

def [](idx)
  to_a[idx] || element_class.new(@parent, :index => idx)
end

#each {|element| ... } ⇒ Object

Yields each element in collection.

Examples:

divs = browser.divs(:class => 'kls')
divs.each do |div|
  puts div.text
end

Yield Parameters:

• element (Watir::Element) —

  Iterate through the elements in this collection.

# File 'lib/watir-webdriver/element_collection.rb', line 28

def each(&blk)
  to_a.each(&blk)
end

#first ⇒ Watir::Element

First element of this collection

Returns:

• (Watir::Element) —

  Returns an instance of a Watir::Element subclass

# File 'lib/watir-webdriver/element_collection.rb', line 64

def first
  self[0]
end

#last ⇒ Watir::Element

Last element of the collection

Returns:

• (Watir::Element) —

  Returns an instance of a Watir::Element subclass

# File 'lib/watir-webdriver/element_collection.rb', line 74

def last
  self[-1]
end

#length ⇒ Fixnum Also known as: size

Returns number of elements in collection.

Returns:

• (Fixnum)

# File 'lib/watir-webdriver/element_collection.rb', line 38

def length
  elements.length
end

#to_a ⇒ Array<Watir::Element>

This collection as an Array.

Returns:

• (Array<Watir::Element>)

# File 'lib/watir-webdriver/element_collection.rb', line 84

def to_a
  # TODO: optimize - lazy element_class instance?
  @to_a ||= elements.map { |e| element_class.new(@parent, :element => e) }
end