Module: Vapir::TextField

Extended by:

ElementHelper

Defined in:

lib/vapir-common/elements/elements.rb

Instance Method Summary

• #append(value, options = {}) ⇒ Object

  Appends the specified string value to the contents of the text box.

• #clear(options = {}) ⇒ Object

  Clears the contents of the text field.

• #set(value, options = {}) ⇒ Object

  Sets the contents of the text field to the given value.

Methods included from ElementHelper

add_specifier, container_collection_method, container_single_method, included

Methods included from ElementClassAndModuleMethods

#add_container_method_extra_args, #all_dom_attr_aliases, #all_dom_attrs, #class_array_append, #class_array_get, #class_hash_get, #class_hash_merge, #container_collection_methods, #container_method_extra_args, #container_single_methods, #default_how, #dom_attr, #dom_attr_locate_alias, #dom_function, #dom_setter, #element_collection, #factory, #inspect_these, #inspect_this_if, #parent_element_module, #set_or_get_class_var, #specifiers

Instance Method Details

#append(value, options = {}) ⇒ Object

Appends the specified string value to the contents of the text box.

returns the new value of the text field. this may not include all of what is given if there is a maxlength on the field.

takes options:

• :blur => true/false; whether or not to file the onblur event when done.

• :highlight => true/false

Raises UnknownObjectException if the object cant be found Raises ObjectDisabledException if the object is disabled Raises ObjectReadOnlyException if the object is read only

Raises:

• (ArgumentError)

# File 'lib/vapir-common/elements/elements.rb', line 180

def append(value, options={})
  raise ArgumentError, "Text field value must be a string! Got #{value.inspect}" unless value.is_a?(String)
  options={:blur => true, :change => true, :select => true, :focus => true}.merge(options)
  assert_enabled
  assert_not_readonly
  
  with_highlight(options) do
    existing_value_chars=element_object.value.split(//u)
    new_value_chars=existing_value_chars+value.split(//u) # IE treats the string value is set to as utf8, and this is consistent with String#ord defined in core_ext 
    if self.type.downcase=='text' && maxlength && maxlength >= 0 && new_value_chars.length > maxlength
      new_value_chars=new_value_chars[0...maxlength]
    end
    element_object.scrollIntoView
    if options[:focus]
      assert_exists(:force => true)
      element_object.focus
      fire_event('onFocus')
    end
    if options[:select]
      assert_exists(:force => true)
      element_object.select
      fire_event("onSelect")
    end
    if config.type_keys
      (existing_value_chars.length...new_value_chars.length).each do |i|
        last_key = (i == new_value_chars.length - 1)
        handling_existence_failure(:handle => (last_key ? :ignore : :raise)) do
          type_key(new_value_chars[i]) do
            assert_exists(:force => true)
            element_object.value = new_value_chars[0..i].join('')
          end
        end
        sleep config.typing_interval
      end
    else
      with_key_down do # simulate at least one keypress
        assert_exists(:force => true)
        element_object.value = new_value_chars.join('')
      end
    end
    if options[:change] && exists?
      handling_existence_failure { fire_event("onChange") }
    end
    if options[:blur] && exists?
      handling_existence_failure { fire_event('onBlur') }
    end
    wait
    exists? ? self.value : nil
  end
end

#clear(options = {}) ⇒ Object

Clears the contents of the text field.

to be consistent with similar methods #set and #append, returns the new value, though this will always be a blank string.

takes options:

• :blur => true/false; whether or not to fire the onblur event when done.

• :highlight => true/false

Raises UnknownObjectException if the object can’t be found Raises ObjectDisabledException if the object is disabled Raises ObjectReadOnlyException if the object is read only

# File 'lib/vapir-common/elements/elements.rb', line 101

def clear(options={})
  options={:blur => true, :change => true, :select => true, :focus => true}.merge(options)
  assert_enabled
  assert_not_readonly
  with_highlight(options) do
    if options[:focus]
      assert_exists(:force => true)
      element_object.focus
      fire_event('onFocus')
    end
    if options[:select]
      assert_exists(:force => true)
      element_object.select
      fire_event("onSelect")
    end
    handling_existence_failure do
      with_key_down(:keyCode => KeyCodes[:delete]) do
        assert_exists(:force => true)
        element_object.value = ''
      end
    end
    if options[:change] && exists?
      fire_event("onChange")
    end
    if options[:blur] && exists?
      fire_event('onBlur')
    end
    exists? ? self.value : nil
  end
end

#set(value, options = {}) ⇒ Object

Sets the contents of the text field to the given value

returns the new value of the text field. this may be shorter than what is given if there is a maxlength on the field.

takes options:

• :blur => true/false; whether or not to file the onblur event when done.

• :highlight => true/false

Raises UnknownObjectException if the object cant be found Raises ObjectDisabledException if the object is disabled Raises ObjectReadOnlyException if the object is read only

# File 'lib/vapir-common/elements/elements.rb', line 241

def set(value, options={})
  with_highlight(options) do
    clear(options.merge(:blur => false, :change => false))
    append(value, options.merge(:focus => false, :select => false))
  end
end