operawatir 0.3-jruby → 0.3.2-jruby

data/lib/operawatir/quickwidgets/quick_dropdown.rb

@@ -0,0 +1,27 @@
+module OperaWatir
+  class QuickDropdown < QuickEditField #QuickWidget
+
+    # @private
+    # Checks the type of the widget is correct
+    def correct_type?
+      @element.getType == WIDGET_ENUM_MAP[:dropdown]
+    end
+    
+    ######################################################################
+    # Checks if the item selected in the dropdown matches the text loaded
+    # from Opera using the string_id
+    #
+    # @param [String] string_id String ID to use to load the string from the current
+    #                 language file (e.g. "D_NEW_PREFERENCES_GENERAL")
+    #
+    # @return [Boolean] true if the dropdown has the item with the 
+    #                   string_id selected, otherwise false
+    #
+    # @raise [Exceptions::UnknownObjectException] if the widget could not be found
+    #           using the specified method
+    def selected?(string_id)
+      element.isSelected(string_id)
+    end
+    
+  end
+end 

data/lib/operawatir/quickwidgets/quick_editfield.rb

@@ -0,0 +1,115 @@
+module OperaWatir
+  class QuickEditField < QuickWidget
+
+    # @private
+    # Checks the type of the widget is correct
+    def correct_type?
+      @element.getType == WIDGET_ENUM_MAP[:editfield]
+    end
+
+    ######################################################################
+    # Set focus to the edit field by clicking on it
+    #
+    # @raise [DesktopExceptions::WidgetNotVisibleException] if the editfield 
+    #            is not visible
+    #
+    def focus_with_click
+      super
+    end
+        
+    ######################################################################
+    # Types a text string into the edit field
+    #
+    # @note Only chanracters that appear on the keyboard that is currently
+    #       selected can be typed, and the edit field must have focus.
+    #
+    # @param [String] text text string to type in
+    # 
+    # @return [String] contents of the edit field after typing has completed
+    #
+    def type_text(text)
+      text.each_char { | t | key_press_direct t }
+      
+      # No event yet so just cheat and sleep
+      sleep(0.2);
+
+      # Return what is in the field to check
+      element(true).getText
+    end
+
+    ######################################################################
+    # Clears the contents of the edit field
+    #
+    # @note The edit field must have focus for this method to work
+    #
+    def clear
+      key_press_direct("a", :ctrl)
+      key_press_direct("backspace")
+      
+      # Cheat until we have an event
+      sleep(0.1)
+    end
+
+    ######################################################################
+    # Presses a key including modifiers
+    #
+    # @example
+    #   browser.quick_toolbar(:name, "Document Toolbar").quick_addressfield(:name, "tba_address_field").key_press("a", :ctrl)
+    #   browser.quick_toolbar(:name, "Document Toolbar").quick_addressfield(:name, "tba_address_field").key_press("c", :ctrl)
+    #
+    # @param [String]  key         key to press (e.g. "a" or "backspace")
+    # @param [Symbol]  modifiers   optional modifier(s) to hold down while pressing the key (e.g. :shift, :ctrl, :alt, :meta)
+    #
+    # @return [String] Text in the field after the keypress
+    #
+    # @note The edit field must have focus for this method to work
+    # @note WARNING: This method will not wait for page load or window
+    #       shown events. If you need to wait for these events do not
+    #       use this method
+    #
+    def key_press(key, *modifiers)
+      key_press_direct(key, *modifiers)
+      
+      # Cheat until we have an event
+      sleep(0.1)
+
+      # Return what is in the field to check
+      element(true).getText
+    end
+
+    private  
+    # @private
+    # Presses the key, and waits for loading to finish
+    def load_page_with_key_press(key, *modifiers)
+      wait_start
+      key_press_direct(key, *modifiers)
+      wait_for_window_loaded("")
+    end
+
+    # @private
+    # Enter some text and hit enter to do the action for the field
+    def enter_text_and_hit_enter(text)
+      loaded_url = ""
+      
+      # Set focus
+      focus_with_click
+      # Clear the field
+      clear()
+      # Type in the text
+      typed_text = type_text(text) #Opens dropdown window
+      # Check that some text was typed, note the text might be changed in the
+      # url field so it might be different
+      if typed_text.length > 0
+        # Hit Enter to load the typed in url
+        win_id = load_page_with_key_press("Enter")
+        # Check that the page actually loaded in a window
+        if win_id > 0
+          # Refresh the control and get the text after the page as loaded
+          loaded_url = element(true).getText
+        end
+      end
+      loaded_url
+    end
+
+  end
+end

data/lib/operawatir/quickwidgets/quick_label.rb

@@ -0,0 +1,12 @@
+module OperaWatir
+  class QuickLabel < QuickWidget
+
+    # @private
+    # Checks the type of the widget is correct
+    def correct_type?
+      @element.getType == WIDGET_ENUM_MAP[:label]
+    end
+    
+  end
+end
+

