Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IGetElement<TextType, BooleanType, FilterType>

Used by IElementNode to describe state retrieval functions supported by PageElement, PageElementList, PageElementMap and PageElementGroup.

Type parameters

  • TextType

  • BooleanType

  • FilterType

Hierarchy

Index

Methods

getContainsDirectText

  • getContainsDirectText(text: TextType): BooleanType
  • Returns the 'containsDirectText' status of a PageElement or of the PageElements managed by a PageElementList, PageElementMap or PageElementGroup.

    A PageElement's 'containsDirectText' status is set to true if its actual direct text equals 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

    • text: TextType

      the expected direct text used in the comparison which sets the 'containsDirectText' status

    Returns BooleanType

getContainsText

  • getContainsText(text: TextType): BooleanType
  • Returns the 'containsText' status of a PageElement or of the PageElements managed by a PageElementList, PageElementMap or PageElementGroup.

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

    Parameters

    • text: TextType

      the expected text used in the comparison which sets the 'containsText' status

    Returns BooleanType

getDirectText

  • getDirectText(filterMask?: FilterType): TextType
  • Returns the direct text of a PageElement or of the PageElements managed by a PageElementList, PageElementMap or PageElementGroup.

    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: FilterType

      can be used to skip the invocation of the state retrieval function for some or all managed PageElements and not include the skipped results in the total result

    Returns TextType

getHasAnyDirectText

  • getHasAnyDirectText(filterMask?: FilterType): BooleanType
  • Returns the 'hasAnyDirectText' status of a PageElement or of the PageElements managed by a PageElementList, PageElementMap or PageElementGroup.

    A PageElement's 'hasAnyDirectText' status is set to true if it has any actual 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: FilterType

      can be used to skip the invocation of the state retrieval function for some or all managed PageElements and not include the skipped results in the total result

    Returns BooleanType

getHasAnyText

  • getHasAnyText(filterMask?: FilterType): BooleanType
  • Returns the 'hasAnyText' status of a PageElement or of the PageElements managed by a PageElementList, PageElementMap or PageElementGroup.

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

    Parameters

    • Optional filterMask: FilterType

      can be used to skip the invocation of the state retrieval function for some or all managed PageElements and not include the skipped results in the total result

    Returns BooleanType

getHasDirectText

  • getHasDirectText(text: TextType): BooleanType
  • Returns the 'hasDirectText' status of a PageElement or of the PageElements managed by a PageElementList, PageElementMap or PageElementGroup.

    A PageElement's 'hasDirectText' status is set to true if its actual direct text equals 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

    • text: TextType

      the expected direct text used in the comparison which sets the 'hasDirectText' status

    Returns BooleanType

getHasText

  • getHasText(text: TextType): BooleanType
  • Returns the 'hasText' status of a PageElement or of the PageElements managed by a PageElementList, PageElementMap or PageElementGroup.

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

    Parameters

    • text: TextType

      the expected text used in the comparison which sets the 'hasText' status

    Returns BooleanType

getIsEnabled

  • getIsEnabled(filterMask?: FilterType): BooleanType
  • Returns the 'enabled' status of a PageElement or of the PageElements managed by a PageElementList, PageElementMap or PageElementGroup.

    Parameters

    • Optional filterMask: FilterType

      can be used to skip the invocation of the state retrieval function for some or all managed PageElements and not include the skipped results in the total result

    Returns BooleanType

getText

  • getText(filterMask?: FilterType): TextType
  • Returns the text of a PageElement or of the PageElements managed by a PageElementList, PageElementMap or PageElementGroup.

    Parameters

    • Optional filterMask: FilterType

      can be used to skip the invocation of the state retrieval function for some or all managed PageElements and not include the skipped results in the total result

    Returns TextType

Generated using TypeDoc