com.qmetry.qaf.automation.ui.webdriver

Class ElementMetaDataListener

java.lang.Object

com.qmetry.qaf.automation.ui.webdriver.QAFWebElementCommandAdapter

com.qmetry.qaf.automation.ui.webdriver.ElementMetaDataListener

All Implemented Interfaces:

QAFListener, QAFWebElementCommandListener

public class ElementMetaDataListener
extends QAFWebElementCommandAdapter

This listener provides capability of defining scroll behavior, encrypted value for password based on element on meta-data.

Examples:

• {'locator':'name=q','scroll': 'OnFail','sendkeys-options': 'click clear','scroll-options': '{block: \'center\'}'}
• {'locator':'name=pwdTxt','sendkeys-options': 'clear','type': 'password'}
• {}

Since:

2.1.13

Author:

chirag.jayswal

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.List<java.lang.String>	COMMANDS_REQUIRES_SCROLL
static java.lang.String	SCROLL meta-key to specify scroll behavior, possible values: Always/true - always scroll before commands required scroll OnFail - retry with scroll on failure for commands required scroll
static java.lang.String	SCROLL_OPTIONS meta-key to specify scroll options, A value that indicates the type of the align::
static java.lang.String	SENDKEYS_OPTIONS meta-key to specify one or more send-keys options, possible values: click: to specify click before send-keys clear: to specify clear before send-keys Examples: {'sendkeys-options': 'clear'} {'sendkeys-options': 'click'} {'sendkeys-options': 'click clear'}
static java.lang.String	TYPE meta-key for send-keys to specify element type, possible values: password/encrypted - required to decode before send keys select - specify this is select (basic support only) with options and choose option Examples: {'type': 'password'} {'type': 'select'}

Constructor Summary

Constructors

Constructor and Description
ElementMetaDataListener()

Method Summary

Modifier and Type	Method and Description
void	beforeCommand(QAFExtendedWebElement element, CommandTracker commandTracker) This can be used as intercepter.
void	onFailure(QAFExtendedWebElement element, CommandTracker commandTracker) This can be used to propagate exception.

Methods inherited from class com.qmetry.qaf.automation.ui.webdriver.QAFWebElementCommandAdapter

afterCommand, execute, executeWithoutLog

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SCROLL

public static final java.lang.String SCROLL

meta-key to specify scroll behavior, possible values:

• Always/true - always scroll before commands required scroll
• OnFail - retry with scroll on failure for commands required scroll

See Also:

Constant Field Values

SCROLL_OPTIONS

public static final java.lang.String SCROLL_OPTIONS

meta-key to specify scroll options, A value that indicates the type of the align::

Examples:

• {'scroll-options': 'true'}
• {'scroll-options': 'false'}
• {'scroll-options': '{block: \'center\'}'}

See Also:

https://developer.mozilla.org/en-US/docs/Web/API/Element/scrollIntoView, Constant Field Values

SENDKEYS_OPTIONS

public static final java.lang.String SENDKEYS_OPTIONS

meta-key to specify one or more send-keys options, possible values:

• click: to specify click before send-keys
• clear: to specify clear before send-keys

Examples:

• {'sendkeys-options': 'clear'}
• {'sendkeys-options': 'click'}
• {'sendkeys-options': 'click clear'}

See Also:

Constant Field Values

TYPE

public static final java.lang.String TYPE

meta-key for send-keys to specify element type, possible values:

• password/encrypted - required to decode before send keys
• select - specify this is select (basic support only) with options and choose option

Examples:

• {'type': 'password'}
• {'type': 'select'}

See Also:

Constant Field Values

COMMANDS_REQUIRES_SCROLL

public static final java.util.List<java.lang.String> COMMANDS_REQUIRES_SCROLL

Constructor Detail

ElementMetaDataListener

public ElementMetaDataListener()

Method Detail

beforeCommand

public void beforeCommand(QAFExtendedWebElement element,
                          CommandTracker commandTracker)

Description copied from interface: QAFWebElementCommandListener

This can be used as intercepter. If you want to skip execution of actual command then set response in CommandTracker.setResponce(Response)

Specified by:

beforeCommand in interface QAFWebElementCommandListener

Overrides:

beforeCommand in class QAFWebElementCommandAdapter

onFailure

public void onFailure(QAFExtendedWebElement element,
                      CommandTracker commandTracker)

Description copied from interface: QAFWebElementCommandListener

This can be used to propagate exception. You can get information about from where exception thrown by inspecting CommandTracker.getStage()

Specified by:

onFailure in interface QAFWebElementCommandListener

Overrides:

onFailure in class QAFWebElementCommandAdapter