data/lib/operawatir/quickwidgets/quick_radiobutton.rb

@@ -0,0 +1,11 @@
+module OperaWatir
+  class QuickRadioButton < QuickCheckbox
+
+    # @private
+    # Checks the type of the widget is correct
+    def correct_type?
+      @element.getType == WIDGET_ENUM_MAP[:radiobutton]
+    end
+
+  end
+end

data/lib/operawatir/quickwidgets/quick_searchfield.rb

@@ -0,0 +1,25 @@
+module OperaWatir
+  class QuickSearchField < QuickEditField
+
+    # @private
+    # Checks the type of the widget is correct
+    def correct_type?
+      @element.getType == WIDGET_ENUM_MAP[:search]
+    end
+
+    ######################################################################
+    # Enters the search text into the search field, and waits for page 
+    # loading to finish
+    #
+    # @param [String] url   text to search with
+    #
+    # @return [String] text in the address field after the page is loaded
+    #                   or a blank string
+    #
+    def search_with_text(search_text)
+      # Enters text in a field and then hits enter
+      enter_text_and_hit_enter(search_text)
+    end
+    
+  end
+end

data/lib/operawatir/quickwidgets/quick_tab.rb

@@ -0,0 +1,66 @@
+module OperaWatir
+  class QuickTab < QuickButton
+ 
+    # @private
+    # Checks the type of the widget is correct
+    def correct_type?
+      @element.getType == WIDGET_ENUM_MAP[:tabbutton]
+    end
+    
+    ######################################################################
+    # Drag and drop this tab on tab tab_target
+    #
+    # @param [QuickTab] tab button to drop this tab on
+    #
+    #
+    # @raise [DesktopExceptions::UnknownObjectException] if the target is not a tab
+    #
+    def move_with_drag(tab_target)
+      raise(Exceptions::UnknownObjectException) unless tab_target.type == :tabbutton
+      drag_and_drop_on(tab_target, :center)
+      
+      sleep(0.1)
+    end
+    
+    ######################################################################
+    # Drag and drop this tab on another tab to add it to its tab group
+    #
+    # @param [QuickTab] tab (group) button to drop this tab on
+    #
+    # @raise [DesktopExceptions::UnknownObjectException] if the target is not a tab
+    #
+    # @return [int] the number of tabs in this tab group, or 1 if this is not a tab group button,
+    #               in which case it represents only 1 tab, itself
+    def group_with_drag(tab_target)
+      raise(Exceptions::UnknownObjectException) unless tab_target.type == :tabbutton
+      
+      # Drop on the edge of a tab to make the grouping work
+      drag_and_drop_on(tab_target, :edge)
+      
+      sleep(0.1)
+      
+      #Get the  number of tabs in the group
+      element(true).value
+    end
+    
+        
+    ######################################################################
+    # Clicks the tab button, and waits for the tab to be shown / switches to the page
+    #
+    # @param [String] win_name name of the window that will be opened (Pass a blank string for any window)
+    #
+    # @return [int] Window ID of the window activated, 
+    #               0 if the window is already the active one,
+    #               or if no window is active 
+    #
+    # @raise [DesktopExceptions::WidgetNotVisibleException] if the tab button
+    #            is not visible
+    #
+    def activate_tab_with_click
+      wait_start
+      click 
+      wait_for_window_activated("Document Window")
+    end
+
+  end
+end

data/lib/operawatir/quickwidgets/quick_thumbnail.rb

@@ -0,0 +1,26 @@
+module OperaWatir
+  class QuickThumbnail < QuickButton
+ 
+    # @private
+    # Checks the type of the widget is correct
+    def correct_type?
+      @element.getType == WIDGET_ENUM_MAP[:thumbnail]
+    end
+    
+    ######################################################################
+    # Drag and drop this speeddial
+    #
+    # @param [QuickThumbnail] Thumbnail to drop this thumbnail on
+    #
+    # @raise [DesktopExceptions::UnknownObjectException] if the target is not a thumbnail
+    #
+    #@private
+    def move_with_drag(tab_target)
+      raise(Exceptions::UnknownObjectException) unless tab_target.type == :thumbnail
+      drag_and_drop_on(tab_target, :center)
+      
+      sleep(0.1)
+    end
+    
+  end
+end

data/lib/operawatir/quickwidgets/quick_toolbar.rb

@@ -0,0 +1,11 @@
+module OperaWatir
+  class QuickToolbar < QuickWidget
+
+    # @private
+    # Checks the type of the widget is correct
+    def correct_type?
+      @element.getType == WIDGET_ENUM_MAP[:toolbar]
+    end
+    
+  end
+end

data/lib/operawatir/quickwidgets/quick_treeitem.rb

