Class OjPopup

The component WebElement for oj-popup. Do not instantiate this class directly, instead, use ojPopup.

Migration

When you migrate a page from using oj-popup to oj-c-popup you will also need to migrate your WebDriver tests from OjPopup to PopupWebElement. To do that you will need to revise type and locator instances as follows
Type: from OjPopup to PopupWebElement
Locator: from ojPopup to findPopup
For more details on migrating from legacy to core pack please see component's migration section

Hierarchy

Constructors

constructor

Methods

clear click findElement findElements getAttribute getAutoDismiss getChrome getCssValue getInitialFocus getLocation getModality getPosition getProperty getRect getSize getTail getText getTranslations hasSize hasVisibility isDisplayed isEnabled isSelected sendKeys setProperty submit takeScreenshot whenBusyContextReady whenReady

Constructors

constructor

  • Constructor. Pass an instance of WebDriver's WebElement that represents the DOM node on which we"ll perform operations.

    Parameters

    • el: WebElement

      The basic WebElement with which this WebElement will work.

    • locators: ElementLocators

    Returns OjPopup

Methods

clear

  • Returns Promise<void>

    Inherit Doc

click

  • Returns Promise<void>

    Inherit Doc

findElement

  • Parameters

    • locator: Locator

    Returns WebElementPromise

    Inherit Doc

findElements

  • Parameters

    • locator: Locator

    Returns Promise<WebElement[]>

    Inherit Doc

getAttribute

  • Parameters

    • attributeName: string

    Returns Promise<string>

    Inherit Doc

getAutoDismiss

  • Gets the value of autoDismiss property. Specifies the auto dismissal behavior.

    Returns Promise<string>

    The value of autoDismiss property.

getChrome

  • Gets the value of chrome property. Specifies whether to use the border, shadow, and background colors from the active theme.

    Returns Promise<string>

    The value of chrome property.

    Deprecated

    Since 17.0.0. This is not recommended in the Redwood design system.

getCssValue

  • Parameters

    • cssStyleProperty: string

    Returns Promise<string>

    Inherit Doc

getInitialFocus

  • Gets the value of initialFocus property. Specifies whether the popup steals focus to its content when initially opened.

    Returns Promise<string>

    The value of initialFocus property.

getLocation

getModality

  • Gets the value of modality property. Specifies whether the popup should block user input to the page.

    Returns Promise<string>

    The value of modality property.

getPosition

  • Gets the value of position property. Specifies the position of a popup when launched. See the Help documentation for more information.

    Returns Promise<Position>

    The value of position property.

getProperty

  • Get a named property value from this component. This function will wait for the application's busy context to complete before attempting to get the property value.

    Type Parameters

    • T = string

    Parameters

    • propertyName: string

      The name of the property

    Returns Promise<T>

    A Promise that yields a value for the named property.

getRect

  • Returns Promise<IRectangle>

    Inherit Doc

getSize

  • Returns Promise<ISize>

    Inherit Doc

getTail

  • Gets the value of tail property. Specifies whether to display a decoration pointing from the popup to the launching element. See the Help documentation for more information.

    Returns Promise<string>

    The value of tail property.

getText

  • Returns Promise<string>

    Inherit Doc

getTranslations

  • Gets the value of translations property. A collection of translated resources from the translation bundle, or null if this component has no resources.

    Returns Promise<null | Translations>

    The value of translations property.

Protected hasSize

  • Create a wait condition that is satisfied when the element's DOM has a non-zero size.

    Returns Condition<Promise<boolean>>

    The Condition to be used with driver.wait() that's satisfied when the element's DOM has a non-zero size.

    Deprecated

    Since 11.0.0. Call the appropriate WebElement method to test the size of the element.

Protected hasVisibility

  • Create a wait condition that is satisfid when the element is visible. The condition is satisfied when the element is displayed, as reported by #isDisplayed, and is scrolled into view. This is method is deprecated. Use WebElement.isDisplayed instead to test the display of the element, and scroll it into view if necessary.

    Returns Condition<Promise<boolean>>

    Deprecated

isDisplayed

isEnabled

  • Returns Promise<boolean>

    Inherit Doc

isSelected

sendKeys

  • Parameters

    • Rest ...varArgs: (string | number | Promise<string | number>)[]

    Returns Promise<void>

    Inherit Doc

Protected setProperty

  • Set a property value on the remote element. This function first waits for the BusyContext to clear before setting the property, then after setting, waits again to ensure that no additional busy states were created due to the property setting.

    Type Parameters

    • T = string

    Parameters

    • propertyName: string

      The property name to set

    • value: T

      The value to set for the property

    Returns Promise<void>

    A Promise which resolves when the remote property has been set to the value. Any value returned from the call to set the remote property is returned in the Promise.

submit

  • Returns Promise<void>

    Inherit Doc

takeScreenshot

  • Parameters

    • Optional optScroll: boolean

    Returns Promise<string>

    Inherit Doc

whenBusyContextReady

  • Returns a Promise that is resolved when the application's busy state reports ready. This method checks only that the application's busy context is ready, and not that the DOM element is actually displayed or has a physical size, such as is the case with #whenReady. Operations which are read-only in nature should call this method prior to execution.

    Returns Promise<void>

    A Promise which is resolved when the page's busy state is ready.

whenReady

  • Returns a Promise that is resolved when the element is ready for interaction--it is visible, has a size, and the app's busy context is ready. Operations on the DOM which rely on its physical location and size to be in a "ready" state should use this command, such as clicking, sending keys, locating child elements, and so on.

    Returns Promise<void>

    A Promise that's resolved when all conditions are met.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc