Object Model Reference for GUI Testing > SAPUI5 > Click Method

SAPUIFacetFilter Object

Description

An SAPUI5 facet filter control.

IMPORTANT

Operations

The sections below list the built-in methods and properties that you can use as operations for the SAPUIFacetFilter object.

Note: You can also view a list and descriptions of the SAPUIFacetFilter description properties, for use in object repository descriptions, programmatic descriptions, checkpoint and output value steps, and as argument values for the GetTOProperty and GetROProperty methods.

Methods

Common Method CaptureBitmap Saves a screen capture of the object as a .png or .bmp image using the specified file name.
Common Method Check Checks whether the actual value of an item matches the expected value.
Common Method CheckProperty Checks whether the specified object property achieves the specified value within the specified timeout.
Common Method ChildObjects Returns the collection of child objects contained within the object.
Method Click Clicks the object.
Method DoubleClick Clicks on the object twice.
Method Drag Performs the 'drag' part of a drag and drop operation.
Method Drop Performs the 'drop' part of a drag and drop operation.
Method ExtendFilterBy Extends the existing filter according to the specified keys.
Method FilterBy Invokes the specified filter according to the specified keys.
Method FireEvent Triggers an event.
Common Method GetROProperty Returns the current value of the specified description properties from the object in the application.
Common Method GetTOProperties Returns the collection of properties and values used to identify the object.
Common Method GetTOProperty Returns the value of the specified description properties from the test object description.
Method HoverTap When hover is supported, places the pointer on the object. Otherwise, taps the object.
Method LongPress Presses and holds the object.
Method MiddleClick Middle-clicks the object.
Method Next Scroll to the next page.
Method Open Open the specified filter list.
Method OpenDialog Open the filter dialog.
Common Method Output Retrieves the current value of an item and stores it in a specified location.
Method Pan Perform a pan gesture.
Method Pinch Perform a pinch gesture.
Method Previous Scroll to the previous page.
Common Method RefreshObject Instructs UFT to re-identify the object in the application the next time a step refers to this object.
Method Remove Remove the specified filter list.
Method Reset Reset all the filter list.
Method RightClick Right-clicks the object.
Common Method SetTOProperty Sets the value of the specified description properties in the test object description.
Method Submit Submits a form.
Method Swipe Swipes the object.
Common Method ToString Returns a string that represents the current test object.
Common Method WaitProperty Waits until the specified object property achieves the specified value or exceeds the specified timeout before continuing to the next step.

Properties

Common Property Exist Checks whether the object currently exists in the open application.
Common Property Object Accesses the native methods and properties of the object.
Property SelectedKeys Filter keys separated by semicolons (;).
Property SelectedKeysCount Number of selected keys in filter list.

 

Back to top

Click Method

Description

Clicks the object.

Syntax

object.Click [x], [y], [BUTTON]

Arguments

Parameter Description
x Optional. An integer value.
The x-coordinate of the click. The specified coordinates are relative to the upper left corner of the object. The default value is the center of the object.
Default value = 0
y Optional. An integer value.

The y-coordinate of the click. The specified coordinates are relative to the upper left corner of the object. The default value is the center of the object.

Tip: You can enter MicNoCoordinate for the x and y argument values if you want to enter a value for the button argument without specifying x- and y-coordinates for the click


Default value = 0
BUTTON Optional. A predefined constant or number.
The mouse button used to click the object.
Default value = micLeftBtn

Return Type

None

IMPORTANT

Example


 

Back to top

DoubleClick Method

Description

Clicks on the object twice.

Syntax

object.DoubleClick [interval], [x], [y]

Arguments

Parameter Description
interval Optional. A Variant.
The number of seconds between the two clicks. The default value is 0.2 seconds.

x Optional. An integer value.
The x-coordinate of the click. The specified coordinates are relative to the upper left corner of the object. The default value is the center of the object.

Default value = 0
y Optional. An integer value.
The y-coordinate of the click. The specified coordinates are relative to the upper left corner of the object. The default value is the center of the object.

Default value = 0

Return Type

None

IMPORTANT

This method is supported as long as the application supports touch events and is run on a mobile device on Mobile Center or a touch-enabled browser. Using this method on desktop browsers may generate warnings, even if you are using a mobile emulator.


 

Back to top

Drag Method

Description

Performs the 'drag' part of a drag and drop operation.

Syntax

object.Drag [x], [y], [BUTTON], [Modifier]

