Class: Watir::Select

Inherits:
HTMLElement show all
Includes:
Exception
Defined in:
lib/watir-webdriver/elements/select.rb,
lib/watir-webdriver/elements/generated.rb

Constant Summary

Constants included from Atoms

Atoms::ATOMS

Instance Method Summary collapse

Methods inherited from HTMLElement

#access_key, #access_key_label, #command_checked?, #command_disabled?, #command_hidden?, #command_icon, #command_label, #command_type, #content_editable, #content_editable?, #context_menu, #dataset, #dir, #draggable?, #dropzone, #hidden?, #item_id, #item_prop, #item_ref, #item_scope?, #item_type, #item_value, #lang, #onabort, #onautocomplete, #onautocompleteerror, #onblur, #oncancel, #oncanplay, #oncanplaythrough, #onchange, #onclick, #onclose, #oncontextmenu, #oncuechange, #ondblclick, #ondrag, #ondragend, #ondragenter, #ondragexit, #ondragleave, #ondragover, #ondragstart, #ondrop, #ondurationchange, #onemptied, #onended, #onerror, #onfocus, #oninput, #oninvalid, #onkeydown, #onkeypress, #onkeyup, #onload, #onloadeddata, #onloadedmetadata, #onloadstart, #onmousedown, #onmouseenter, #onmouseleave, #onmousemove, #onmouseout, #onmouseover, #onmouseup, #onmousewheel, #onpause, #onplay, #onplaying, #onprogress, #onratechange, #onreset, #onresize, #onscroll, #onseeked, #onseeking, #onselect, #onshow, #onsort, #onstalled, #onsubmit, #onsuspend, #ontimeupdate, #ontoggle, #onvolumechange, #onwaiting, #properties, #spellcheck?, #tab_index, #title, #translate?

Methods inherited from Element

#==, #attribute_value, #browser, #class_name, #click, #double_click, #drag_and_drop_by, #drag_and_drop_on, #driver, #exists?, #fire_event, #flash, #focus, #focused?, #hash, #hover, #id, #initialize, #inner_html, #inspect, #outer_html, #parent, #present?, #right_click, #run_checkers, #select_text, #send_keys, #style, #tag_name, #text, #to_subtype, #visible?, #wd

Methods included from AttributeHelper

#attribute, #attribute_list, #inherit_attributes_from, #method, #typed_attributes

Methods included from EventuallyPresent

#wait_until_present, #wait_while_present, #when_present

Methods included from Container

#a, #abbr, #abbrs, #address, #addresses, #area, #areas, #article, #articles, #as, #aside, #asides, #audio, #audios, #b, #base, #bases, #bdi, #bdis, #bdo, #bdos, #blockquote, #blockquotes, #body, #bodys, #br, #brs, #bs, #button, #buttons, #canvas, #canvases, #caption, #captions, #checkbox, #checkboxes, #cite, #cites, #code, #codes, #col, #colgroup, #colgroups, #cols, #data, #datalist, #datalists, #datas, #dd, #dds, #del, #dels, #details, #detailses, #dfn, #dfns, #dialog, #dialogs, #div, #divs, #dl, #dls, #dt, #dts, #element, #elements, #em, #embed, #embeds, #ems, #extract_selector, #field_set, #field_sets, #fieldset, #fieldsets, #figcaption, #figcaptions, #figure, #figures, #file_field, #file_fields, #font, #fonts, #footer, #footers, #forms, #frame, #frames, #frameset, #framesets, #h1, #h1s, #h2, #h2s, #h3, #h3s, #h4, #h4s, #h5, #h5s, #h6, #h6s, #head, #header, #headers, #heads, #hgroup, #hgroups, #hidden, #hiddens, #hr, #hrs, #html, #htmls, #i, #iframe, #iframes, #image, #images, #img, #imgs, #input, #inputs, #ins, #inses, #is, #kbd, #kbds, #keygen, #keygens, #label, #legend, #legends, #li, #link, #links, #lis, #main, #mains, #map, #maps, #mark, #marks, #menu, #menuitem, #menuitems, #menus, #meta, #metas, #meter, #meters, #nav, #navs, #noscript, #noscripts, #object, #objects, #ol, #ols, #optgroup, #optgroups, #option, #output, #outputs, #p, #param, #params, #pre, #pres, #progress, #progresses, #ps, #q, #qs, #radio, #radios, #rp, #rps, #rt, #rts, #rubies, #ruby, #s, #samp, #samps, #script, #scripts, #section, #sections, #select_list, #select_lists, #selects, #small, #smalls, #source, #sources, #span, #spans, #ss, #strong, #strongs, #style, #styles, #sub, #subs, #summaries, #summary, #sup, #sups, #table, #tables, #tbody, #tbodys, #td, #tds, #template, #templates, #text_field, #text_fields, #textarea, #textareas, #tfoot, #tfoots, #th, #thead, #theads, #ths, #time, #times, #title, #titles, #tr, #track, #tracks, #trs, #u, #ul, #uls, #us, #var, #vars, #video, #videos, #wbr, #wbrs

