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

Constant Summary

Constants included from AttributeHelper

AttributeHelper::IGNORED_ATTRIBUTES

Constants included from Atoms

Atoms::ATOMS

Instance Method Summary (collapse)

Methods inherited from HTMLElement

#access_key, #access_key_label, #class_name, #command_checked?, #command_disabled?, #command_hidden?, #command_icon, #command_label, #command_type, #content_editable, #content_editable?, #dir, #draggable?, #hidden?, #item_id, #item_scope?, #item_value, #lang, #spellcheck?, #tab_index, #title, #translate?

Methods inherited from Element

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

Methods included from AttributeHelper

#attribute_list, #attributes, #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, #command, #commands, #data, #datalist, #datalists, #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, #form, #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, #labels, #legend, #legends, #li, #link, #links, #lis, #map, #maps, #mark, #marks, #menu, #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, #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

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

- (Boolean) autofocus?

Returns:

  • (Boolean) 


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

attributes(:bool => [:autofocus, :disabled, :multiple, :required, :will_validate], :html_element => [:form], :list => [:labels], :int => [:length, :selected_index, :size], :string => [:name, :type, :validation_message, :validity, :value], :html_collection => [:options, :selected_options])

- (Object) clear

Clear 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

- (Boolean) disabled?

Returns:

  • (Boolean) 


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

attributes(:bool => [:autofocus, :disabled, :multiple, :required, :will_validate], :html_element => [:form], :list => [:labels], :int => [:length, :selected_index, :size], :string => [:name, :type, :validation_message, :validity, :value], :html_collection => [:options, :selected_options])

- (Boolean) enabled?

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

- (Boolean) include?(str_or_rx)

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

Parameters:

  • value (String, Regexp) —

    A value.

Returns:

  • (Boolean) 


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

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

- (Integer) length

Returns:

  • (Integer) 


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

attributes(:bool => [:autofocus, :disabled, :multiple, :required, :will_validate], :html_element => [:form], :list => [:labels], :int => [:length, :selected_index, :size], :string => [:name, :type, :validation_message, :validity, :value], :html_collection => [:options, :selected_options])

- (Boolean) multiple?

Returns:

  • (Boolean) 


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

attributes(:bool => [:autofocus, :disabled, :multiple, :required, :will_validate], :html_element => [:form], :list => [:labels], :int => [:length, :selected_index, :size], :string => [:name, :type, :validation_message, :validity, :value], :html_collection => [:options, :selected_options])

- (String) name

Returns:

  • (String) 


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

attributes(:bool => [:autofocus, :disabled, :multiple, :required, :will_validate], :html_element => [:form], :list => [:labels], :int => [:length, :selected_index, :size], :string => [:name, :type, :validation_message, :validity, :value], :html_collection => [:options, :selected_options])

- (Watir::OptionCollection) options

Get all the options in the select list

Returns:



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

def options
  assert_exists
  super
end

- (Boolean) required?

Returns:

  • (Boolean) 


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

attributes(:bool => [:autofocus, :disabled, :multiple, :required, :will_validate], :html_element => [:form], :list => [:labels], :int => [:length, :selected_index, :size], :string => [:name, :type, :validation_message, :validity, :value], :html_collection => [:options, :selected_options])

- (String) select(str_or_rx)

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:

  • value (String, Regexp) —

    A value.

Returns:

  • (String) —

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

Raises:



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

def select(str_or_rx)
  select_by :text, str_or_rx
end

- (String) select_value(str_or_rx)

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

Parameters:

  • value (String, Regexp) —

    A value.

Returns:

  • (String) —

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

Raises:

See Also:

  • +select+


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

def select_value(str_or_rx)
  select_by :value, str_or_rx
end

- (Boolean) selected?(str_or_rx)

Returns true if any of the selected options' text or label match the given value.

Parameters:

  • value (String, Regexp) —

    A value.

Returns:

  • (Boolean)

Raises:



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

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

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

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

- (Integer) selected_index

Returns:

  • (Integer) 


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

attributes(:bool => [:autofocus, :disabled, :multiple, :required, :will_validate], :html_element => [:form], :list => [:labels], :int => [:length, :selected_index, :size], :string => [:name, :type, :validation_message, :validity, :value], :html_collection => [:options, :selected_options])

- (Array<Watir::Option>) selected_options

An array of Watir::Option elements that are currently selected.

Returns:

  • (Array<Watir::Option>) —

    An array of Watir::Option elements that are currently selected.



117
118
119
120
 
# File 'lib/watir-webdriver/elements/select.rb', line 117

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

- (Integer) size

Returns:

  • (Integer) 


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

attributes(:bool => [:autofocus, :disabled, :multiple, :required, :will_validate], :html_element => [:form], :list => [:labels], :int => [:length, :selected_index, :size], :string => [:name, :type, :validation_message, :validity, :value], :html_collection => [:options, :selected_options])

- (String) type

Returns:

  • (String) 


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

attributes(:bool => [:autofocus, :disabled, :multiple, :required, :will_validate], :html_element => [:form], :list => [:labels], :int => [:length, :selected_index, :size], :string => [:name, :type, :validation_message, :validity, :value], :html_collection => [:options, :selected_options])

- (String) validation_message

Returns:

  • (String) 


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

attributes(:bool => [:autofocus, :disabled, :multiple, :required, :will_validate], :html_element => [:form], :list => [:labels], :int => [:length, :selected_index, :size], :string => [:name, :type, :validation_message, :validity, :value], :html_collection => [:options, :selected_options])

- (String) validity

Returns:

  • (String) 


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

attributes(:bool => [:autofocus, :disabled, :multiple, :required, :will_validate], :html_element => [:form], :list => [:labels], :int => [:length, :selected_index, :size], :string => [:name, :type, :validation_message, :validity, :value], :html_collection => [:options, :selected_options])

- (String?) value

Returns the value of the first selected option in the select list. Returns nil if no option is selected.

Returns:

  • (String, nil)
  • (String) 


107
108
109
110
 
# File 'lib/watir-webdriver/elements/select.rb', line 107

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

- (Boolean) will_validate?

Returns:

  • (Boolean) 


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

attributes(:bool => [:autofocus, :disabled, :multiple, :required, :will_validate], :html_element => [:form], :list => [:labels], :int => [:length, :selected_index, :size], :string => [:name, :type, :validation_message, :validity, :value], :html_collection => [:options, :selected_options])