Options
All
  • Public
  • Public/Protected
  • All
Menu

Class PageElementListCurrently<Store, PageElementType, PageElementOpts, ListType>

This class defines all currently functions of PageElementList.

template

Store type of the PageNodeStore instance which can be used to retrieve/create PageNodes

template

PageElementType type of the PageElement managed by PageElementList

template

PageElementOpts type of the opts paramter passed to the constructor function of managed PageElements

template

ListType type of the PageElementList for which PageElementListCurrently defines all currently functions

Type parameters

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Protected _elementOpts

_elementOpts: PageElementOpts

the options passed to elementStoreFunc to configure the retrieved PageElement instance

Protected _elementStoreFunc

_elementStoreFunc: function

This function retrieves an instance of a PageElement mapped by PageElementList from the list's PageNodeStore.

param

the XPath expression used to identify the retrieved PageElement in the DOM

param

the options used to configure the retrieved PageElement

Type declaration

    • (selector: string, options: PageElementOpts): PageElementType

    • Parameters

      • selector: string
      • options: PageElementOpts

      Returns PageElementType

Protected _node

_node: ListType

Protected _selector

_selector: string

the XPath selector that identifies all PageElements managed by PageElementList

Protected _store

_store: Store

an instance of PageNodeStore which can be used to retrieve/create PageNodes

Protected _whereBuilder

_whereBuilder: ListWhereBuilder<Store, PageElementType, PageElementOpts, ListType>

Stores an instance of ListWhereBuilder which allows to select subsets of the PageElements managed by PageElementList by modifying the list's selector using XPath modification functions.

Accessors

any