Methods included from Atoms

load

Methods included from XpathSupport

downcase, escape

Constructor Details

This class inherits a constructor from Watir::Element

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class Watir::Element

Instance Method Details

#autocomplete ⇒ String

Returns value of autocomplete property.

Returns:

  • (String) —

    value of autocomplete property



400
 
# File 'lib/watir-webdriver/elements/generated.rb', line 400

attribute(String, :autocomplete, :autocomplete)

#autofocus? ⇒ Boolean

Returns value of autofocus property.

Returns:

  • (Boolean) —

    value of autofocus property



401
 
# File 'lib/watir-webdriver/elements/generated.rb', line 401

attribute("Boolean", :autofocus?, :autofocus)

#clear ⇒ Object

Clears all selected options.

Raises:



20
21
22
23
24
25
26
27
28
 
# File 'lib/watir-webdriver/elements/select.rb', line 20

def clear
  assert_exists

  raise Error, "you can only clear multi-selects" unless multiple?

  options.each do |o|
    o.click if o.selected?
  end
end

#disabled? ⇒ Boolean

Returns value of disabled property.

Returns:

  • (Boolean) —

    value of disabled property



402
 
# File 'lib/watir-webdriver/elements/generated.rb', line 402

attribute("Boolean", :disabled?, :disabled)

#enabled? ⇒ Boolean

Returns true if this element is enabled

Returns:

  • (Boolean) 


12
13
14
 
# File 'lib/watir-webdriver/elements/select.rb', line 12

def enabled?
  !disabled?
end

#form ⇒ String

Returns value of form property.

Returns:

  • (String) —

    value of form property



403
 
# File 'lib/watir-webdriver/elements/generated.rb', line 403

attribute(String, :form, :form)

#include?(str_or_rx) ⇒ Boolean

Returns true if the select list has one or more options where text or label matches the given value.

Parameters:

  • str_or_rx (String, Regexp)

Returns:

  • (Boolean) 


48
49
50
51
 
# File 'lib/watir-webdriver/elements/select.rb', line 48

def include?(str_or_rx)
  # TODO: optimize similar to selected?
  options.any? { |e| str_or_rx === e.text }
end

#labels ⇒ String

Returns value of labels property.

Returns:

  • (String) —

    value of labels property



417
 
# File 'lib/watir-webdriver/elements/generated.rb', line 417

attribute(String, :labels, :labels)

#length ⇒ Fixnum

Returns value of length property.

Returns:

  • (Fixnum) —

    value of length property



410
 
# File 'lib/watir-webdriver/elements/generated.rb', line 410

attribute(Fixnum, :length, :length)

#multiple? ⇒ Boolean

Returns value of multiple property.

Returns:

  • (Boolean) —

    value of multiple property



404
 
# File 'lib/watir-webdriver/elements/generated.rb', line 404

attribute("Boolean", :multiple?, :multiple)

#name ⇒ String

Returns value of name property.

Returns:

  • (String) —

    value of name property



405
 
# File 'lib/watir-webdriver/elements/generated.rb', line 405