Arguments

Parameter Description
x Optional. An integer value.
The x-coordinate within the source object.
Default value = 0
y Optional. An integer value.
The y-coordinate within teh source object.
Default value = 0
BUTTON Optional. A predefined constant or number.
A mouse button used to drag the object. (Releasing the button performs the Drop operation.)
Default value = micLeftBtn
Modifier Optional. A String value.
The keyboard modifier that is pressed during the Drag operation.

Return Type

None

IMPORTANT

Drag and Drop operations are performed as a coupled step. Inserting one operation without the other causes an error to occur in the run session.

UFT supports the following scenarios:

General Note:

UFT alsways runs Drag and Drop steps using the mouse API, even if you defined the Replay type as Event in the Run settings section of the Web > Advanced pane (Tools > Options > GUI Testing tab > Web pane > Advanced node).

Notes for Scenario A:

  • When recording: You cannot record crossobject or cross-frame types of drag and drop oeprations (operations in which you try to drop an object on another object or in aother frame). You can, however, insert these types of Drop steps manually. Note that it may be helfup to record a drag and drop operation on the object in order to determine valid coordinates for the Drag operation step. You will need to delete the recorded Drop step, though, and manually add a new Drop step for the target object instead.
  • When running: If the application being tested supports scrolling, then UFT supports scroplling when the Drag and Drop test objects are both located in the same frame. UFT drags the Drag object to the edge of the frame, waits for the Drop object to appear, and drops the Drag object onto the Drop object. If the application being tested does not support scrolling, then UFT displays an error message when it reaches a step that requires scrolling.
  • Run session. If you want to drag a test object from one frame to another, UFT tries to make both the Drag and Drop objects visible in their frames prior to performing the Drag and Drop operation. If the two objects cannot be viewed simultaneously (for example, because the browser window is too small), the step will fail.

Notes for Scenario B and Scenario C:

  • If the screen resolution during a run session is not the same as the screen resolution during the recording session, then the size of the frame may be different during the run session as compared to the recording session. In this case, the target location coordinates may be different during the run session, and this may cause the test steps to fail.
  • During a run session, if the coordinates of a Drop step are located outside the visible frame area (for example, because your application changed), then the step may not run accurately. To solve this, fix the specified coordinates, as needed. The test object can be dragged only within the visible area of the frame object. Dragging the object to the edge of a window or frame does not cause the area to scroll (as it does in Scenario A).

Example


 

Back to top

Drop Method

Description

Performs the 'drop' part of a drag and drop operation.

Syntax

object.Drop [x], [y]

Arguments

Parameter Description
x Optional. An integer value.
The x-coordinate of the target object on which the dragged object is dropped. If the dragged and dropped object is the same object, then the x-coordinate is relative to the upper left corner in the source location prior to being dragged.
Default value = 0
y Optional. An integer value.
The y-coordinate of the target object on which the dragged object is dropped. If the dragged and dropped object is the same object, then the y-coordinate is relative to the upper left corner in the source location prior to being dragged.
Default value = 0

Return Type

None

IMPORTANT

Drag and Drop operations are performed as a coupled step. Inserting one operation without the other causes and error to occur. For more information on Drag and Drop operations, see Drag Method.

Example


 

Back to top

ExtendFilterBy Method

Description

Extends the existing filter according to the specified keys.

Syntax

object.ExtendFilterBy (FilterListTitle, FilterValues)

Arguments

ParameterDescription
FilterListTitle Required. A String value.
The name or index of the list in which to select filter values. Specify index values in the format "#N" where N is the numeric value. Index values begin with 1.
FilterValues Required. A String value.
A list of value names or indexes to select in the list, separated by semicolons (;). Specify index values in the format "#N" where N is the numeric value. Index values begin with 1.

Return Type

A Boolean value.

IMPORTANT

Example


 

Back to top

FilterBy Method

Description

Invokes the specified filter according to the specified keys.

Syntax

object.FilterBy (FilterListTitle, FilterValues)

Arguments

ParameterDescription
FilterListTitle Required. A String value.
The name or index of the list in which to select filter values. Specify index values in the format "#N" where N is the numeric value. Index values begin with 1.
FilterValues Required. A String value.
A list of value names or indexes to select in the list, separated by semicolons (;). Specify index values in the format "#N" where N is the numeric value. Index values begin with 1.

Return Type

A Boolean value.

