firewatir 1.1.1

data/container.rb

@@ -0,0 +1,889 @@
+=begin
+    #
+    # This module contains the factory methods that are used to access most html objects
+    #
+    # For example, to access a button on a web page that has the following html
+    #  <input type = button name= 'b1' value='Click Me' onClick='javascript:doSomething()'>
+    #
+    # the following Firewatir code could be used
+    #
+    #  ff.button(:name, 'b1').click
+    #
+    # or
+    #
+    #  ff.button(:value, 'Click Me').to_s
+    # 
+    # One can use any attribute to uniquely identify an element including the user defined attributes
+    # that is rendered on the HTML screen. Though, Attribute used to access an element depends on the type of element,
+    # attributes used frequently to address an element are listed below
+    #
+    #    :index      - find the item using the index in the container ( a container can be a document, 
+    #    		a TableCell, a Span, a Div or a P)
+    #                  index is 1 based
+    #    :name       - find the item using the name attribute
+    #    :id         - find the item using the id attribute
+    #    :value      - find the item using the value attribute
+    #    :caption    - same as value
+    #    :xpath      - finds the item using xpath query
+    #
+    # Typical Usage
+    #
+    #    ff.button(:id,    'b_1')                       # access the button with an ID of b_1
+    #    ff.button(:name,  'verify_data')               # access the button with a name of verify_data
+    #    ff.button(:value, 'Login')                     # access the button with a value (the text displayed on the button) of Login
+    #    ff.button(:caption, 'Login')                   # same as above
+    #    ff.button(:value, /Log/)                       # access the button that has text matching /Log/
+    #    ff.button(:index, 2)                           # access the second button on the page ( 1 based, so the first button is accessed with :index,1)
+    #
+=end
+
+require 'firewatir/exceptions'
+    
+module Container 
+    include FireWatir::Exception
+
+    # IP Address of the machine where the script is to be executed. Default to localhost.
+    MACHINE_IP = "127.0.0.1"
+    # Name of the variable with which window is identified in JSSh.
+    WINDOW_VAR = "window"
+    # Name of the variable with which browser is identified in JSSh.
+    BROWSER_VAR = "browser"
+    # Name of the variable with which document is identified in JSSh.
+    DOCUMENT_VAR = "document"
+    # Name of the variable with which body is identified in JSSh.
+    BODY_VAR    = "body"
+
+        
+    # The delay when entering text on a web page when speed = :slow.
+    DEFAULT_TYPING_SPEED = 0.01
+
+    # The default time we wait after a page has loaded when speed = :slow.
+    DEFAULT_SLEEP_TIME = 0.1
+
+    # The default color for highlighting objects as they are accessed.
+    DEFAULT_HIGHLIGHT_COLOR = "yellow"
+                    
+    public
+    #
+    # Description:
+    #    Used to access a frame element. Usually an <frame> or <iframe> HTML tag.
+    #
+    # Input:
+    #   - how - The attribute used to identify the framet.
+    #   - what - The value of that attribute. 
+    #   If only one parameter is supplied, "how" is by default taken as name and the 
+    #   parameter supplied becomes the value of the name attribute.
+    #
+    # Typical usage:
+    #
+    #   ff.frame(:index, 1) 
+    #   ff.frame(:name , 'main_frame')
+    #   ff.frame('main_frame')        # in this case, just a name is supplied.
+    #
+    # Output:
+    #   Frame object.
+    #
+    def frame(how, what = nil)
+        locate if defined?(locate)
+        if(what == nil)
+            what = how
+            how = :name
+        end
+        Frame.new(self, how, what)
+    end
+
+    #
+    # Description:
+    #   Used to access a form element. Usually an <form> HTML tag.
+    #
+    # Input:
+    #   - how - The attribute used to identify the form.
+    #   - what - The value of that attribute. 
+    #   If only one parameter is supplied, "how" is by default taken as name and the 
+    #   parameter supplied becomes the value of the name attribute.
+    #
+    # Typical usage:
+    #
+    #   ff.form(:index, 1) 
+    #   ff.form(:name , 'main_form')
+    #   ff.form('main_form')        # in this case, just a name is supplied.
+    #
+    # Output:
+    #   Form object.
+    #
+    def form(how, what=nil)   
+        locate if defined?(locate)
+       if(what == nil)
+            what = how
+            how = :name
+        end    
+        Form.new(self, how, what)
+    end
+    
+    #
+    # Description:
+    #   Used to access a table. Usually an <table> HTML tag. 
+    #
+    # Input:
+    #   - how - The attribute used to identify the table.
+    #   - what - The value of that attribute. 
+    #
+    # Typical usage:
+    #
+    #   ff.table(:index, 1) #index starts from 1.
+    #   ff.table(:id, 'main_table')
+    #
+    # Output:
+    #   Table object.
+    #
+    def table(how, what)
+        locate if defined?(locate)
+        Table.new(self, how, what)
+    end
+
+    #
+    # Description:
+    #   Gets the tables iterator. It returns a Tables object 
+    #
+    # Typical usage:
+    #
+    #   ff.tables.each { |t| puts t.to_s }            # iterate through all the tables on the page
+    #   ff.tables[1].to_s                             # goto the first table on the page                                   
+    #   ff.tables.length                              # show how many tables are on the page. Tables that are nested will be included in this
+    #
+    def tables
+        locate if defined?(locate)
+        return Tables.new(self)
+    end
+    
+    #
+    # Description:
+    #   Used to access a table cell. Usually an <td> HTML tag. 
+    #
+    # Input:
+    #   - how - The attribute used to identify the cell.
+    #   - what - The value of that attribute. 
+    # 
+    # Typical Usage:
+    #   ff.cell(:id, 'tb_cell')
+    #   ff.cell(:index, 1)
+    #
+    # Output:
+    #    TableCell Object
+    #
+    def cell(how, what=nil)
+        locate if defined?(locate)
+        TableCell.new(self, how, what)
+    end
+
+    # 
+    # Description:
+    #   Used to access a table row. Usually an <tr> HTML tag. 
+    # 
+    # Input:
+    #   - how - The attribute used to identify the row.
+    #   - what - The value of that attribute. 
+    #
+    # Typical Usage:
+    #   ff.row(:id, 'tb_row')
+    #   ff.row(:index, 1)
+    #
+    # Output: 
+    #   TableRow object
+    #
+    def row(how, what=nil)
+        locate if defined?(locate)
+        TableRow.new(self, how, what)
+    end
+    
+    # 
+    # Description:
+    #   Used to access a button element. Usually an <input type = "button"> HTML tag.
+    # 
+    # Input:
+    #   - how - The attribute used to identify the row.
+    #   - what - The value of that attribute. 
+    # 
+    # Typical Usage:
+    #    ff.button(:id,    'b_1')                       # access the button with an ID of b_1
+    #    ff.button(:name,  'verify_data')               # access the button with a name of verify_data
+    #
+    #    if only a single parameter is supplied,  then :value is used as 'how' and parameter supplied is used as what. 
+    #
+    #    ff.button('Click Me')                          # access the button with a value of Click Me
+    #
+    # Output:
+    #   Button element.
+    #
+    def button(how, what = nil)
+        locate if defined?(locate)
+        if(what == nil)
+            what = how
+            how = :value
+        end    
+        Button.new(self, how, what)
+    end    
+
+    # 
+    # Description:
+    #   Used for accessing all the buttons on the page. Returns a Buttons object
+    #
+    # Typical usage:
+    #
+    #   ff.buttons.each { |b| puts b.to_s }            # iterate through all the buttons on the page
+    #   ff.buttons.length                              # show how many buttons are on the page. 
+    # 
+    # Output:
+    #   Buttons object.
+    #
+    def buttons
+        locate if defined?(locate)
+        return Buttons.new(self)
+    end
+
+    # 
+    # Description:
+    #   Used for accessing a file field. Usually an <input type = file> HTML tag.  
+    #  
+    # Input:
+    #   - how - Attribute used to identify the file field element
+    #   - what - Value of that attribute. 
+    #
+    # Typical Usage:
+    #    ff.file_field(:id,   'up_1')                     # access the file upload fff.d with an ID of up_1
+    #    ff.file_field(:name, 'upload')                   # access the file upload fff.d with a name of upload
+    #
+    # Output:
+    #   FileField object
+    #
+    def file_field(how, what = nil)
+        locate if defined?(locate)
+        FileField.new(self, how, what)
+    end    
+    
+    # 
+    # Description:
+    #   Used for accessing all the file field elements on the page. Returns a FileFields object
+    #
+    # Typical usage:
+    #
+    #   ff.file_fields.each { |f| puts f.to_s }            # iterate through all the file fields on the page
+    #   ff.file_fields[1].to_s                             # goto the first file field on the page                                   
+    #   ff.file_fields.length                              # show how many file fields are on the page. 
+    # 
+    # Output:
+    #   FileFields object
+    #
+    def file_fields
+        locate if defined?(locate)
+        return FileFields.new(self)
+    end
+
+    #
+    # Description:
+    #   Used for accessing a text field. Usually an <input type = text> HTML tag. or a text area - a  <textarea> tag
+    #
+    # Input:
+    #   - how - Attribute used to identify the text field element.
+    #   - what - Value of that attribute. 
+    #
+    # Typical Usage:
+    #
+    #    ff.text_field(:id,   'user_name')                 # access the text field with an ID of user_name
+    #    ff.text_field(:name, 'address')                   # access the text field with a name of address
+    #
+    # Output:
+    #   TextField object.
+    #
+    def text_field(how, what = nil)
+        locate if defined?(locate)
+        TextField.new(self, how, what)
+    end    
+
+    # 
+    # Description:
+    #   Used for accessing all the text fields on the page. Returns a TextFields object
+    #
+    # Typical usage:
+    #
+    #   ff.text_fields.each { |t| puts t.to_s }            # iterate through all the text fields on the page
+    #   ff.text_fields[1].to_s                             # goto the first text fields on the page                                   
+    #   ff.text_fields.length                              # show how many text fields are on the page.
+    #
+    # Output:
+    #   TextFields object.
+    #
+    def text_fields
+        locate if defined?(locate)
+        return TextFields.new(self)
+    end
+
+    # 
+    # Description:
+    #   Used to access hidden field element. Usually an <input type = hidden> HTML tag
+    #
+    # Input:
+    #   - how - Attribute used to identify the hidden element.
+    #   - what - Value of that attribute. 
+    #
+    # Typical Usage:
+    #
+    #    ff.hidden(:id,   'user_name')                 # access the hidden element with an ID of user_name
+    #    ff.hidden(:name, 'address')                   # access the hidden element with a name of address
+    #
+    # Output:
+    #   Hidden object.
+    #
+    def hidden(how, what)
+        locate if defined?(locate)
+        return Hidden.new(self, how, what)
+    end
+
+    # 
+    # Description:
+    #   Used for accessing all the hidden fields on the page. Returns a Hiddens object
+    #
+    # Typical usage:
+    #
+    #   ff.hiddens.each { |t|  puts t.to_s }           # iterate through all the hidden fields on the page
+    #   ff.hiddens[1].to_s                             # goto the first hidden fields on the page                                   
+    #   ff.hiddens.length                              # show how many hidden fields are on the page.
+    # 
+    # Output:
+    #   Hiddens object.
+    #
+    def hiddens
+        locate if defined?(locate)
+        return Hiddens.new(self)
+    end
+
+    #
+    # Description:
+    #   Used to access select list element. Usually an <select> HTML tag.
+    #
+    # Input:
+    #   - how - Attribute used to identify the select element.
+    #   - what - Value of that attribute. 
+    #
+    # Typical Usage:
+    #
+    #    ff.select_list(:id,   'user_name')                 # access the select list with an ID of user_name
+    #    ff.select_list(:name, 'address')                   # access the select list with a name of address
+    #
+    # Output:
+    #   Select List object.
+    #
+    def select_list(how, what) 
+        locate if defined?(locate)
+        return SelectList.new(self, how, what)
+    end
+
+    # 
+    # Description:
+    #   Used for accessing all the Listbox or dropdown elements on the page. Returns a SelectLists object
+    #
+    # Typical usage:
+    #
+    #   ff.select_lists.each { |s| puts s.to_s }            # iterate through all the select boxes on the page
+    #   ff.select_lists[1].to_s                             # goto the first select boxes on the page                                   
+    #   ff.select_lists.length                              # show how many select boxes are on the page.
+    # 
+    # Output:
+    #   SelectLists object.
+    #
+    def select_lists
+        locate if defined?(locate)
+        return SelectLists.new(self)
+    end
+    
+    #
+    # Description:
+    #   Used to access checkbox element. Usually an <input type = checkbox> HTML tag.
+    #
+    # Input:
+    #   - how - Attribute used to identify the check box element.
+    #   - what - Value of that attribute. 
+    #
+    # Typical Usage:
+    #
+    #   ff.checkbox(:id,   'user_name')                 # access the checkbox element with an ID of user_name
+    #   ff.checkbox(:name, 'address')                   # access the checkbox element with a name of address
+    #   In many instances, checkboxes on an html page have the same name, but are identified by different values. An example is shown next.
+    #
+    #   <input type = checkbox name = email_frequency value = 'daily' > Daily Email
+    #   <input type = checkbox name = email_frequency value = 'Weekly'> Weekly Email
+    #   <input type = checkbox name = email_frequency value = 'monthly'>Monthly Email
+    #
+    #   FireWatir can access these using the following:
+    #
+    #   ff.checkbox(:id, 'day_to_send' , 'monday' )         # access the check box with an id of day_to_send and a value of monday
+    #   ff.checkbox(:name ,'email_frequency', 'weekly')     # access the check box with a name of email_frequency and a value of 'weekly'
+    #
+    # Output:
+    #   Checkbox object.
+    #
+    def checkbox(how, what, value = nil) 
+        locate if defined?(locate)
+        return CheckBox.new(self, how, what, ["checkbox"], value) 
+    end
+
+    # 
+    # Description:
+    #   Used for accessing all the Checkbox elements on the page. Returns a CheckBoxes object
+    #
+    # Typical usage:
+    #
+    #   ff.checkboxes.each { |c| puts c.to_s }           # iterate through all the check boxes on the page
+    #   ff.checkboxes[1].to_s                             # goto the first check box on the page                                   
+    #   ff.checkboxes.length                              # show how many check boxes are on the page.
+    # 
+    # Output:
+    #   CheckBoxes object.
+    def checkboxes
+        locate if defined?(locate)
+        return CheckBoxes.new(self)
+    end
+
+    
+    #
+    # Description:
+    #   Used to access radio button element. Usually an <input type = radio> HTML tag.
+    #
+    # Input:
+    #   - how - Attribute used to identify the radio button element.
+    #   - what - Value of that attribute. 
+    #
+    # Typical Usage:
+    #
+    #   ff.radio(:id,   'user_name')                 # access the radio button element with an ID of user_name
+    #   ff.radio(:name, 'address')                   # access the radio button element with a name of address
+    #   In many instances, radio buttons on an html page have the same name, but are identified by different values. An example is shown next.
+    #
+    #   <input type = radio name = email_frequency value = 'daily' > Daily Email
+    #   <input type = radio name = email_frequency value = 'Weekly'> Weekly Email
+    #   <input type = radio name = email_frequency value = 'monthly'>Monthly Email
+    #
+    #   FireWatir can access these using the following:
+    #
+    #   ff.radio(:id, 'day_to_send' , 'monday' )         # access the radio button with an id of day_to_send and a value of monday
+    #   ff.radio(:name ,'email_frequency', 'weekly')     # access the radio button with a name of email_frequency and a value of 'weekly'
+    #
+    # Output:
+    #   Radio button object.
+    #
+    def radio(how, what, value = nil) 
+        locate if defined?(locate)
+        return Radio.new(self, how, what, ["radio"], value) 
+    end
+
+    # 
+    # Description:
+    #   Used for accessing all the Radiobutton elements on the page. Returns a Radios object
+    #
+    # Typical usage:
+    #
+    #   ff.radios.each { |r| puts r.to_s }            # iterate through all the radio buttons on the page
+    #   ff.radios[1].to_s                             # goto the first radio button on the page                                   
+    #   ff.radios.length                              # show how many radio buttons are on the page.
+    # 
+    # Output:
+    #   Radios object.
+    #
+    def radios
+        locate if defined?(locate)
+        return Radios.new(self)
+    end
+    
+    #
+    # Description:
+    #   Used to access link element. Usually an <a> HTML tag.
+    #
+    # Input:
+    #   - how - Attribute used to identify the link element.
+    #   - what - Value of that attribute. 
+    #
+    # Typical Usage:
+    #
+    #    ff.link(:id,   'user_name')                 # access the link element with an ID of user_name
+    #    ff.link(:name, 'address')                   # access the link element with a name of address
+    #
+    # Output:
+    #   Link object.
+    #
+    def link(how, what) 
+        locate if defined?(locate)
+        return Link.new(self, how, what)
+    end
+
+    # 
+    # Description:
+    #   Used for accessing all the Link elements on the page. Returns a Links object
+    #
+    # Typical usage:
+    #
+    #   ff.links.each { |l| puts l.to_s }            # iterate through all the links on the page
+    #   ff.links[1].to_s                             # goto the first link on the page                                   
+    #   ff.links.length                              # show how many links are on the page.
+    #
+    # Output:
+    #   Links Object
+    #
+    def links
+        locate if defined?(locate)
+        return Links.new(self)
+    end
+
+    #
+    # Description:
+    #   Used to access image element. Usually an <img> HTML tag.
+    #
+    # Input:
+    #   - how - Attribute used to identify the image element.
+    #   - what - Value of that attribute. 
+    #
+    # Typical Usage:
+    #
+    #    ff.image(:id,   'user_name')                 # access the image element with an ID of user_name
+    #    ff.image(:name, 'address')                   # access the image element with a name of address
+    #
+    # Output:
+    #   Image object.
+    #
+    def image(how, what = nil)
+        locate if defined?(locate)
+        Image.new(self, how, what)
+    end    
+    
+    # 
+    # Description:
+    #   Used for accessing all the Image elements on the page. Returns a Images object
+    #
+    # Typical usage:
+    #
+    #   ff.images.each { |i| puts i.to_s }            # iterate through all the images on the page
+    #   ff.images[1].to_s                             # goto the first image on the page                                   
+    #   ff.images.length                              # show how many images are on the page.
+    #
+    # Output:
+    #   Images object.
+    #
+    def images
+        locate if defined?(locate)
+        return Images.new(self)
+    end
+
+    # This is the main method for accessing JavaScript popups.
+    # returns a PopUp object
+    #def popup         # BUG this should not be on the container object!        
+    #    return PopUp.new(self)
+    #end
+
+    #
+    # Description:
+    #   Used to access div element. Usually an <div> HTML tag.
+    #
+    # Input:
+    #   - how - Attribute used to identify the dive element.
+    #   - what - Value of that attribute. 
+    #
+    # Typical Usage:
+    #
+    #    ff.div(:id,   'user_name')                 # access the div element with an ID of user_name
+    #    ff.div(:name, 'address')                   # access the div element with a name of address
+    #
+    # Output:
+    #   Div object.
+    #
+    def div(how, what)
+        locate if defined?(locate)
+        return Div.new(self, how, what)
+    end
+
+    # 
+    # Description:
+    #   Used for accessing all the Div elements on the page. Returns a Divs object
+    #
+    # Typical usage:
+    #
+    #   ff.divs.each { |d| puts d.to_s }            # iterate through all the divs on the page
+    #   ff.divs[1].to_s                             # goto the first div on the page                                   
+    #   ff.divs.length                              # show how many divs are on the page.
+    #
+    # Output:
+    #   Divs object.
+    #
+    def divs
+        locate if defined?(locate)
+        return Divs.new(self)
+    end
+
+    
+    #
+    # Description:
+    #   Used to access a span. Usually an <span> HTML tag. 
+    #
+    # Input:
+    #   - how - The attribute used to identify the span.
+    #   - what - The value of that attribute. 
+    # 
+    # Typical usage:
+    #   ff.span(:id, /list/)                 # access the first span that matches list.
+    #   ff.span(:index,2)                    # access the second span on the page
+    #   ff.span(:title , "A Picture")        # access a span using the tooltip text.
+    #
+    # Output:
+    #    Span Object
+    #   
+    def span(how, what)
+        locate if defined?(locate)
+        return Span.new(self, how, what)
+    end
+
+    # 
+    # Description:
+    #   Used for accessing all the Span elements on the page. Returns a Spans object
+    #
+    # Typical usage:
+    #
+    #   ff.spans.each { |s| puts s.to_s }            # iterate through all the spans on the page
+    #   ff.spans[1].to_s                             # goto the first span on the page                                   
+    #   ff.spans.length                              # show how many spans are on the page.
+    #
+    # Output:
+    #   Spans object.
+    #
+    def spans
+        locate if defined?(locate)
+        return Spans.new(self)
+    end
+
+    
+    #
+    # Description:
+    #   Used to access a paragraph. Usually an <p> HTML tag. For more details on this visit 
+    # 	See http://www.xulplanet.com/references/objref/HTMLParagraphElement.html.
+    #
+    # Input:
+    #   - how - The attribute used to identify the paragraph.
+    #   - what - The value of that attribute. 
+    # 
+    # Typical Usage
+    # 
+    #   ff.p(:id, /list/)                 # access the first p tag  that matches list.
+    #   ff.p(:index,2)                    # access the second p tag on the page
+    #   ff.p(:title , "A Picture")        # access a p tag using the tooltip text.
+    #
+    # Output:
+    # 	Paragraph object.
+    #
+    def p(how, what)
+        locate if defined?(locate)
+        return P.new(self, how, what)
+    end
+
+    # 
+    # Description:
+    #   Used for accessing all the Paragraph <p> elements on the page. Returns a Ps object
+    #
+    # Typical usage:
+    #
+    #   ff.ps.each { |p| puts p.to_s }            # iterate through all the p tags on the page
+    #   ff.ps[1].to_s                             # goto the first p tag on the page                                   
+    #   ff.ps.length                              # show how many p tags are on the page.
+    #
+    # Output:
+    #   Ps object
+    #
+    def ps
+        locate if defined?(locate)
+        return Ps.new(self)
+    end
+
+    #
+    # Description:
+    #   Used to access a pre element. Usually a <pre> HTML tag. For more details on this element 
+    #   visit http://www.xulplanet.com/references/objref/HTMLPreElement.html.
+    #
+    # Input:
+    #   - how - The attribute used to identify the pre tag.
+    #   - what - The value of that attribute. 
+    # 
+    # Typical Usage
+    # 
+    #   ff.pre(:id, /list/)                 # access the first pre tag  that matches list.
+    #   ff.pre(:index,2)                    # access the second pre tag on the page
+    #
+    # Output:
+    # 	Pre object.
+    #
+    def pre(how, what)
+        locate if defined?(locate)
+        return Pre.new(self, how, what)
+    end
+
+    # 
+    # Description:
+    #   Used for accessing all the Pre elements on the page. Returns a Pres object
+    #
+    # Typical usage:
+    #
+    #   ff.pres.each { |pre| puts pre.to_s }        # iterate through all the pre tags on the page
+    #   ff.pres[1].to_s                             # goto the first pre tag on the page                                   
+    #   ff.pres.length                              # show how many pre tags are on the page.
+    #  
+    # Output:
+    #   Pres object
+    #
+    def pres
+        locate if defined?(locate)
+        return Pres.new(self)
+    end
+	
+    #
+    # Description:
+    # 	Used to access label. Usually a <label> HTML tag. For more information on this 
+    # 	tag visit http://www.xulplanet.com/references/objref/HTMLLabelElement.html.
+    #
+    # Inputs:	
+    #   - how - The attribute used to identify the label.
+    #   - what - The value of that attribute. 
+    # 
+    # Typical Usage:
+    #   ff.label(:id, /list/)                # access the first label that matches list.
+    #   ff.label(:index,2)                   # access the second label on the page
+    #   ff.label(:for, "txt_1")              # access a the label that is associated with the object that has an id of txt_1
+    #
+    # Output:
+    #	Label object
+    #
+    def label(how, what)
+        locate if defined?(locate)
+        return Label.new(self, how, what)
+    end
+
+    # 
+    # Description:
+    #   Used for accessing all the Label elements on the page. Returns a Labels object
+    #
+    # Typical usage:
+    #
+    #   ff.labels.each { |l| puts l.to_s }            # iterate through all the labels on the page
+    #   ff.labels[1].to_s                             # goto the first label on the page                                   
+    #   ff.labels.length                              # show how many labels are on the page.
+    #
+    # Output:
+    #   Labels object
+    #
+    def labels
+        locate if defined?(locate)
+        return Labels.new(self)
+    end
+
+    # Description:
+    #	Searching for Page Elements. Not for external consumption.
+    #        
+    # def ole_inner_elements
+        # return document.body.all 
+    # end
+    # private :ole_inner_elements
+    
+	
+	# 
+	# Description:
+	#   This method shows the available objects on the current page.
+	#   This is usually only used for debugging or writing new test scripts.
+	#   This is a nice feature to help find out what HTML objects are on a page
+    #   when developing a test case using FireWatir.
+    #
+    # Typical Usage:
+    #   ff.show_all_objects
+    #
+    # Output:
+    #   Prints all the available elements on the page.
+    #
+	def show_all_objects
+        puts "-----------Objects in the current context-------------" 
+        locate if defined?(locate)
+        elements = Document.new(self).all
+        puts elements.length
+        elements.each  do |n|
+            puts n.tagName
+            puts n.to_s
+            puts "------------------------------------------" 
+        end
+        puts "Total number of objects in the current context :	#{elements.length}"
+        return elements
+        # Test the index access. 
+        # puts doc[35].to_s
+	end
+       
+    #
+    # Description:
+    #  Reads the javascript execution result from the jssh socket. 
+    #
+    # Input:
+    # 	- socket - It is the jssh socket, the  only point of communication between the browser and firewatir scripts.
+    # 
+    # Output:	
+    #	The javascript execution result as string.	
+    #
+    def read_socket(socket = $jssh_socket)
+        return_value = "" 
+        data = ""
+        #puts Thread.list
+        s = nil
+        while(s == nil) do
+            s = Kernel.select([socket] , nil , nil, 1)
+        end
+        #if(s != nil)
+        for stream in s[0]
+            data = stream.recv(1024)
+            #puts "data is : #{data}"
+            while(data[data.length - 3..data.length - 1] != "\n> ")
+                return_value += data
+                data = stream.recv(1024)
+                #puts "data length is : #{data.length}"
+            end
+        end
+        
+        # If received data is less than 1024 characters or for last data 
+        # we read in the above loop 
+        return_value += data
+
+        # Get the command prompt inserted by JSSH
+        #s = Kernel.select([socket] , nil , nil, 0.3)
+            
+        #if(s != nil)
+        #    for stream in s[0]
+        #        return_value += socket.recv(1024)
+        #    end
+        #end
+    
+        length = return_value.length 
+        #puts "Return value before removing command prompt is : #{return_value}"
+        
+        #Remove the command prompt. Every result returned by JSSH has "\n> " at the end.
+        if length <= 3 
+            return_value = ""
+        elsif(return_value[0..2] == "\n> ")    
+            return_value = return_value[3..length-1]
+        else    
+            #return_value = return_value[0..length-3]
+            return_value = return_value[0..length-4]
+        end 
+        #puts "Return value after removing command prompt is : #{return_value}"
+        #socket.flush
+        
+        # make sure that command prompt doesn't get there.
+        if(return_value[return_value.length - 3..return_value.length - 1] == "\n> ")
+            return_value = return_value[0..return_value.length - 4]
+        end    
+        if(return_value[0..2] == "\n> ")
+            return_value = return_value[3..return_value.length - 1]
+        end   
+        #puts "return value is : #{return_value}"
+        return return_value
+    end
+
+end # module 
+