ValuePageElementGroupCurrently

This class defines all currently functions of ValuePageElementGroup.

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 ValuePageElementGroup for which ValuePageElementGroupCurrently defines all currently functions

Type parameters

Store: PageNodeStore
Content: object
GroupType: ValuePageElementGroup<Store, Content>

Hierarchy

PageElementGroupCurrently<Store, Content, GroupType>
- ValuePageElementGroupCurrently

Index

Constructors

constructor

Properties

_node

Accessors

Constructors

constructor

new ValuePageElementGroupCurrently(node: GroupType): ValuePageElementGroupCurrently

Inherited from PageNodeCurrently.constructor
- Defined in lib/page_objects/page_elements/PageNode.ts:247
PageNodeCurrently defines all currently functions of PageNode.

Parameters
- node: GroupType
  
  PageNode for which PageNodeCurrently defines all currently functions
Returns ValuePageElementGroupCurrently

Properties

Protected _node

_node: GroupType

the PageNode for which PageNodeCurrently defines all currently functions

Accessors

not

get not(): object

Overrides PageElementGroupCurrently.not
- Defined in lib/page_objects/page_elements/ValuePageElementGroup.ts:295
returns the negated variants of ValuePageElementGroupCurrently's state check functions

Returns object
- containsValue: function
  - containsValue(values: ExtractValueStateChecker<Content>): boolean
  - - Defined in lib/page_objects/page_elements/ValuePageElementGroup.ts:325
    Returns true if the actual values of all PageNodes managed by ValuePageElementGroup currently do not contain the expected values.
    
    Parameters
    - values: ExtractValueStateChecker<Content>
      
      the expected values supposed not to be contained in the actual values
    Returns boolean
- hasAnyValue: function
  - hasAnyValue(filterMask?: ValueGroupFilterMask<Content>): boolean
  - - Defined in lib/page_objects/page_elements/ValuePageElementGroup.ts:314
    Returns true if all PageNodes managed by ValuePageElementGroup currently do not have any value.
    
    Parameters
    - Optional filterMask: ValueGroupFilterMask<Content>
      
      can be used to skip the invocation of the hasAnyValue function for some or all managed PageNodes
    Returns boolean
- hasValue: function
  - hasValue(values: ExtractValueStateChecker<Content>): boolean
  - - Defined in lib/page_objects/page_elements/ValuePageElementGroup.ts:303
    Returns true if the actual values of all PageNodes managed by ValuePageElementGroup currently do not equal the expected values.
    
    Parameters
    - values: ExtractValueStateChecker<Content>
      
      the expected values supposed not to equal the actual values
    Returns boolean

Methods

containsDirectText

containsDirectText(directTexts: ExtractTextStateChecker<Content>): boolean

Inherited from PageElementGroupCurrently.containsDirectText
- Defined in lib/page_objects/page_elements/PageElementGroup.ts:907
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

containsText(texts: ExtractTextStateChecker<Content>): boolean

Inherited from PageElementGroupCurrently.containsText
- Defined in lib/page_objects/page_elements/PageElementGroup.ts:862
Returns true if the actual texts of all PageNodes managed by PageElementGroup currently contain the expected texts.

Parameters
- texts: ExtractTextStateChecker<Content>
  
  the expected texts supposed to be contained in the actual texts
Returns boolean

containsValue

containsValue(values: ExtractValueStateChecker<Content>): boolean

- Defined in lib/page_objects/page_elements/ValuePageElementGroup.ts:286
Returns true if the actual values of all PageNodes managed by ValuePageElementGroup currently contain the expected values.

Parameters
- values: ExtractValueStateChecker<Content>
  
  the expected values supposed to be contained in the actual values
Returns boolean

exists

exists(filterMask?: GroupFilterMaskExists<Content>): boolean

Inherited from PageElementGroupCurrently.exists
- Defined in lib/page_objects/page_elements/PageElementGroup.ts:802
Returns true if all PageNodes managed by PageElementGroup currently exist.

Parameters
- Optional filterMask: GroupFilterMaskExists<Content>
  
  can be used to skip the invocation of the exists function for some or all managed PageNodes
Returns boolean

getContainsDirectText

getContainsDirectText(directTexts: ExtractTextStateChecker<Content>): object

Inherited from PageElementGroupCurrently.getContainsDirectText
- Defined in lib/page_objects/page_elements/PageElementGroup.ts:763
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

getContainsText(texts: ExtractTextStateChecker<Content>): object