@@ -0,0 +1,157 @@
+module OperaWatir
+  class QuickTreeItem < QuickWidget
+
+    # @private
+    # Checks the type of the widget is correct
+    def correct_type?
+      @element.getType == WIDGET_ENUM_MAP[:treeitem]
+    end
+
+    ######################################################################
+    # Set focus to the tree item by clicking on it
+    #
+    # @raise [DesktopExceptions::WidgetNotVisibleException] if the treeview
+    #            the treeitem is in is not visible
+    #
+    def focus_with_click
+      # First scroll the item into view
+      scroll_item_into_view unless visible?
+      super
+    end
+        
+    ######################################################################
+    # Expands a tree item when it is clicked
+    #
+    # @raise [DesktopExceptions::WidgetNotVisibleException] if the treeitem 
+    #            is not visible
+    #
+    def expand_with_click
+      # For now there is no difference to focusing
+      focus_with_click
+    end
+
+    ######################################################################
+    # Expands a tree item when it is double clicked
+    #
+    # @raise [DesktopExceptions::WidgetNotVisibleException] if the treeitem 
+    #            is not visible
+    #
+    def expand_with_double_click
+      scroll_item_into_view unless visible?
+      double_click
+      # No event yet so just cheat and sleep
+      sleep(0.1);
+    end
+    
+    alias_method :collapse_with_double_click, :expand_with_double_click
+    
+    ######################################################################
+    # Presses a key including modifiers
+    #
+    # @example
+    #   browser.quick_treeview(:name, "Bookmarks View").quick_treeitem(:text, "Ask.com").key_press("Down")
+    #   browser.quick_treeview(:name, "Bookmarks View").quick_treeitem(:text, "Ask.com").key_press("Del")
+    #
+    # @param [String]  key         key to press (e.g. "a" or "backspace")
+    # @param [Symbol]  modifiers   optional modifier(s) to hold down while pressing the key (e.g. :shift, :ctrl, :alt, :meta)
+    #
+    # @return [String] Text in the field after the keypress
+    #
+    # @note The edit field must have focus for this method to work
+    # @note WARNING: This method will not wait for page load or window
+    #       shown events. If you need to wait for these events do not
+    #       use this method
+    #
+    def key_press(key, *opts)
+      key_press_direct(key, *opts)
+      sleep(0.1)
+    end
+        
+    ######################################################################
+    # Checks if the treeitem is selected
+    #
+    # @return [Boolean] true if the item is selected
+    #
+    # @raise [Exceptions::UnknownObjectException] if the widget could not be found
+    #           using the specified method
+    def selected?
+      element.isSelected
+    end
+     
+    
+    ######################################################################
+    # Switch to the tree view tab by clicking on it (e.g. on the 
+    # Advanced page of the preferences dialog) 
+    #
+    # @raise [DesktopExceptions::WidgetNotVisibleException] if the treeitem
+    #            is not visible
+    #
+    def activate_tab_with_click
+      click
+      
+      # No event yet so just cheat and sleep
+      sleep(0.1);
+    end
+    
+    ######################################################################
+    # Double clicks the tree item, and waits for the window with 
+    # window name win_name to be shown
+    #
+    # @param [String] win_name name of the window that will be opened (Pass a blank string for any window)
+    #
+    # @return [int] Window ID of the window shown or 0 if no window is shown
+    #
+    # @raise [DesktopExceptions::WidgetNotVisibleException] if the treeitem
+    #            is not visible
+    #
+    def open_window_with_double_click(win_name)
+      wait_start
+      click(:left, 2)
+      wait_for_window_shown(win_name)
+    end
+    
+    alias_method :open_dialog_with_double_click, :open_window_with_double_click
+    
+
+private
+    # @private
+    # Scrolls the item into view if required
+    def scroll_item_into_view
+      
+      # Make sure we have a window id
+      win_id = window_id >= 0 ? window_id : driver.getActiveWindowID()
+      
+      # Filter only treeitems in parent_treeview
+      treeitems = driver.getQuickWidgetList(win_id).select do |wdg|
+        wdg.getType == QuickWidget::WIDGET_ENUM_MAP[:treeitem] && wdg.getParentName == parent_name
+      end
+      
+      # Get the first visible item
+      lowest = treeitems.find { | item| item.visible? } #This will always be a parent item, not a child
+      # Assume list is ordered? => lower row means scroll up, higher row means scroll down
+      key = row < lowest.row ? "PageUp" : "PageDown"
+
+      #Select the first item on visible part of list, and select it
+      qw = QuickTreeItem.new(self,lowest)
+      qw.focus_with_click
+      key_press_direct(key)
+      
+      #First scroll
+      key_press_direct(key)
+      
+      visible_treeitems = driver.getQuickWidgetList(win_id).select do |wdg|
+        wdg.getType == QuickWidget::WIDGET_ENUM_MAP[:treeitem] && wdg.getParentName == parent_name && wdg.visible?
+      end
+
+      # Stop scrolling if we have run through the whole list, the item is then a child and won't get visible
+      max_times = treeitems.length / visible_treeitems.length + 1
+      until element(true).visible? || max_times < 0
+          key_press_direct(key) 
+          max_times-=1
+      end
+      
+    end
+  end
+  
+end
+