module Watir

  # Forms
  
  module FormAccess
    def name
      @ole_object.getAttributeNode('name').value
    end
    def action
      @ole_object.action
    end
    def method
      @ole_object.invoke('method')
    end
    def id
      @ole_object.invoke('id')
    end
  end
  
  # wraps around a form OLE object
  class FormWrapper
    include FormAccess
    def initialize(ole_object)
      @ole_object = ole_object
    end
  end
  
  #   Form Factory object
  class Form < Element
    include FormAccess
    include Container
    
    attr_accessor :form
    
    #   * container   - the containing object, normally an instance of IE
    #   * how         - symbol - how we access the form (:name, :id, :index, :action, :method)
    #   * what        - what we use to access the form
    def initialize(container, how, what)
      set_container container
      @how = how
      @what = what
      
      log "Get form how is #{@how}  what is #{@what} "
      
      # Get form using xpath.
      if @how == :xpath
        @ole_object = @container.element_by_xpath(@what)
      else
        count = 1
        doc = @container.document
        doc.forms.each do |thisForm|
          next unless @ole_object == nil
          
          wrapped = FormWrapper.new(thisForm)
          
          log "form on page, name is " + wrapped.name
          
          @ole_object =
          case @how
          when :name, :id, :method, :action
            @what.matches(wrapped.send(@how)) ? thisForm : nil
          when :index
            count == @what ? thisForm : nil
          else
            raise MissingWayOfFindingObjectException, "#{how} is an unknown way of finding a form (#{what})"
          end
          count = count +1
        end
      end
      super(@ole_object)
      
      copy_test_config container
    end
    
    def exists?
      @ole_object ? true : false
    end
    alias :exist? :exists?
    
    # Submit the data -- equivalent to pressing Enter or Return to submit a form.
    def submit # XXX use assert_exists
      raise UnknownFormException, "Unable to locate a form using #{@how} and #{@what} " if @ole_object == nil
      @ole_object.submit
      @container.wait
    end
    
    def ole_inner_elements # XXX use assert_exists
      raise UnknownFormException, "Unable to locate a form using #{@how} and #{@what} " if @ole_object == nil
      @ole_object.elements
    end
    private :ole_inner_elements
    
    def document
      return @ole_object
    end
    
    def wait(no_sleep=false)
      @container.wait(no_sleep)
    end
    
    # This method is responsible for setting and clearing the colored highlighting on the specified form.
    # use :set  to set the highlight
    #   :clear  to clear the highlight
    def highlight(set_or_clear, element, count)
      
      if set_or_clear == :set
        begin
          original_color = element.style.backgroundColor
          original_color = "" if original_color==nil
          element.style.backgroundColor = activeObjectHighLightColor
        rescue => e
          puts e
          puts e.backtrace.join("\n")
          original_color = ""
        end
        @original_styles[count] = original_color
      else
        begin
          element.style.backgroundColor = @original_styles[ count]
        rescue => e
          puts e
          # we could be here for a number of reasons...
        ensure
        end
      end
    end
    private :highlight
    
    # causes the object to flash. Normally used in IRB when creating scripts
    # Default is 10
    def flash number=10
      @original_styles = {}
      number.times do
        count = 0
        @ole_object.elements.each do |element|
          highlight(:set, element, count)
          count += 1
        end
        sleep 0.05
        count = 0
        @ole_object.elements.each do |element|
          highlight(:clear, element, count)
          count += 1
        end
        sleep 0.05
      end
    end
    
  end # class Form
  
end