Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ICheckCurrently<TextType, BooleanType, FilterType>

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

Type parameters

  • TextType

  • BooleanType

  • FilterType

Hierarchy

  • ICheckCurrently

Index

Properties

not

not: Omit<ICheckCurrently<TextType, BooleanType, FilterType>, "not" | "getExists" | "getIsVisible" | "getIsEnabled">

returns the negated variants of ICheckCurrently's state check functions

Methods

containsDirectText

  • containsDirectText(directText: TextType): boolean
  • Checks if a PageElement or all PageElements managed by a PageElementList, PageElementMap or PageElementGroup currently have an actual direct text which contains 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: TextType

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

    Returns boolean

containsText

  • containsText(text: TextType): boolean
  • Checks if a PageElement or all PageElements managed by a PageElementList, PageElementMap or PageElementGroup currently have an actual text which contains the expected text.

    Parameters

    • text: TextType

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

    Returns boolean

exists

  • exists(filterMask?: FilterType): boolean
  • Checks if a PageElement or all PageElements managed by a PageElementList, PageElementMap or PageElementGroup currently exist.

    Parameters

    • Optional filterMask: FilterType

    Returns boolean

getExists

  • getExists(filterMask?: FilterType): BooleanType
  • Returns the current 'exists' 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

getIsEnabled

  • getIsEnabled(filterMask?: FilterType): BooleanType
  • Returns the current '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

getIsVisible

  • getIsVisible(filterMask?: FilterType): BooleanType
  • Returns the current 'visible' 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

hasAnyDirectText

  • hasAnyDirectText(filterMask?: FilterType): boolean
  • Checks if a PageElement or all PageElements managed by a PageElementList, PageElementMap or PageElementGroup 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: FilterType

    Returns boolean

hasAnyText

  • hasAnyText(filterMask?: FilterType): boolean
  • Checks if a PageElement or all PageElements managed by a PageElementList, PageElementMap or PageElementGroup currently have any text.

    Parameters

    • Optional filterMask: FilterType

    Returns boolean

hasDirectText

  • hasDirectText(directText: TextType): boolean
  • Checks if a PageElement or all PageElements managed by a PageElementList, PageElementMap or PageElementGroup currently have an actual direct text which 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

    • directText: TextType

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

    Returns boolean

hasText

  • hasText(text: TextType): boolean
  • Checks if a PageElement or all PageElements managed by a PageElementList, PageElementMap or PageElementGroup currently have an actual text which equals the expected text.

    Parameters

    • text: TextType

      the expected text which is supposed to equal the actual text

    Returns boolean

isEnabled

  • isEnabled(filterMask?: FilterType): boolean
  • Checks if a PageElement or all PageElements managed by a PageElementList, PageElementMap or PageElementGroup currently is enabled.

    Parameters

    • Optional filterMask: FilterType

    Returns boolean

isVisible

  • isVisible(filterMask?: FilterType): boolean
  • Checks if a PageElement or all PageElements managed by a PageElementList, PageElementMap or PageElementGroup currently is visible.

    Parameters

    • Optional filterMask: FilterType

    Returns boolean

Generated using TypeDoc