none

  • get none(): object

  • Provides an API to check if none of PageElementList's managed PageElements has a certain state within a specific timeout.

    Returns object

    • containsAttribute: function
      • containsAttribute(attribute: IAttribute): boolean

      • Returns true if the specified HTML attribute of PageElement currently does not contain the expected value.

        Parameters

        • attribute: IAttribute

          the specified HTML attribute of PageElement, consisting of the attribute's name and the value it is expected not to contain

        Returns boolean

    • containsClass: function
      • containsClass(className: string): boolean

      • Returns true if the HTML attribute 'class' of PageElement currently does not contain the specified className.

        Parameters

        • className: string

          the className which the HTML attribute 'class' of PageElement is supposed not to contain

        Returns boolean

    • containsDirectText: function
      • containsDirectText(directText: string): boolean

      • Returns true if the PageElement's actual direct text currently does not contain the expected direct text.

        A direct text is a text that resides on the level directly below the selected HTML element. It does not include any text of the HTML element's nested children HTML elements.

        Parameters

        • directText: string

          the expected direct text which is supposed not to be contained in the actual direct text

        Returns boolean

    • containsHTML: function
      • containsHTML(html: string): boolean
    • containsId: function
      • containsId(id: string): boolean

      • Returns true if the HTML attribute 'id' of PageElement currently does not contain the specified value.

        Parameters

        • id: string

          the value which the HTML attribute 'id' of PageElement is supposed not to contain

        Returns boolean

    • containsName: function
      • containsName(name: string): boolean

      • Returns true if the HTML attribute 'name' of PageElement currently does not contain the specified value.

        Parameters

        • name: string

          the value which the HTML attribute 'name' of PageElement is supposed not to contain

        Returns boolean

    • containsText: function
      • containsText(text: string): boolean

      • Returns true if the PageElement's actual text currently does not contain the expected text.

        Parameters

        • text: string

          the expected text which is supposed not to be contained in the actual text

        Returns boolean

    • exists: function
      • exists(): boolean
    • hasAnyAttribute: function
      • hasAnyAttribute(attributeName: string): boolean

      • Returns true if the HTML attribute with the specified attributeName of PageElement currently does not have any value.

        Parameters

        • attributeName: string

          the name of a PageElement's HTML attribute which is supposed not to have any value

        Returns boolean

    • hasAnyClass: function
      • hasAnyClass(): boolean
    • hasAnyDirectText: function
      • hasAnyDirectText(): boolean

      • Returns true if the PageElement currently does not have any direct text.

        A direct text is a text that resides on the level directly below the selected HTML element. It does not include any text of the HTML element's nested children HTML elements.

        Returns boolean

    • hasAnyHTML: function
      • hasAnyHTML(): boolean
    • hasAnyId: function
      • hasAnyId(): boolean
    • hasAnyName: function
      • hasAnyName(): boolean
    • hasAnyText: function
      • hasAnyText(): boolean
    • hasAttribute: function

      • Returns true if the specified HTML attribute of PageElement currently does not have the expected value.

        Parameters

        • attribute: IAttribute

          the specified HTML attribute of PageElement, consisting of the attribute's name and the value it is expected not to have

        Returns boolean

    • hasClass: function
      • hasClass(className: string): boolean

      • Returns true if the HTML attribute 'class' of PageElement currently does not have the specified className.

        Parameters

        • className: string

          the className which the HTML attribute 'class' of PageElement is supposed not to have

        Returns boolean

    • hasDirectText: function
      • hasDirectText(directText: string): boolean

      • Returns true if the PageElement's actual direct text currently does not equal the expected direct text.

        A direct text is a text that resides on the level directly below the selected HTML element. It does not include any text of the HTML element's nested children HTML elements.

        Parameters

        • directText: string

          the expected direct text which is supposed not to equal the actual direct text

        Returns boolean

    • hasHTML: function
      • hasHTML(html: string): boolean

      • Returns true if the PageElement's actual HTML currently does not equal the expected HTML.

        Parameters

        • html: string

          the expected HTML which is supposed not to equal the actual HTML

        Returns boolean

    • hasHeight: function
      • hasHeight(height: number, tolerance?: number): boolean

      • Returns true if - currently - the height of PageElement does not match the specified height or if PageElement's height deviates more than the specified tolerance from the specified height.

        Parameters

        • height: number

          the expected height of PageElement

        • Optional tolerance: number

          used to calculate the maximal allowed deviation from the expected height

        Returns boolean

    • hasId: function
      • hasId(id: string): boolean

      • Returns true if the HTML attribute 'id' of PageElement currently does not have the specified value.

        Parameters

        • id: string

          the value which the HTML attribute 'id' of PageElement is supposed not to have

        Returns boolean

    • hasLocation: function

      • Returns true if - currently - the location of PageElement does not match the specified coordinates or if its location deviates more than the specified tolerances from the specified coordinates.

        Parameters

        • coordinates: ICoordinates

          the not-expected coordinates of PageElement

        • Optional tolerances: Partial<ICoordinates>

          used to calculate the maximal allowed deviations from the expected coordinates

        Returns boolean

    • hasName: function
      • hasName(name: string): boolean

      • Returns true if the HTML attribute 'name' of PageElement currently does not have the specified value.

        Parameters

        • name: string

          the value which the HTML attribute 'name' of PageElement is supposed not to have

        Returns boolean

    • hasSize: function
      • hasSize(size: ISize, tolerances?: Partial<ISize>): boolean

      • Returns true if - currently - the size of PageElement does not match the specified size or if PageElement's size deviates more than the specified tolerances from the specified size.

        Parameters

        • size: ISize

          the not-expected size of PageElement

        • Optional tolerances: Partial<ISize>

          used to calculate the maximal allowed deviations from the expected size

        Returns boolean

    • hasText: function
      • hasText(text: string): boolean

      • Returns true if the PageElement's actual text currently does not equal the expected text.

        Parameters

        • text: string

          the expected text which is supposed not to equal the actual text

        Returns boolean

    • hasWidth: function
      • hasWidth(width: number, tolerance?: number): boolean

      • Returns true if - currently - the width of PageElement does not match the specified width or if PageElement's width deviates more than the specified tolerance from the specified width.

        Parameters

        • width: number

          the expected width of PageElement

        • Optional tolerance: number

          used to calculate the maximal allowed deviation from the expected width

        Returns boolean

    • hasX: function
      • hasX(x: number, tolerance?: number): boolean

      • Returns true if - currently - the x-location of PageElement does not match the specified x-location or if PageElement's x-location deviates more than the specified tolerance from the specified x-location.

        Parameters

        • x: number

          the not-expected x-location of PageElement

        • Optional tolerance: number

          used to calculate the maximal allowed deviation from the expected x-location

        Returns boolean

    • hasY: function
      • hasY(y: number, tolerance?: number): boolean

      • Returns true if - currently - the y-location of PageElement does not match the specified y-location or if PageElement's y-location deviates more than the specified tolerance from the specified y-location.

        Parameters

        • y: number

          the not-expected y-location of PageElement

        • Optional tolerance: number

          used to calculate the maximal allowed deviation from the expected y-location

        Returns boolean

    • isChecked: function
      • isChecked(): boolean
    • isEnabled: function
      • isEnabled(): boolean
    • isSelected: function
      • isSelected(): boolean
    • isVisible: function
      • isVisible(): boolean