IMPORTANT

Example


 

Back to top

FireEvent Method

Description

Triggers an event.

Syntax

object.FireEvent EventName, [x], [y], [BUTTON]

Arguments

ParameterDescription
EventName Required. A String value.

The name of the event to trigger.

Available events:

  • onchange
  • onclick
  • ondblclick
  • onblur
  • onfocus
  • onmousedown
  • onmouseup
  • onmouseover
  • onmouseout
  • onsubmit
  • onreset
  • onpropertychange
x Optional. An integer value.
The x-coordinate, relative to the upper left corner of the object.
Default value = 0
y Optional. An integer value.
The yccoordinate, relative to the upper left corner of the object.
Default value = 0
BUTTON Optional. A predefined constant or number.
The mouse button used to fire the object.
Default value = micLeftBtn

Return Type

None


 

Back to top

HoverTap Method

Description

When hover is supported, places the pointer on the object. Otherwise, taps the object.

Syntax

object.HoverTap [x], [y]

Arguments

ParameterDescription
x Optional. An integer value.
The x-coordinate of the hover point or tap. The specified coordinates are relative to the upper left corner of the object. The default value is the center of the object.

Default value = 0
y Optional. An integer value.
The y-coordinate of the hover point or tap. The specified coordinates are relative to the upper left corner of the object. The default value is the center of the object.

Default value = 0

Return Type

None

IMPORTANT

This method is supported as long as the application supports touch events and is run on a mobile device on Mobile Center or a touch-enabled browser. Using this method on desktop browsers may generate warnings, even if you are using a mobile emulator.


 

Back to top

LongPress Method

Description

Presses and holds the object.

Syntax

object.LongPress [duration], [x], [y]

Arguments

ParameterDescription
duration Optional. A Variant.

The time period (in seconds) to hold the long tap gesture.

You can specify partial seconds as a duration time.

x Optional. An integer value.
The x-coordinate of the long tap gesture. The coordinate is relative to the upper left corner of the object. The default value is the center of the object.
Default value = 0
y Optional. An integer value.
The y-coordinate of the tap gesture. The coordinate is relative to the upper left corner of the object. The default value is the center of the object.
Default value = 0

Return Type

None

IMPORTANT

This method is supported as long as the application supports touch events and is run on a mobile device on Mobile Center or a touch-enabled browser. Using this method on desktop browsers may generate warnings, even if you are using a mobile emulator.

Example


 

Back to top

MiddleClick Method

Description

Middle-clicks the object.

Syntax

object.MiddleClick [x], [y]

Arguments

ParameterDescription
x Optional. An integer value.
The x-coordinate of the middle click . The specified coordinates are relative to the upper left corner of the object. The default value is the center of the object.
Default value = 0
y Optional. An integer value.
The y-coordinate of the middle click. The specified coordinates are relative to the upper left corner of the object. The default value is the center of the object.
Default value = 0

Return Type

None

IMPORTANT


 

Back to top

Next Method

Description

Scroll to the next page.

Syntax

object.Next

Return Type

None


 

Back to top

Open Method

Description

Open the specified filter list.

Syntax

object.Open FilterListTitle

Arguments

ParameterDescription
FilterListTitle Required. A String value.

Return Type

None


 

Back to top

OpenDialog Method

Description

Open the filter dialog.

Syntax

object.OpenDialog

Return Type

None


 

Back to top

Pan Method

Description

Perform a pan gesture.

Syntax

object.Pan deltaX, deltaY, [duration], [startX], [startY]

Arguments

ParameterDescription
deltaX Required. An integer value.

The distance moved on the x axis, relative to the start point.

deltaY Required. An integer value.

The distance moved on the y axis, relative to the start point.

duration Optional. A Variant.

The number of seconds required to perform the pan gesture.

startX Optional. An integer value.

The x-coordinate of where the pan gesture starts. The specified coordinates are relative to the upper left corner of the object.


Default value = 0
startY Optional. An integer value.

The y-coordinate of where the pan gesture starts. The specified coordinates are relative to the upper left corner of the object.


Default value = 0

Return Type

None

IMPORTANT

This method is supported as long as the application supports touch events and is run on a mobile device on Mobile Center or a touch-enabled browser. Using this method on desktop browsers may generate warnings, even if you are using a mobile emulator.

This method is not supported in Internet Explorer and older versions of FireFox.


 

Back to top

Pinch Method

