abstractPageElement <Native_Element_Type>

Uses the actor’s ability to BrowseTheWeb to identify a single Web element located by Selector.

Learn more

• Page Element Query Language
• Optional
• Switchable

Implements

• Optional
• Switchable

Index

Methods

• located
• of
• of
• nativeElement
• toString
• enterValue
• clearValue
• click
• doubleClick
• scrollIntoView
• hoverOver
• rightClick
• selectOptions
• selectedOptions
• attribute
• text
• value
• switchTo
• isActive
• isClickable
• isEnabled
• isPresent
• isSelected
• isVisible

Constructors

• constructor

Properties

• locator

Methods

staticlocated

• located<NET>(selector: Answerable<Selector>): Question<Promise<PageElement<NET>>> & Interaction & { isPresent: any } & QuestionAdapterFieldDecorator<PageElement<NET>> & MetaQuestion<PageElement<any>, PageElement<any>>

• Type parameters

  • NET

  Parameters

  • selector: Answerable<Selector>

  Returns Question<Promise<PageElement<NET>>> & Interaction & { isPresent: any } & QuestionAdapterFieldDecorator<PageElement<NET>> & MetaQuestion<PageElement<any>, PageElement<any>>

staticof

• of<NET>(childElement: Answerable<PageElement<NET>>, parentElement: Answerable<PageElement<NET>>): Question<Promise<PageElement<NET>>> & Interaction & { isPresent: any } & QuestionAdapterFieldDecorator<PageElement<NET>> & MetaQuestion<PageElement<any>, PageElement<any>>

• Type parameters

  • NET

  Parameters

  • childElement: Answerable<PageElement<NET>>

  • parentElement: Answerable<PageElement<NET>>

  Returns Question<Promise<PageElement<NET>>> & Interaction & { isPresent: any } & QuestionAdapterFieldDecorator<PageElement<NET>> & MetaQuestion<PageElement<any>, PageElement<any>>

abstractof

• of(parentElement: PageElement<Native_Element_Type>): PageElement<Native_Element_Type>

• Parameters

  • parentElement: PageElement<Native_Element_Type>

  Returns PageElement<Native_Element_Type>

nativeElement

• nativeElement(): Promise<Native_Element_Type>

• An “escape hatch” providing access to the integration tool-specific implementation of a Web element.

  ---

  Returns Promise<Native_Element_Type>

toString

• toString(): string

• Returns string

abstractenterValue

• enterValue(value: string | number | (string | number)[]): Promise<void>

• Parameters

  • value: string | number | (string | number)[]

  Returns Promise<void>

abstractclearValue

• clearValue(): Promise<void>

• Returns Promise<void>

abstractclick

• click(): Promise<void>

• Returns Promise<void>

abstractdoubleClick

• doubleClick(): Promise<void>

• Returns Promise<void>

abstractscrollIntoView

• scrollIntoView(): Promise<void>

• Returns Promise<void>

abstracthoverOver

• hoverOver(): Promise<void>

• Returns Promise<void>

abstractrightClick

• rightClick(): Promise<void>

• Returns Promise<void>

abstractselectOptions

• selectOptions(...options: SelectOption[]): Promise<void>

• Parameters

  • rest...options: SelectOption[]

  Returns Promise<void>

abstractselectedOptions

• selectedOptions(): Promise<SelectOption[]>

• Returns Promise<SelectOption[]>

abstractattribute

• attribute(name: string): Promise<string>

• Parameters

  • name: string

  Returns Promise<string>

abstracttext

• text(): Promise<string>

• Returns Promise<string>

abstractvalue

• value(): Promise<string>

• Returns Promise<string>

abstractswitchTo

• switchTo(): Promise<SwitchableOrigin>

• Implementation of Switchable.switchTo

  When the element represents an iframe, calling this method switches the current browsing context to the given iframe context.

  When used with other types of Web Element, calling this method will have the same result as calling Element.focus().

  ---

  Returns Promise<SwitchableOrigin>

  Returns an object that allows the caller to switch back to the previous context if needed.

  Learn more

  • Switch
  • Switchable

abstractisActive

• isActive(): Promise<boolean>

• Resolves to true when the underlying element has focus. Otherwise, resolves to false.

  ---

  Returns Promise<boolean>

abstractisClickable

• isClickable(): Promise<boolean>

• Resolves to true when the underlying element can be clicked on. Otherwise, resolves to false.

  Please refer to test integration tool-specific documentation for details.

  ---

  Returns Promise<boolean>

abstractisEnabled

• isEnabled(): Promise<boolean>

• Resolves to true when the underlying element is not explicitly disabled

  Please refer to test integration tool-specific documentation for details.

  ---

  Returns Promise<boolean>

isPresent

• isPresent(): Promise<boolean>

• Implementation of Optional.isPresent

  Returns a Promise that resolves to true when the element is present in the Document Object Model (DOM), false otherwise.

  ---

  Returns Promise<boolean>

abstractisSelected

• isSelected(): Promise<boolean>

• Resolves to true when the underlying element:

  • has a selected attribute for <option /> elements
  • has a checked attribute for checkboxes

  Otherwise, resolves to false.

  ---

  Returns Promise<boolean>

abstractisVisible

• isVisible(): Promise<boolean>

• Resolves to true when the underlying element:

  • is not hidden, so doesn’t have CSS style like display: none, visibility: hidden or opacity: 0
  • is within the browser viewport
  • doesn’t have its centre covered by other elements

  Otherwise, resolves to false.

  ---

  Returns Promise<boolean>

Constructors

constructor

• new PageElement<Native_Element_Type>(locator: Locator<Native_Element_Type, any>): PageElement<Native_Element_Type>

• Type parameters

  • Native_Element_Type = any

  Parameters

  • locator: Locator<Native_Element_Type, any>

  Returns PageElement<Native_Element_Type>

Properties

publicreadonlylocator

locator: Locator<Native_Element_Type, any>