not

  • get not(): object

  • returns the negated variants of PageElementListCurrently's state check functions

    Returns object

    • containsDirectText: function
      • containsDirectText(directText: string | string[]): boolean

      • Returns true if the actual direct texts of all PageElements managed by PageElementList currently do not contain the expected direct text(s).

        A direct text is a text that resides on the level directly below the selected HTML element. It does not include any text of the HTML element's nested children HTML elements.

        Parameters

        • directText: string | string[]

          the expected direct text(s) not supposed to be contained in the actual direct texts

          If directText is a single value, this value is compared to each element in the array of actual values of all PageElements. If directText is an array of values, its length must match the length of PageElementList and the values of its array elements are compared to the array of actual values of all PageElements.

        Returns boolean

    • containsText: function
      • containsText(text: string | string[]): boolean

      • Returns true if the actual texts of all PageElements managed by PageElementList currently do not contain the expected text(s).

        Parameters

        • text: string | string[]

          the expected text(s) supposed not to be contained in the actual texts

          If text is a single value, this value is compared to each element in the array of actual values of all PageElements. If text is an array of values, its length must match the length of PageElementList and the values of its array elements are compared to the array of actual values of all PageElements.

        Returns boolean

    • exists: function
      • exists(filterMask?: boolean): boolean

      • Returns true if none of the PageElements managed by PageElementList currently exist.

        Parameters

        • Optional filterMask: boolean

          if set to false, the existence check is skipped and true is returned

        Returns boolean

    • hasAnyDirectText: function

      • Returns true if all PageElements managed by PageElementList currently do not have any direct text.

        A direct text is a text that resides on the level directly below the selected HTML element. It does not include any text of the HTML element's nested children HTML elements.

        Parameters

        • Optional filterMask: ListFilterMask

          can be used to skip the invocation of the hasAnyDirectText function for some or all managed PageElements

        Returns boolean

    • hasAnyText: function
    • hasDirectText: function
      • hasDirectText(directText: string | string[]): boolean

      • Returns true if the actual direct texts of all PageElements managed by PageElementList currently do not equal the expected direct text(s).

        A direct text is a text that resides on the level directly below the selected HTML element. It does not include any text of the HTML element's nested children HTML elements.

        Parameters

        • directText: string | string[]

          the expected direct text(s) supposed not to equal the actual direct texts

          If directText is a single value, this value is compared to each element in the array of actual values of all PageElements. If directText is an array of values, its length must match the length of PageElementList and the values of its array elements are compared to the array of actual values of all PageElements.

        Returns boolean

    • hasLength: function
      • hasLength(length: number, comparator?: Comparator): boolean

      • Returns the current negated result of the comparison between PageElementList's actual length and an expected length using the comparison method defined in comparator.

        The following comparison methods are supported:

        • "==" to check if the actual length equals the expected length
        • "!=" to check if the actual length does not equal the expected length
        • "<" to check if the actual length is less than the expected length
        • ">" to check if the actual length is greater than the expected length

        Parameters

        • length: number

          the not-expected length

        • Default value comparator: Comparator = Workflo.Comparator.equalTo

          defines the method used to compare the actual and the expected length of PageElementList

        Returns boolean

    • hasText: function
      • hasText(text: string | string[]): boolean

      • Returns true if the actual texts of all PageElements managed by PageElementList currently do not equal the expected text(s).

        Parameters

        • text: string | string[]

          the expected text(s) supposed not to equal the actual texts

          If text is a single value, this value is compared to each element in the array of actual values of all PageElements. If text is an array of values, its length must match the length of PageElementList and the values of its array elements are compared to the array of actual values of all PageElements.

        Returns boolean

    • isEmpty: function
      • isEmpty(): boolean
    • isEnabled: function
    • isVisible: function