Description

Perform a pinch gesture.

Syntax

object.Pinch scale, [duration], [x], [y]

Arguments

ParameterDescription
scale Required. A Variant.

The zoom scale resulting from the pinch gesture. This is the ratio between the distance between the fingers at the end of the pinch gesture to the distance between the fingers at the beginning of the pinch gesture.

duration Optional. A Variant.

The number of seconds required to perform the pinch gesture. The default value is 1 second.

x Optional. An integer value.

The x-coordinate of where the pinch gesture begins. The specified coordinates are relative to the upper left corner of the object. The default value is the center of the object.


Default value = 0
y Optional. An integer value.

The y-coordinate of of where the pinch gesture begins. The specified coordinates are relative to the upper left corner of the object. The default value is the center of the object.


Default value = 0

Return Type

None

IMPORTANT

This method is supported as long as the application supports touch events and is run on a mobile device on Mobile Center or a touch-enabled browser. Using this method on desktop browsers may generate warnings, even if you are using a mobile emulator.

This method is not supported in Internet Explorer and older versions of FireFox.


 

Back to top

Previous Method

Description

Scroll to the previous page.

Syntax

object.Previous

Return Type

None


 

Back to top

Remove Method

Description

Remove the specified filter list.

Syntax

object.Remove FilterListTitle

Arguments

ParameterDescription
FilterListTitle Required. A String value.

Return Type

None


 

Back to top

Reset Method

Description

Reset all the filter list.

Syntax

object.Reset

Return Type

None


 

Back to top

RightClick Method

Description

Right-clicks the object.

Syntax

object.RightClick [x], [y]

Arguments

ParameterDescription
x Optional. An integer value.
The x-coordinate of the right click. The specified coordinates are relative to the upper left corner of the object. The default value is the center of the object.
Default value = 0
y Optional. An integer value.
The y-coordinate of the right click. The specified coordinates are relative to the upper left corner of the object. The default value is the center of the object.
Default value = 0

Return Type

None

IMPORTANT


 

Back to top

Submit Method

Description

Submits a form.

Syntax

object.Submit

Return Type

None

IMPORTANT

This method simulates pressing the Enter key, while the focus is on the object specified in the statement.

If the object is not part of a Web form, the Submit method has no effect.


 

Back to top

Swipe Method

Description

Swipes the object.

Syntax

object.Swipe direction, [distance], [duration], [startX], [startY]

Arguments

ParameterDescription
direction Required. A MoveDirection Value.

The direction of the swipe gesture.

Possible values:

  • moveDown
  • moveLeft
  • moveRight
  • moveUp
distance Optional. An integer value.
The distance (in pixels) of the swipe gesture.
Default value = 0
duration Optional. A Variant.

The time period (in seconds) of the swipe gesture.

You can specify partial seconds as a duration time.

startX Optional. An integer value.
The x-coordinate at which the swipe gesture begins. The specified coordinates are relative to the upper left corner of the object. The default value is the center of the object.
Default value = 0
startY Optional. An integer value.
The y-coordinate at which the swipe gesture begins. The coordinate is relative to the upper left corner of the object. The default value is the center of the object.
Default value = 0

Return Type

None

IMPORTANT

This method is supported as long as the application supports touch events and is run on a mobile device on Mobile Center or a touch-enabled browser. Using this method on desktop browsers may generate warnings, even if you are using a mobile emulator.

This method is not supported for Windows Phone.

Example


 

Back to top

SelectedKeys Property

Description

Filter keys separated by semicolons (;).

Syntax

object.SelectedKeys (FilterListTitle)

Arguments

ParameterDescription
FilterListTitle Required. A String value.
The name or index of the filter list whose selected keys to retrieve. Specify index values in the format "#N" where N is the numeric value. Index values begin with 1.

Value Type

A String value.

A list of the filter keys (names) that are selected in the specified filter list, separated by semicolons (;).

Property type

Read-only property

Example


 

Back to top

SelectedKeysCount Property

Description

Number of selected keys in filter list.

Syntax

object.SelectedKeysCount (FilterListTitle)

Arguments

ParameterDescription
FilterListTitle Required. A String value.
The name or index of the filter list whose selected keys to count. Specify index values in the format "#N" where N is the numeric value. Index values begin with 1.

Value Type

An integer value.

The number of selected filter keys in the specified filter list.

Property type

Read-only property

Example


Back to top

See also: