Options
All
  • Public
  • Public/Protected
  • All
Menu

Class PageElementGroupCurrently<Store, Content, GroupType>

This class defines all currently functions of PageElementGroup.

template

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

template

Content an arbitrary object structure of PageNode instances as values and the names used to identify these PageNodes as keys

template

GroupType type of the PageElementGroup for which PageElementGroupCurrently defines all currently functions

Type parameters

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Protected _node

_node: GroupType

the PageNode for which PageNodeCurrently defines all currently functions

Accessors

not

  • get not(): object

Methods

containsDirectText

  • Returns true if the actual direct texts of all PageNodes managed by PageElementGroup currently contain the expected direct texts.

    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

    • directTexts: ExtractTextStateChecker<Content>

      the expected direct texts supposed to be contained in the actual direct texts

    Returns boolean

containsText

exists

getContainsDirectText

  • Returns the current 'containsDirectText' status of all PageNodes managed by PageElementGroup as a result structure.

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

    • directTexts: ExtractTextStateChecker<Content>

      the expected direct texts used in the comparisons which set the 'containsDirectText' status

    Returns object

getContainsText

  • Returns the current 'containsText' status of all PageNodes managed by PageElementGroup as a result structure.

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

    Parameters

    • texts: ExtractTextStateChecker<Content>

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

    Returns object

getDirectText

  • Returns the current direct texts of all PageNodes managed by PageElementGroup as a result structure.

    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: GroupFilterMask<Content>

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

    Returns object

getExists

  • Returns the current 'exists' status of all PageNodes managed by PageElementGroup as a result structure.

    Parameters

    • Optional filterMask: GroupFilterMask<Content>

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

    Returns object

getHasAnyDirectText

  • Returns the current 'hasAnyDirectText' status of all PageNodes managed by PageElementGroup as a result structure.

    A PageNode's 'hasAnyDirectText' status is set to true if the PageNode has 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: GroupFilterMask<Content>

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

    Returns object

getHasAnyText

  • Returns the current 'hasAnyText' status of all PageNodes managed by PageElementGroup as a result structure.

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

    Parameters

    • Optional filterMask: GroupFilterMask<Content>

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

    Returns object

getHasDirectText

  • Returns the current 'hasDirectText' status of all PageNodes managed by PageElementGroup as a result structure.

    A PageNode'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

    • directTexts: ExtractTextStateChecker<Content>

      the expected direct texts used in the comparisons which set the 'hasDirectText' status

    Returns object

getHasText

  • Returns the current 'hasText' status of all PageNodes managed by PageElementGroup as a result structure.

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

    Parameters

    • texts: ExtractTextStateChecker<Content>

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

    Returns object

getIsEnabled

  • Returns the current 'enabled' status of all PageNodes managed by PageElementGroup as a result structure.

    Parameters

    • Optional filterMask: GroupFilterMask<Content>

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

    Returns object

getIsVisible

  • Returns the current 'visible' status of all PageNodes managed by PageElementGroup as a result structure.

    Parameters

    • Optional filterMask: GroupFilterMask<Content>

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

    Returns object

getText

  • Returns the current texts of all PageNodes managed by PageElementGroup as a result structure.

    Parameters

    • Optional filterMask: GroupFilterMask<Content>

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

    Returns object

hasAnyDirectText

  • Returns true if all PageNodes managed by 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: GroupFilterMask<Content>

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

    Returns boolean

hasAnyText

hasDirectText

  • Returns true if the actual direct texts of all PageNodes managed by PageElementGroup currently equal the expected direct texts.

    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

    • directTexts: ExtractTextStateChecker<Content>

      the expected direct texts supposed to equal the actual direct texts

    Returns boolean

hasText

isEnabled

isVisible

Generated using TypeDoc