Methods

containsDirectText

  • containsDirectText(directText: string | string[]): boolean

  • Returns true if the actual direct texts of all PageElements managed by PageElementList currently contain the expected direct text(s).

    A direct text is a text that resides on the level directly below the selected HTML element. It does not include any text of the HTML element's nested children HTML elements.

    Parameters

    • directText: string | string[]

      the expected direct text(s) supposed to be contained in the actual direct texts

      If directText is a single value, this value is compared to each element in the array of actual values of all PageElements. If directText is an array of values, its length must match the length of PageElementList and the values of its array elements are compared to the array of actual values of all PageElements.

    Returns boolean

containsText

  • containsText(text: string | string[]): boolean

  • Returns true if the actual texts of all PageElements managed by PageElementList currently contain the expected text(s).

    Parameters

    • text: string | string[]

      the expected text(s) supposed to be contained in the actual texts

      If text is a single value, this value is compared to each element in the array of actual values of all PageElements. If text is an array of values, its length must match the length of PageElementList and the values of its array elements are compared to the array of actual values of all PageElements.

    Returns boolean

exists

  • exists(filterMask?: boolean): boolean

  • Returns true if at least one of the PageElements managed by PageElementList currently exists.

    Parameters

    • Optional filterMask: boolean

      if set to false, the existence check is skipped and true is returned

    Returns boolean

getContainsDirectText

  • getContainsDirectText(directText: string | string[]): boolean[]

  • Returns the current 'containsDirectText' status of all PageElements managed by PageElementList as an array.

    A PageElement's 'containsDirectText' status is set to true if its actual direct text contains the expected direct text.

    Parameters

    • directText: string | string[]

      the expected direct text used in the comparisons which set the 'containsDirectText' status.

      If directText is a single value, this value is compared to each element in the array of actual values of all PageElements. If directText is an array of values, its length must match the length of PageElementList and the values of its array elements are compared to the array of actual values of all PageElements.

    Returns boolean[]

getContainsText

  • getContainsText(text: string | string[]): boolean[]

  • Returns the current 'containsText' status of all PageElements managed by PageElementList as an array.

    A PageElement's 'containsText' status is set to true if its actual text contains the expected text.

    Parameters

    • text: string | string[]

      the expected text used in the comparisons which set the 'containsText' status

      If text is a single value, this value is compared to each element in the array of actual values of all PageElements. If text is an array of values, its length must match the length of PageElementList and the values of its array elements are compared to the array of actual values of all PageElements.

    Returns boolean[]

getDirectText

  • Returns the current direct texts of all PageElements managed by PageElementList as an array.

    A direct text is a text that resides on the level directly below the selected HTML element. It does not include any text of the HTML element's nested children HTML elements.

    Parameters

    • Optional filterMask: ListFilterMask

      can be used to skip the invocation of the getDirectText function for some or all managed PageElements. The results of skipped function invocations are not included in the total results array.

    Returns string[]

getExists

  • Returns the current 'exists' status of all PageElements managed by PageElementList as an array.

    Parameters

    • Optional filterMask: ListFilterMask

      can be used to skip the invocation of the getExists function for some or all managed PageElements. The results of skipped function invocations are not included in the total results array.

    Returns boolean[]

getHasAnyDirectText

  • Returns the current 'hasAnyDirectText' status of all PageElements managed by PageElementList as an array.

    A PageElement's 'hasAnyDirectText' status is set to true if the PageElement has any direct text.

    Parameters

    • Optional filterMask: ListFilterMask

      can be used to skip the invocation of the getHasAnyDirectText function for some or all managed PageElements. The results of skipped function invocations are not included in the total results array.

    Returns boolean[]

getHasAnyText

  • Returns the current 'hasAnyText' status of all PageElements managed by PageElementList as an array.

    A PageElement's 'hasAnyText' status is set to true if the PageElement has any text.

    Parameters

    • Optional filterMask: ListFilterMask

      can be used to skip the invocation of the getHasAnyText function for some or all managed PageElements. The results of skipped function invocations are not included in the total results array.

    Returns boolean[]