attribute(String, :name, :name)

#options ⇒ String

Returns value of options property.

Returns:

  • (String) —

    value of options property



36
37
38
39
 
# File 'lib/watir-webdriver/elements/select.rb', line 36

def options
  assert_exists
  super
end

#required? ⇒ Boolean

Returns value of required property.

Returns:

  • (Boolean) —

    value of required property



406
 
# File 'lib/watir-webdriver/elements/generated.rb', line 406

attribute("Boolean", :required?, :required)

#select(str_or_rx) ⇒ String

Select the option(s) whose text or label matches the given string. If this is a multi-select and several options match the value given, all will be selected.

Parameters:

  • str_or_rx (String, Regexp)

Returns:

  • (String) —

    The text of the option selected. If multiple options match, returns the first match.

Raises:



62
63
64
 
# File 'lib/watir-webdriver/elements/select.rb', line 62

def select(str_or_rx)
  select_by :text, str_or_rx
end

#select_value(str_or_rx) ⇒ String

Selects the option(s) whose value attribute matches the given string.

Parameters:

  • str_or_rx (String, Regexp)

Returns:

  • (String) —

    The option selected. If multiple options match, returns the first match

Raises:

See Also:

  • +select+


76
77
78
 
# File 'lib/watir-webdriver/elements/select.rb', line 76

def select_value(str_or_rx)
  select_by :value, str_or_rx
end

#selected?(str_or_rx) ⇒ Boolean

Returns true if any of the selected options’ text or label matches the given value.

Parameters:

  • str_or_rx (String, Regexp)

Returns:

  • (Boolean)

Raises:



88
89
90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/watir-webdriver/elements/select.rb', line 88

def selected?(str_or_rx)
  assert_exists
  matches = element_call do
    @element.find_elements(:tag_name, 'option').select do |e|
      str_or_rx === e.text || str_or_rx === e.attribute(:label)
    end
  end

  if matches.empty?
    raise UnknownObjectException, "Unable to locate option matching #{str_or_rx.inspect}"
  end

  matches.any? { |e| e.selected? }
end

#selected_index ⇒ Fixnum

Returns value of selectedIndex property.

Returns:

  • (Fixnum) —

    value of selectedIndex property



412
 
# File 'lib/watir-webdriver/elements/generated.rb', line 412

attribute(Fixnum, :selected_index, :selectedIndex)

#selected_options ⇒ String

Returns value of selectedOptions property.

Returns:

  • (String) —

    value of selectedOptions property



122
123
124
 
# File 'lib/watir-webdriver/elements/select.rb', line 122

def selected_options
  options.select { |e| e.selected? }
end

#size ⇒ Fixnum

Returns value of size property.

Returns:

  • (Fixnum) —

    value of size property



407
 
# File 'lib/watir-webdriver/elements/generated.rb', line 407

attribute(Fixnum, :size, :size)

#type ⇒ String

Returns value of type property.

Returns:

  • (String) —

    value of type property



408
 
# File 'lib/watir-webdriver/elements/generated.rb', line 408

attribute(String, :type, :type)

#validation_message ⇒ String

Returns value of validationMessage property.

Returns:

  • (String) —

    value of validationMessage property



416
 
# File 'lib/watir-webdriver/elements/generated.rb', line 416

attribute(String, :validation_message, :validationMessage)

#validity ⇒ String

Returns value of validity property.

Returns:

  • (String) —

    value of validity property



415
 
# File 'lib/watir-webdriver/elements/generated.rb', line 415

attribute(String, :validity, :validity)

#value ⇒ String

Returns value of value property.

Returns:

  • (String) —

    value of value property



110
111
112
113
 
# File 'lib/watir-webdriver/elements/select.rb', line 110

def value
  o = options.find { |e| e.selected? } || return
  o.value
end

#will_validate? ⇒ Boolean

Returns value of willValidate property.

Returns:

  • (Boolean) —

    value of willValidate property



414
 
# File 'lib/watir-webdriver/elements/generated.rb', line 414

attribute("Boolean", :will_validate?, :willValidate)