RobotJ HTMLImageFunctions

Last Updated:

Actions for working with HTMLImage objects


[How To Read This Reference]
ClickArea
RJ
Attempts to perform a Click on a mapped region of an Image (on a webpage).
SaveHTMLImage
RJ
Attempts to Save an HTMLImage on a webpage.
VerifyHTMLImage
RJ
Attempts to verify an HTMLImage on a webpage to a benchmark file.

RobotJ HTMLImageFunctions::ClickArea
RJ

Attempts to perform a Click on a mapped region of an Image (on a webpage).

RobotJ: The initial implementation actually does this in reverse. It expects that the specified object resolves to the HTML.AREA object defined in the HTML.MAP instead of simply specifying the Image and then an area. The RobotJ implementation then attempts to locate the Doc and Image that use the defined area and click on it.
No Field #5 parameter is used or needed in this implementation.

Future implementations should also\instead support the HTML.IMAGE object as the target and the area to click as a Field #5 parameter. The parameter would optionally define an App Map reference or could be used as a literal value. App Map references might appear as below: 

                Examples:

                [BrowserWin]
                AnImage=Type=HTMLFrame;HTMLID=top;Type=HTMLImage;Index=1
                ...                 
                [AnImage]
                ANamedRegion=AreaName=TechSupport
                AnIndexedRegion=AreaIndex=2
                AnotherRegion=AreaID=Contact


Fields: [ ]=Optional with Default Value
  1. [ AppMapSubkey = ]
    (FUTURE) Name of the AppMap subkey to lookup and use for the image area click.

    (FUTURE) Not used by RobotJ at this time.

    The AppMap could contain the item in any of the following formats: 

                    [AnImage]
                AMappdedRegion=Coords=10,10
                ANamedRegion=AreaName=TechSupport
                AnIndexedRegion=AreaIndex=2
                AnotherRegion=AreaID=Contact

    Both Fields #3 and #5 would be used to locate the item in the App Map. This routine does not specify an App Map so only the current Map would be used and it is expected to be valid.



Examples:
  • T, WebBrowser, ADefinedArea, ClickArea
    A single-click is performed on the the first Image using the defined HTML.AREA.


[How To Read This Reference]

RobotJ HTMLImageFunctions::SaveHTMLImage
RJ

Attempts to Save an HTMLImage on a webpage.

Attempts to perform a right click - save image/picture as command on the specified image.

You can also optionally specify an x,y offset into the image for the right click to occur.



Fields: [ ]=Optional with Default Value
  1. FileName
    Name of the image file.

    (Required) Name of the file to use for the image save-as command. This can be a full or relative path or a simple filename. A relative path will be stored relative to the Project's root directory. If a simple filename is provided it will be stored in the Project's Datapool\Test directory.



  2. [ Coords = 3,3 ]
    The explicit coordinates ("x,y"), or an App Map reference to pre-defined coordinates.

    We first check to see if the field contains a reference to an App Map item. If that cannot be found, we will assume the field contains explicit coordinates.

    We expect the coordinates in the format "x,y":

                    [MyImage]
                TopRight=50,10
                Center=25,25
                BottomRight=Coords=50,40

    The results from the lookup are appended to the "Coords=" string used by the Click command in Robot (if necessary).

    Both Fields #3(component name) and #6(coords reference name) are used to locate the item in the App Map. This routine does not specify an App Map so only the current Map is used and it is expected to be valid.

    If this parameter is not provided, we will use default coordinates of 3,3 for the right click.



Examples:
  • T, WebBrowser, myImage, SaveHTMLImage, ^filename=myImage.jpg
    Attempts to Save myImage on the webpage.

    Attempts to perform a right click at the default image coordinates, use the 'save as' menuitem on myImage. The image is stored as "myImage.jpg" in the project's Datapool\Test directory.



  • T WebBrowser myImage SaveHTMLImage ^filename=c:\images\myImage.jpg ^xy="25,25"
    Attempts to Save myImage on the webpage.

    Attempts to perform a right click at provided image coordinates, use the 'save as' menuitem on myImage. The image is stored as "myImage.jpg" in the c:\images directory.



  • T WebBrowser myImage SaveHTMLImage ^filename=images\myImage.jpg ^xy="Coords=25,25"
    Attempts to Save myImage on the webpage.

    Attempts to perform a right click at the provided image coordinates, use the 'save as' menuitem on myImage. The image is stored as "myImage.jpg" in the <project>\images directory.



  • T WebBrowser myImage SaveHTMLImage ^filename=images\myImage.jpg ^xy="TopRight"
    Attempts to Save myImage on the webpage.

    Attempts to perform a right click at "TopRight" coordinates defined in the app map, Uses the 'save as' menuitem on the myImage popup menu. The image is stored as "myImage.jpg" in the <project>\images directory.



[How To Read This Reference]

RobotJ HTMLImageFunctions::VerifyHTMLImage
RJ

Attempts to verify an HTMLImage on a webpage to a benchmark file.

Attempts to perform a right click - save image/picture as command on the specified image and then run a binary file compare of the file to a benchmark file.

You can also optionally specify an x,y offset into the image for the right click to occur.

The command may produce a WARNING if a diff tool for which we have no means to verify the results is configured for use. Consequently, if these warnings are expected, the user can use the "TW" test record type to avoid issuing these warnings.



Fields: [ ]=Optional with Default Value
  1. BenchmarkFile
    Name of the Benchmark image file.

    (REQUIRED) Name of the file to use for the image save-as command and the benchmark file. This can also be a full or relative path suitable for FindSQAFile. If no full path or relative path is given then the benchmark file is expected to be found in the project's Datapool\Bench directory.

    The captured image will be stored in the project's Datapool\Test project's Datapool/Test directory. Any comparison difference will be stored in the project's Datapool\Dif directory.



  2. [ Coords = 3,3 ]
    The explicit coordinates ("x,y") or an App Map reference to pre-defined coordinates.

    We first check to see if the field contains a reference to an App Map item. If that cannot be found, we will assume the field contains explicit coordinates.

    We expect the coordinates in the format "x,y":

                    [MyImage]
                TopLeft=10,10
                Center=Coords=25,25

    The results from the lookup are appended to the "Coords=" string used by the Click command in Robot (if necessary).

    Both Fields #3(component name) and #6(coords reference name) are used to locate the item in the App Map. This routine does not specify an App Map so only the current Map is used and it is expected to be valid.

    If this parameter is not provided, we will use default coordinates of 3,3 for the right click.



Examples:
  • T, WebBrowser, myImage, VerifHTMLImage, ^bench=myImage.jpg
    Attempts to verify myImage on the webpage to the benchmark file myImage.jpg.

    Attempts to perform a right click at the default image coordinates, use the 'save as' menuitem on myImage, and then run a binary file compare of the file to a benchmark file myImage.jpg.



  • T, WebBrowser, myImage, VerifHTMLImage, ^bench=myImage.jpg, ^rightclick="Coords=15,15"
    Attempts to verify myImage on the webpage to the benchmark file myImage.jpg.

    Attempts to perform a right click at the provided image coordinates, use the 'save as' menuitem on myImage, then run a binary file compare of the file to a benchmark file myImage.jpg.



  • T, WebBrowser, myImage, VerifHTMLImage, ^bench=myImage.jpg, ^rightclick=TopLeft
    Attempts to verify myImage on the webpage to the benchmark file myImage.jpg.

    Attempts to perform a right click at the image coordinates found in the provided App Map key "TopLeft" under [MyImage]. It will then use the 'save as' menuitem on myImage, then run a binary file compare of the file to a benchmark file myImage.jpg.



[How To Read This Reference]