getHasDirectText

  • getHasDirectText(directText: string | string[]): boolean[]

  • Returns the current 'hasDirectText' status of all PageElements managed by PageElementList as an array.

    A PageElement's 'hasDirectText' status is set to true if its actual direct text equals the expected direct text.

    Parameters

    • directText: string | string[]

      the expected direct text used in the comparisons which set the 'hasDirectText' status.

      If directText is a single value, this value is compared to each element in the array of actual values of all PageElements. If directText is an array of values, its length must match the length of PageElementList and the values of its array elements are compared to the array of actual values of all PageElements.

    Returns boolean[]

getHasText

  • getHasText(text: string | string[]): boolean[]

  • Returns the current 'hasText' status of all PageElements managed by PageElementList as an array.

    A PageElement's 'hasText' status is set to true if its actual text equals the expected text.

    Parameters

    • text: string | string[]

      the expected text used in the comparisons which set the 'hasText' status

      If text is a single value, this value is compared to each element in the array of actual values of all PageElements. If text is an array of values, its length must match the length of PageElementList and the values of its array elements are compared to the array of actual values of all PageElements.

    Returns boolean[]

getIsEnabled

  • Returns the current 'enabled' status of all PageElements managed by PageElementList as an array.

    Parameters

    • Optional filterMask: ListFilterMask

      can be used to skip the invocation of the getIsEnabled function for some or all managed PageElements. The results of skipped function invocations are not included in the total results array.

    Returns boolean[]

getIsVisible

  • Returns the current 'visible' status of all PageElements managed by PageElementList as an array.

    Parameters

    • Optional filterMask: ListFilterMask

      can be used to skip the invocation of the getIsVisible function for some or all managed PageElements. The results of skipped function invocations are not included in the total results array.

    Returns boolean[]

getLength

  • getLength(): number

getText

  • Returns the current texts of all PageElements managed by PageElementList as an array.

    Parameters

    • Optional filterMask: ListFilterMask

      can be used to skip the invocation of the getText function for some or all managed PageElements. The results of skipped function invocations are not included in the total results array.

    Returns string[]

hasAnyDirectText

  • Returns true if all PageElements managed by PageElementList currently have any direct text.

    A direct text is a text that resides on the level directly below the selected HTML element. It does not include any text of the HTML element's nested children HTML elements.

    Parameters

    • Optional filterMask: ListFilterMask

      can be used to skip the invocation of the hasAnyDirectText function for some or all managed PageElements

    Returns boolean

hasAnyText

hasDirectText

  • hasDirectText(directText: string | string[]): boolean

  • Returns true if the actual direct texts of all PageElements managed by PageElementList currently equal the expected direct text(s).

    A direct text is a text that resides on the level directly below the selected HTML element. It does not include any text of the HTML element's nested children HTML elements.

    Parameters

    • directText: string | string[]

      the expected direct text(s) supposed to equal the actual direct texts

      If directText is a single value, this value is compared to each element in the array of actual values of all PageElements. If directText is an array of values, its length must match the length of PageElementList and the values of its array elements are compared to the array of actual values of all PageElements.

    Returns boolean

hasLength

  • hasLength(length: number, comparator?: Comparator): boolean

  • Returns the current result of the comparison between PageElementList's actual length and an expected length using the comparison method defined in comparator.

    The following comparison methods are supported:

    • "==" to check if the actual length equals the expected length
    • "!=" to check if the actual length does not equal the expected length
    • "<" to check if the actual length is less than the expected length
    • ">" to check if the actual length is greater than the expected length

    Parameters

    • length: number

      the expected length

    • Default value comparator: Comparator = Workflo.Comparator.equalTo

      defines the method used to compare the actual and the expected length of PageElementList

    Returns boolean

hasText

  • hasText(text: string | string[]): boolean

  • Returns true if the actual texts of all PageElements managed by PageElementList currently equal the expected text(s).

    Parameters

    • text: string | string[]

      the expected text(s) supposed to equal the actual texts

      If text is a single value, this value is compared to each element in the array of actual values of all PageElements. If text is an array of values, its length must match the length of PageElementList and the values of its array elements are compared to the array of actual values of all PageElements.

    Returns boolean

isEmpty

  • isEmpty(): boolean

isEnabled

isVisible

Generated using TypeDoc