Inherited from PageElementGroupCurrently.getContainsText
- Defined in lib/page_objects/page_elements/PageElementGroup.ts:713
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

getContainsValue

getContainsValue(values: ExtractValueStateChecker<Content>): object

- Defined in lib/page_objects/page_elements/ValuePageElementGroup.ts:248
Returns the current 'containsValue' status of all PageNodes managed by ValuePageElementGroup as a result structure.

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

Parameters
- values: ExtractValueStateChecker<Content>
  
  the expected values used in the comparisons which set the 'containsValue' status
Returns object

getDirectText

getDirectText(filterMask?: GroupFilterMask<Content>): object

Inherited from PageElementGroupCurrently.getDirectText
- Defined in lib/page_objects/page_elements/PageElementGroup.ts:790
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

getExists(filterMask?: GroupFilterMask<Content>): object

Inherited from PageElementGroupCurrently.getExists
- Defined in lib/page_objects/page_elements/PageElementGroup.ts:649
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

getHasAnyDirectText(filterMask?: GroupFilterMask<Content>): object

Inherited from PageElementGroupCurrently.getHasAnyDirectText
- Defined in lib/page_objects/page_elements/PageElementGroup.ts:746
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

getHasAnyText(filterMask?: GroupFilterMask<Content>): object

Inherited from PageElementGroupCurrently.getHasAnyText
- Defined in lib/page_objects/page_elements/PageElementGroup.ts:700
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

getHasAnyValue

getHasAnyValue(filterMask?: ValueGroupFilterMask<Content>): object

- Defined in lib/page_objects/page_elements/ValuePageElementGroup.ts:233
Returns the current 'hasAnyValue' status of all PageNodes managed by ValuePageElementGroup as a result structure.

A PageNode's 'hasAnyValue' status is set to true if the PageNode has any value.

Parameters
- Optional filterMask: ValueGroupFilterMask<Content>
  
  can be used to skip the invocation of the getHasAnyValue function for some or all managed PageNodes. The results of skipped function invocations are not included in the total results structure.
Returns object

getHasDirectText

getHasDirectText(directTexts: ExtractTextStateChecker<Content>): object

Inherited from PageElementGroupCurrently.getHasDirectText
- Defined in lib/page_objects/page_elements/PageElementGroup.ts:729
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

getHasText(texts: ExtractTextStateChecker<Content>): object

Inherited from PageElementGroupCurrently.getHasText
- Defined in lib/page_objects/page_elements/PageElementGroup.ts:686
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

getHasValue

getHasValue(values: ExtractValueStateChecker<Content>): object

- Defined in lib/page_objects/page_elements/ValuePageElementGroup.ts:217
Returns the current 'hasValue' status of all PageNodes managed by ValuePageElementGroup as a result structure.

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

Parameters
- values: ExtractValueStateChecker<Content>
  
  the expected values used in the comparisons which set the 'hasValue' status
Returns object

getIsEnabled

getIsEnabled(filterMask?: GroupFilterMask<Content>): object

Inherited from PageElementGroupCurrently.getIsEnabled
- Defined in lib/page_objects/page_elements/PageElementGroup.ts:673
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

getIsVisible(filterMask?: GroupFilterMask<Content>): object

Inherited from PageElementGroupCurrently.getIsVisible
- Defined in lib/page_objects/page_elements/PageElementGroup.ts:661
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

getText(filterMask?: GroupFilterMask<Content>): object

Inherited from PageElementGroupCurrently.getText
- Defined in lib/page_objects/page_elements/PageElementGroup.ts:775
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

getValue

getValue(filterMask?: ValueGroupFilterMask<Content>): object

- Defined in lib/page_objects/page_elements/ValuePageElementGroup.ts:202
Returns the current values of all PageNodes managed by ValuePageElementGroup as a result structure.

Parameters
- Optional filterMask: ValueGroupFilterMask<Content>
  
  can be used to skip the invocation of the getValue function for some or all managed PageNodes. The results of skipped function invocations are not included in the total results structure.
Returns object

hasAnyDirectText

hasAnyDirectText(filterMask?: GroupFilterMask<Content>): boolean

Inherited from PageElementGroupCurrently.hasAnyDirectText
- Defined in lib/page_objects/page_elements/PageElementGroup.ts:892
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

hasAnyText(filterMask?: GroupFilterMask<Content>): boolean

