Class: Watir::CheckBox

Inherits:

RadioCheckCommon

• Object
• Element
• InputElement
• RadioCheckCommon
• Watir::CheckBox

Defined in:

lib/watir/input_elements.rb

Overview

This class is the watir representation of a check box. Normally a user would not need to create this object as it is returned by the Watir::Container#checkbox method

Constant Summary

INPUT_TYPES =

["checkbox"]

Constants inherited from Element

Element::TO_S_SIZE

Instance Attribute Summary

Attributes inherited from Element

#container

Attributes included from Container

#activeObjectHighLightColor, #page_container, #type_keys, #typingspeed

Instance Method Summary

• #clear ⇒ Object

  Clears a check box.

• #set(value = true) ⇒ Object

  This method checks or unchecks the checkbox.

Methods inherited from RadioCheckCommon

#getState, #inspect, #isSet?, #set?

Methods inherited from InputElement

#initialize, #locate

Methods inherited from Element

#<=>, #__ole_inner_elements, #activeObjectHighLightColor, #after_text, #assert_enabled, #assert_exists, #attribute_value, #before_text, #click, #click!, #create_event, #dispatch_event, #document, #enabled?, #exists?, #fire_event, #flash, #focus, inherited, #initialize, #inspect, #locate, #method_missing, #name, #ole_object, #ole_object=, #parent, #text, #to_s, #type_keys, #typingspeed, #visible?

Methods included from Container

#__ole_inner_elements, #input_element_locator, #locator_for, #log, #set_container, #show_all_objects, #tagged_element_locator, #wait

Constructor Details

This class inherits a constructor from Watir::InputElement

Dynamic Method Handling

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

Instance Method Details

#clear ⇒ Object

Clears a check box.

Raises UnknownObjectException if its unable to locate an object
      ObjectDisabledException if the object is disabled

# File 'lib/watir/input_elements.rb', line 559

def clear
  set false
end

#set(value = true) ⇒ Object

This method checks or unchecks the checkbox. With no arguments supplied it sets the checkbox. Setting false argument unchecks/clears the checkbox.

Raises UnknownObjectException if it's unable to locate an object
      ObjectDisabledException if the object is disabled

# File 'lib/watir/input_elements.rb', line 545

def set(value=true)
  assert_exists
  assert_enabled
  highlight :set
  current_value = @o.checked
  unless value == current_value
    click
  end
  highlight :clear
end