com.github.mkolisnyk.sirius.client.ui

Annotation Type FindBy

@Target(value=FIELD)
 @Repeatable(value=FindByList.class)
 @Retention(value=RUNTIME)
public @interface FindBy

Major annotation assigned to page controls. It contains multiple attributes which help identifying object on the page as well as defines the way to process each specific control element.

This annotation can be assigned to the same Control object multiple times. Major difference is related to the platform each specific version of the locator is applied for.

Author:

Mykola Kolisnyk

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
java.lang.String	locator String which is normally used to identify the way the element can be found on the page.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	excludeFromSearch Defines whether current element is supposed to be checked while verifying if current page class represents the page which is currently available on the screen.
java.lang.String	format Additional attribute which is responsible for various format transformations.
java.lang.String	itemLocator The part of sub-element identifier.
Platform	platform The field responsible for platform definition.
ScrollTo	scrollDirection Defines the direction of search for scrollTo() text value.
java.lang.String	scrollTo The text to scroll to in case current element isn't found on existing screen.

Element Detail

locator

public abstract java.lang.String locator

String which is normally used to identify the way the element can be found on the page.

Returns:

string representing element locator.

platform

public abstract Platform platform

The field responsible for platform definition. It can be used to filter the the record which is applicable for current platform.

Returns:

the platform current annotation is applicable for.

Default:

com.github.mkolisnyk.sirius.client.Platform.ANY

itemLocator

public abstract java.lang.String itemLocator

The part of sub-element identifier. Used for compound objects definition. Mainly this functionality is used with compound control classes like TableView

Returns:

sub-element identifier.

Default:

""

scrollTo

public abstract java.lang.String scrollTo

The text to scroll to in case current element isn't found on existing screen. Mainly, it is needed for Android and any other WebDriver implementation when elements are seen only if they are on current screen.

Returns:

text to scroll to.

Default:

""

scrollDirection

public abstract ScrollTo scrollDirection

Defines the direction of search for scrollTo() text value. Used in combination with scrollTo() and defines the sequence to scroll (top-bottom, bottom-top, top-only, bottom-only).

Returns:

the direction of search for scrollTo() text value.

Default:

com.github.mkolisnyk.sirius.client.ui.ScrollTo.TOP_BOTTOM

format

public abstract java.lang.String format

Additional attribute which is responsible for various format transformations. Typically, it is used for custom controls where the value is represented in some custom format.

Returns:

the format string.

Default:

""

excludeFromSearch

public abstract boolean excludeFromSearch

Defines whether current element is supposed to be checked while verifying if current page class represents the page which is currently available on the screen.

Returns:

exclude from search flag.

Default:

false