Inherited from PageElementGroupCurrently.hasAnyText
- Defined in lib/page_objects/page_elements/PageElementGroup.ts:851
Returns true if all PageNodes managed by PageElementGroup currently have any text.

Parameters
- Optional filterMask: GroupFilterMask<Content>
  
  can be used to skip the invocation of the hasAnyText function for some or all managed PageNodes
Returns boolean

hasAnyValue

hasAnyValue(filterMask?: ValueGroupFilterMask<Content>): boolean

- Defined in lib/page_objects/page_elements/ValuePageElementGroup.ts:274
Returns true if all PageNodes managed by ValuePageElementGroup currently have any value.

Parameters
- Optional filterMask: ValueGroupFilterMask<Content>
  
  can be used to skip the invocation of the hasAnyValue function for some or all managed PageNodes
Returns boolean

hasDirectText

hasDirectText(directTexts: ExtractTextStateChecker<Content>): boolean

Inherited from PageElementGroupCurrently.hasDirectText
- Defined in lib/page_objects/page_elements/PageElementGroup.ts:877
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

hasText(texts: ExtractTextStateChecker<Content>): boolean

Inherited from PageElementGroupCurrently.hasText
- Defined in lib/page_objects/page_elements/PageElementGroup.ts:839
Returns true if the actual texts of all PageNodes managed by PageElementGroup currently equal the expected texts.

Parameters
- texts: ExtractTextStateChecker<Content>
  
  the expected texts supposed to equal the actual texts
Returns boolean

hasValue

hasValue(values: ExtractValueStateChecker<Content>): boolean

- Defined in lib/page_objects/page_elements/ValuePageElementGroup.ts:262
Returns true if the actual values of all PageNodes managed by ValuePageElementGroup currently equal the expected values.

Parameters
- values: ExtractValueStateChecker<Content>
  
  the expected values supposed to equal the actual values
Returns boolean

isEnabled

isEnabled(filterMask?: GroupFilterMask<Content>): boolean

Inherited from PageElementGroupCurrently.isEnabled
- Defined in lib/page_objects/page_elements/PageElementGroup.ts:828
Returns true if all PageNodes managed by PageElementGroup are currently enabled.

Parameters
- Optional filterMask: GroupFilterMask<Content>
  
  can be used to skip the invocation of the isEnabled function for some or all managed PageNodes
Returns boolean

isVisible

isVisible(filterMask?: GroupFilterMask<Content>): boolean

Inherited from PageElementGroupCurrently.isVisible
- Defined in lib/page_objects/page_elements/PageElementGroup.ts:816
Returns true if all PageNodes managed by PageElementGroup are currently visible.

Parameters
- Optional filterMask: GroupFilterMask<Content>
  
  can be used to skip the invocation of the isVisible function for some or all managed PageNodes
Returns boolean

Type parameters

Store: PageNodeStore

Content: object

GroupType: ValuePageElementGroup<Store, Content>

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

node: GroupType

Returns ValuePageElementGroupCurrently

Properties

Protected _node

Accessors

not

Returns object

containsValue: function

Parameters

values: ExtractValueStateChecker<Content>

Returns boolean

hasAnyValue: function

Parameters

Optional filterMask: ValueGroupFilterMask<Content>

Returns boolean

hasValue: function

Parameters

values: ExtractValueStateChecker<Content>

Returns boolean

Methods

containsDirectText

Parameters

directTexts: ExtractTextStateChecker<Content>

Returns boolean

containsText

Parameters

texts: ExtractTextStateChecker<Content>

Returns boolean

containsValue

Parameters

values: ExtractValueStateChecker<Content>

Returns boolean

exists

Parameters

Optional filterMask: GroupFilterMaskExists<Content>

Returns boolean

getContainsDirectText

Parameters

directTexts: ExtractTextStateChecker<Content>

Returns object

getContainsText

Parameters

texts: ExtractTextStateChecker<Content>

Returns object

getContainsValue

Parameters

values: ExtractValueStateChecker<Content>

Returns object

getDirectText

Parameters

Optional filterMask: GroupFilterMask<Content>

Returns object

getExists

Parameters

Optional filterMask: GroupFilterMask<Content>

Returns object

getHasAnyDirectText

Parameters

Optional filterMask: GroupFilterMask<Content>

Returns object

getHasAnyText

Parameters

Optional filterMask: GroupFilterMask<Content>

Returns object

getHasAnyValue

Parameters

Optional filterMask: ValueGroupFilterMask<Content>